Method: projects.algorithms.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Récupère la liste de tous les algorithmes disponibles dans Expressions.
Requête HTTP
GET https://earthengine.googleapis.com/v1alpha/{parent=projects/*}/algorithms
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
parent |
string
Obligatoire. ID ou numéro du projet Google Cloud Platform à traiter comme client du service pour cette requête. Format : projects/{project-id}
L'autorisation IAM suivante est requise pour la ressource parent indiquée :
earthengine.computations.create
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Tous les algorithmes disponibles dans Expressions.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
{
"algorithms": [
{
object (Algorithm)
}
]
} |
| Champs |
algorithms[] |
object (Algorithm)
Liste des algorithmes disponibles.
|
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
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
Pour en savoir plus, consultez OAuth 2.0 Overview.
Algorithme
Description d'un algorithme disponible pour les expressions.
| Représentation JSON |
{
"name": string,
"description": string,
"returnType": string,
"arguments": [
{
object (AlgorithmArgument)
}
],
"deprecated": boolean,
"deprecationReason": string,
"hidden": boolean,
"preview": boolean,
"sourceCodeUri": string
} |
| Champs |
name |
string
Nom de l'algorithme, au format "algorithms/...".
|
description |
string
Description de l'algorithme dans un format lisible.
|
returnType |
string
Nom du type renvoyé par l'algorithme.
|
arguments[] |
object (AlgorithmArgument)
Descriptions des arguments utilisés par l'algorithme.
|
deprecated |
boolean
Indique si l'algorithme est obsolète.
|
deprecationReason |
string
Si cet algorithme est obsolète, la raison de son abandon.
|
hidden |
boolean
Indique si cet algorithme doit être masqué dans les applications clientes et non affiché par défaut.
|
preview |
boolean
Indique si cet algorithme est une fonctionnalité en version Preview et n'est pas encore disponible pour tous les utilisateurs.
|
sourceCodeUri |
string
URI d'une ressource contenant le code source de l'algorithme. Vide si l'utilisateur n'est pas autorisé ou si aucun URI spécifique n'a pu être déterminé.
|
AlgorithmArgument
Description d'un argument d'un algorithme.
| Représentation JSON |
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
| Champs |
argumentName |
string
Nom de l'argument.
|
type |
string
Nom du type de l'argument.
|
description |
string
Description de l'argument dans un format lisible.
|
optional |
boolean
Indique si l'argument est facultatif.
|
defaultValue |
value (Value format)
Valeur par défaut de l'argument si aucune valeur n'est fournie.
|
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eRetrieves a comprehensive list of all algorithms available for use within Earth Engine Expressions.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific OAuth scopes like \u003ccode\u003ehttps://www.googleapis.com/auth/earthengine\u003c/code\u003e for access.\u003c/p\u003e\n"],["\u003cp\u003eProvides details for each algorithm, including name, description, return type, arguments, and deprecation status.\u003c/p\u003e\n"],["\u003cp\u003eAlgorithm details also encompass information about the arguments they accept, such as name, type, description, and whether they are optional.\u003c/p\u003e\n"],["\u003cp\u003eUses a standard HTTP GET request to the Earth Engine API with the project ID as a path parameter.\u003c/p\u003e\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/v1alpha/{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/v1alpha/projects.algorithms/list#Algorithm) } ] } ``` |\n\n| Fields ||\n|----------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `algorithms[]` | `object (`[Algorithm](/earth-engine/reference/rest/v1alpha/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/v1alpha/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/v1alpha/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. |"]]
