Объявление : Все некоммерческие проекты, зарегистрированные для использования Earth Engine до
15 апреля 2025 года, должны
подтвердить некоммерческое право на сохранение доступа к Earth Engine.
Method: projects.algorithms.list
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Получает список всех алгоритмов, доступных для использования в выражениях.
HTTP-запрос
GET https://earthengine.googleapis.com/v1alpha/{parent=projects/*}/algorithms
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
| Параметры |
|---|
parent | string Необходимый. Идентификатор или номер проекта Google Cloud Platform, который следует рассматривать как потребителя услуги для этого запроса. Формат: projects/{project-id} . Для авторизации требуется следующее разрешение IAM для указанного parent ресурса: -
earthengine.computations.create
|
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Все алгоритмы, доступные для использования в выражениях.
В случае успеха тело ответа содержит данные следующей структуры:
| JSON-представление |
|---|
{
"algorithms": [
{
object (Algorithm)
}
]
} |
| Поля |
|---|
algorithms[] | object ( Algorithm ) Список доступных алгоритмов. |
Области авторизации
Требуется одна из следующих областей 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
Для получения дополнительной информации см.OAuth 2.0 Overview .
Алгоритм
Описание алгоритма, доступного для Выражений.
| JSON-представление |
|---|
{
"name": string,
"description": string,
"returnType": string,
"arguments": [
{
object (AlgorithmArgument)
}
],
"deprecated": boolean,
"deprecationReason": string,
"hidden": boolean,
"preview": boolean,
"sourceCodeUri": string
} |
| Поля |
|---|
name | string Имя алгоритма в форме «алгоритмы/...». |
description | string Удобочитаемое описание алгоритма. |
returnType | string Имя типа, который возвращает алгоритм. |
arguments[] | object ( AlgorithmArgument ) Описания аргументов, которые принимает алгоритм. |
deprecated | boolean Является ли алгоритм устаревшим. |
deprecationReason | string Если этот алгоритм устарел, укажите причину его устаревания. |
hidden | boolean Должен ли этот алгоритм быть скрыт в клиентских приложениях и не отображаться по умолчанию. |
preview | boolean Является ли этот алгоритм предварительной функцией и еще не широко доступен для широкой аудитории. |
sourceCodeUri | string URI ресурса, содержащего исходный код алгоритма. Пусто, если у пользователя нет разрешения или не удалось определить конкретный URI. |
АлгоритмАргумент
Описание аргумента алгоритма.
| JSON-представление |
|---|
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
| Поля |
|---|
argumentName | string Имя аргумента. |
type | string Имя типа аргумента. |
description | string Удобочитаемое описание аргумента. |
optional | boolean Является ли аргумент необязательным. |
defaultValue | value ( Value format) Значение по умолчанию, которое принимает аргумент, если значение не указано. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 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. |"]]
