Method: projects.algorithms.list
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Liste aller Algorithmen, die in Expressions verwendet werden können.
HTTP-Anfrage
GET https://earthengine.googleapis.com/v1beta/{parent=projects/*}/algorithms
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
| Parameter |
parent |
string
Erforderlich. Die Projekt-ID oder Projektnummer des Google Cloud-Projekts, das für diese Anfrage als Dienstnutzer behandelt werden soll. Format ist projects/{project-id}.
Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:
earthengine.computations.create
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Alle Algorithmen, die in Expressions verwendet werden können.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
| JSON-Darstellung |
{
"algorithms": [
{
object (Algorithm)
}
]
} |
| Felder |
algorithms[] |
object (Algorithm)
Eine Liste der verfügbaren Algorithmen.
|
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/earthengine
https://www.googleapis.com/auth/earthengine.readonly
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/cloud-platform.read-only
Weitere Informationen finden Sie unter OAuth 2.0 Overview.
Algorithmus
Die Beschreibung eines Algorithmus, der für Ausdrücke verfügbar ist.
| JSON-Darstellung |
{
"name": string,
"description": string,
"returnType": string,
"arguments": [
{
object (AlgorithmArgument)
}
],
"deprecated": boolean,
"deprecationReason": string,
"hidden": boolean,
"preview": boolean,
"sourceCodeUri": string
} |
| Felder |
name |
string
Der Name des Algorithmus im Format „algorithms/…“.
|
description |
string
Eine für Menschen lesbare Beschreibung des Algorithmus.
|
returnType |
string
Der Name des Typs, den der Algorithmus zurückgibt.
|
arguments[] |
object (AlgorithmArgument)
Beschreibungen der Argumente, die der Algorithmus verwendet.
|
deprecated |
boolean
Gibt an, ob der Algorithmus eingestellt wird.
|
deprecationReason |
string
Wenn dieser Algorithmus eingestellt wurde, der Grund für die Einstellung.
|
hidden |
boolean
Ob dieser Algorithmus in Clientanwendungen ausgeblendet und nicht standardmäßig angezeigt werden soll.
|
preview |
boolean
Ob dieser Algorithmus eine Vorschaufunktion ist und noch nicht allgemein verfügbar ist.
|
sourceCodeUri |
string
URI einer Ressource mit dem Quellcode des Algorithmus. Ist leer, wenn der Nutzer keine Berechtigung hat oder ein bestimmter URI nicht ermittelt werden konnte.
|
AlgorithmArgument
Die Beschreibung eines Arguments für einen Algorithmus.
| JSON-Darstellung |
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
| Felder |
argumentName |
string
Der Name des Arguments.
|
type |
string
Der Name des Typs des Arguments.
|
description |
string
Eine für Menschen lesbare Beschreibung des Arguments.
|
optional |
boolean
Gibt an, ob das Argument optional ist.
|
defaultValue |
value (Value format)
Der Standardwert, der für das Argument verwendet wird, wenn kein Wert angegeben wird.
|
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[[["\u003cp\u003eRetrieves a comprehensive list of all algorithms available for use within Earth Engine Expressions.\u003c/p\u003e\n"],["\u003cp\u003eUses a standard HTTP GET request to a specific Earth Engine API endpoint, requiring project identification.\u003c/p\u003e\n"],["\u003cp\u003eReturns a JSON response containing detailed information for each algorithm, including its name, description, arguments, and return type.\u003c/p\u003e\n"],["\u003cp\u003eRequires appropriate authorization with specific OAuth scopes to access the Earth Engine API.\u003c/p\u003e\n"],["\u003cp\u003eAlgorithm descriptions also indicate if they are deprecated, hidden, or in preview, offering transparency into their development status.\u003c/p\u003e\n"]]],["To retrieve all algorithms, a `GET` request is sent to `https://earthengine.googleapis.com/v1beta/{parent=projects/*}/algorithms`, where `parent` specifies the project. The response, containing a list of algorithms, includes each algorithm's name, description, return type, arguments, deprecation status, visibility, preview status, and source code URI. Each algorithm's argument also has a name, type, description, optionality, and default value. Authorization requires specific OAuth scopes.\n"],null,["# Method: projects.algorithms.list\n\nGets the list of all the algorithms available for use in Expressions.\n\n### HTTP request\n\n`GET https://earthengine.googleapis.com/v1beta/{parent=projects/*}/algorithms`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The project id or project number of the Google Cloud Platform project that should be treated as the service consumer for this request. Format is `projects/{project-id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `earthengine.computations.create` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nAll the algorithms available for use in Expressions.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------|\n| ``` { \"algorithms\": [ { object (/earth-engine/reference/rest/v1beta/projects.algorithms/list#Algorithm) } ] } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `algorithms[]` | `object (`[Algorithm](/earth-engine/reference/rest/v1beta/projects.algorithms/list#Algorithm)`)` A list of the available algorithms. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/earthengine`\n- `\n https://www.googleapis.com/auth/earthengine.readonly`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/cloud-platform.read-only`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2).\n\nAlgorithm\n---------\n\nThe description of an algorithm available for Expressions.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"description\": string, \"returnType\": string, \"arguments\": [ { object (/earth-engine/reference/rest/v1beta/projects.algorithms/list#AlgorithmArgument) } ], \"deprecated\": boolean, \"deprecationReason\": string, \"hidden\": boolean, \"preview\": boolean, \"sourceCodeUri\": string } ``` |\n\n| Fields ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the algorithm, in the form \"algorithms/...\". |\n| `description` | `string` A human-readable description of the algorithm. |\n| `returnType` | `string` The name of the type the algorithm returns. |\n| `arguments[]` | `object (`[AlgorithmArgument](/earth-engine/reference/rest/v1beta/projects.algorithms/list#AlgorithmArgument)`)` Descriptions of the arguments the algorithm takes. |\n| `deprecated` | `boolean` Whether the algorithm is deprecated. |\n| `deprecationReason` | `string` If this algorithm is deprecated, the reason for the deprecation. |\n| `hidden` | `boolean` Whether this algorithm should be hidden in client applications and not shown by default. |\n| `preview` | `boolean` Whether this algorithm is a preview feature and not yet widely available for a general audience. |\n| `sourceCodeUri` | `string` URI of a resource containing the source code of the algorithm. Empty if the user does not have permission or a specific URI could not be determined. |\n\nAlgorithmArgument\n-----------------\n\nThe description of an argument to an algorithm.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------|\n| ``` { \"argumentName\": string, \"type\": string, \"description\": string, \"optional\": boolean, \"defaultValue\": value } ``` |\n\n| Fields ||\n|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `argumentName` | `string` The name of the argument. |\n| `type` | `string` The name of the type of the argument. |\n| `description` | `string` A human-readable description of the argument. |\n| `optional` | `boolean` Whether the argument is optional. |\n| `defaultValue` | `value (`[Value](https://protobuf.dev/reference/protobuf/google.protobuf/#value)` format)` The default value the argument takes if a value is not provided. |"]]
