Annuncio: tutti i progetti non commerciali registrati per l'utilizzo di Earth Engine prima del
15 aprile 2025 devono
verificare l'idoneità non commerciale per mantenere l'accesso a Earth Engine.
Method: projects.algorithms.list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Recupera l'elenco di tutti gli algoritmi disponibili per l'utilizzo in Espressioni.
Richiesta HTTP
GET https://earthengine.googleapis.com/v1beta/{parent=projects/*}/algorithms
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri |
parent |
string
Obbligatorio. L'ID o il numero del progetto della piattaforma Google Cloud che deve essere considerato il consumatore di servizi per questa richiesta. Il formato è projects/{project-id} .
L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata parent :
earthengine.computations.create
|
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
Tutti gli algoritmi disponibili per l'utilizzo in Espressioni.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
{
"algorithms": [
{
object (Algorithm )
}
]
} |
Campi |
algorithms[] |
object (Algorithm )
Un elenco degli algoritmi disponibili.
|
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti OAuth:
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
Per ulteriori informazioni, consulta la sezione OAuth 2.0 Overview.
Algoritmo
La descrizione di un algoritmo disponibile per le espressioni.
Rappresentazione JSON |
{
"name": string,
"description": string,
"returnType": string,
"arguments": [
{
object (AlgorithmArgument )
}
],
"deprecated": boolean,
"deprecationReason": string,
"hidden": boolean,
"preview": boolean,
"sourceCodeUri": string
} |
Campi |
name |
string
Il nome dell'algoritmo, nel formato "algorithms/…".
|
description |
string
Una descrizione leggibile dell'algoritmo.
|
returnType |
string
Il nome del tipo restituito dall'algoritmo.
|
arguments[] |
object (AlgorithmArgument )
Descrizioni degli argomenti accettati dall'algoritmo.
|
deprecated |
boolean
Indica se l'algoritmo è deprecato.
|
deprecationReason |
string
Se questo algoritmo è deprecato, il motivo della deprecazione.
|
hidden |
boolean
Indica se questo algoritmo deve essere nascosto nelle applicazioni client e non mostrato per impostazione predefinita.
|
preview |
boolean
Indica se questo algoritmo è una funzionalità di anteprima e non è ancora ampiamente disponibile per un pubblico generale.
|
sourceCodeUri |
string
URI di una risorsa contenente il codice sorgente dell'algoritmo. Vuoto se l'utente non dispone dell'autorizzazione o se non è stato possibile determinare un URI specifico.
|
AlgorithmArgument
La descrizione di un argomento di un algoritmo.
Rappresentazione JSON |
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
Campi |
argumentName |
string
Il nome dell'argomento.
|
type |
string
Il nome del tipo dell'argomento.
|
description |
string
Una descrizione leggibile dell'argomento.
|
optional |
boolean
Indica se l'argomento è facoltativo.
|
defaultValue |
value (Value format)
Il valore predefinito assunto dall'argomento se non viene fornito un valore.
|
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 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. |"]]