Anuncio: Todos los proyectos no comerciales registrados para usar Earth Engine antes del
15 de abril de 2025 deben
verificar su elegibilidad no comercial para mantener el acceso a Earth Engine.
Method: projects.algorithms.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Obtiene la lista de todos los algoritmos disponibles para usar en Expresiones.
Solicitud HTTP
GET https://earthengine.googleapis.com/v1alpha/{parent=projects/*}/algorithms
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
parent |
string
Es obligatorio. El ID o el número de proyecto de Google Cloud Platform que se debe considerar como el consumidor de servicios para esta solicitud. El formato es projects/{project-id}.
La autorización requiere el siguiente permiso IAM en el recurso especificado parent:
earthengine.computations.create
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Todos los algoritmos disponibles para usar en Expresiones.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
| Representación JSON |
{
"algorithms": [
{
object (Algorithm)
}
]
} |
| Campos |
algorithms[] |
object (Algorithm)
Una lista de los algoritmos disponibles.
|
Permisos de autorización
Se necesita uno de los siguientes permisos de 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 obtener más información, consulta OAuth 2.0 Overview.
Algoritmo
Es la descripción de un algoritmo disponible para las expresiones.
| Representación JSON |
{
"name": string,
"description": string,
"returnType": string,
"arguments": [
{
object (AlgorithmArgument)
}
],
"deprecated": boolean,
"deprecationReason": string,
"hidden": boolean,
"preview": boolean,
"sourceCodeUri": string
} |
| Campos |
name |
string
Es el nombre del algoritmo, en el formato "algorithms/…".
|
description |
string
Es una descripción legible por humanos del algoritmo.
|
returnType |
string
Es el nombre del tipo que muestra el algoritmo.
|
arguments[] |
object (AlgorithmArgument)
Descripciones de los argumentos que toma el algoritmo
|
deprecated |
boolean
Indica si el algoritmo es obsoleto.
|
deprecationReason |
string
Si este algoritmo está obsoleto, el motivo de la baja
|
hidden |
boolean
Indica si este algoritmo se debe ocultar en las aplicaciones cliente y no mostrarse de forma predeterminada.
|
preview |
boolean
Si este algoritmo es una función de versión preliminar y aún no está disponible para el público en general.
|
sourceCodeUri |
string
Es el URI de un recurso que contiene el código fuente del algoritmo. Es vacío si el usuario no tiene permiso o si no se pudo determinar un URI específico.
|
AlgorithmArgument
La descripción de un argumento para un algoritmo.
| Representación JSON |
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
| Campos |
argumentName |
string
Es el nombre del argumento.
|
type |
string
Es el nombre del tipo del argumento.
|
description |
string
Es una descripción legible por humanos del argumento.
|
optional |
boolean
Indica si el argumento es opcional.
|
defaultValue |
value (Value format)
Es el valor predeterminado que toma el argumento si no se proporciona uno.
|
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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. |"]]
