Method: projects.algorithms.list

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.