Anúncio: todos os projetos não comerciais registrados para usar o Earth Engine antes de
15 de abril de 2025 precisam
verificar a qualificação não comercial para manter o acesso ao Earth Engine.
Method: projects.algorithms.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recebe a lista de todos os algoritmos disponíveis para uso em expressões.
Solicitação HTTP
GET https://earthengine.googleapis.com/v1alpha/{parent=projects/*}/algorithms
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
parent |
string
Obrigatório. O ID ou número do projeto do Google Cloud Platform que será tratado como o consumidor de serviço para essa solicitação. O formato é projects/{project-id}.
A autorização requer a seguinte permissão do IAM no recurso especificado parent:
earthengine.computations.create
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Todos os algoritmos disponíveis para uso em expressões.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"algorithms": [
{
object (Algorithm)
}
]
} |
| Campos |
algorithms[] |
object (Algorithm)
Uma lista dos algoritmos disponíveis.
|
Escopos de autorização
Requer um dos seguintes escopos do 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
Para mais informações, consulte OAuth 2.0 Overview.
Algoritmo
A descrição de um algoritmo disponível para expressões.
| Representação JSON |
{
"name": string,
"description": string,
"returnType": string,
"arguments": [
{
object (AlgorithmArgument)
}
],
"deprecated": boolean,
"deprecationReason": string,
"hidden": boolean,
"preview": boolean,
"sourceCodeUri": string
} |
| Campos |
name |
string
O nome do algoritmo, no formato "algorithms/…".
|
description |
string
Uma descrição legível por humanos do algoritmo.
|
returnType |
string
O nome do tipo retornado pelo algoritmo.
|
arguments[] |
object (AlgorithmArgument)
Descrições dos argumentos que o algoritmo recebe.
|
deprecated |
boolean
Se o algoritmo foi descontinuado.
|
deprecationReason |
string
Se esse algoritmo foi descontinuado, o motivo da descontinuação.
|
hidden |
boolean
Define se esse algoritmo precisa ser oculto em aplicativos cliente e não mostrado por padrão.
|
preview |
boolean
Se esse algoritmo é um recurso de visualização e ainda não está disponível para o público em geral.
|
sourceCodeUri |
string
URI de um recurso que contém o código-fonte do algoritmo. Vazia se o usuário não tiver permissão ou se não for possível determinar um URI específico.
|
AlgorithmArgument
A descrição de um argumento para um algoritmo.
| Representação JSON |
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
| Campos |
argumentName |
string
O nome do argumento.
|
type |
string
O nome do tipo do argumento.
|
description |
string
Uma descrição legível por humanos do argumento.
|
optional |
boolean
Indica se o argumento é opcional.
|
defaultValue |
value (Value format)
O valor padrão que o argumento assume se um valor não for fornecido.
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 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. |"]]
