Method: projects.algorithms.list
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Lấy danh sách tất cả các thuật toán có thể sử dụng trong Biểu thức.
Yêu cầu HTTP
GET https://earthengine.googleapis.com/v1/{parent=projects/*}/algorithms
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
| Thông số |
parent |
string
Bắt buộc. Mã dự án hoặc số dự án của dự án Google Cloud Platform sẽ được coi là người dùng dịch vụ cho yêu cầu này. Định dạng là projects/{project-id}.
Việc uỷ quyền yêu cầu quyền IAM sau đây trên tài nguyên parent đã chỉ định:
earthengine.computations.create
|
Nội dung yêu cầu
Nội dung yêu cầu phải trống.
Nội dung phản hồi
Tất cả thuật toán có sẵn để sử dụng trong Biểu thức.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
| Biểu diễn dưới dạng JSON |
{
"algorithms": [
{
object (Algorithm)
}
]
} |
| Trường |
algorithms[] |
object (Algorithm)
Danh sách các thuật toán có sẵn.
|
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau:
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
Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.
Thuật toán
Nội dung mô tả về một thuật toán có sẵn cho Biểu thức.
| Biểu diễn dưới dạng JSON |
{
"name": string,
"description": string,
"returnType": string,
"arguments": [
{
object (AlgorithmArgument)
}
],
"deprecated": boolean,
"deprecationReason": string,
"hidden": boolean,
"preview": boolean,
"sourceCodeUri": string
} |
| Trường |
name |
string
Tên thuật toán, ở dạng "algorithms/...".
|
description |
string
Nội dung mô tả thuật toán mà con người đọc được.
|
returnType |
string
Tên của loại mà thuật toán trả về.
|
arguments[] |
object (AlgorithmArgument)
Nội dung mô tả về các đối số mà thuật toán nhận được.
|
deprecated |
boolean
Liệu thuật toán có ngừng hoạt động hay không.
|
deprecationReason |
string
Nếu thuật toán này không còn được dùng nữa, hãy nêu lý do không dùng nữa.
|
hidden |
boolean
Liệu thuật toán này có nên được ẩn trong các ứng dụng khách và không hiển thị theo mặc định hay không.
|
preview |
boolean
Liệu thuật toán này có phải là tính năng xem trước và chưa được cung cấp rộng rãi cho đối tượng chung hay không.
|
sourceCodeUri |
string
URI của tài nguyên chứa mã nguồn của thuật toán. Trống nếu người dùng không có quyền hoặc không xác định được URI cụ thể.
|
AlgorithmArgument
Nội dung mô tả đối số cho một thuật toán.
| Biểu diễn dưới dạng JSON |
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
| Trường |
argumentName |
string
Tên của đối số.
|
type |
string
Tên của loại đối số.
|
description |
string
Nội dung mô tả đối số mà con người đọc được.
|
optional |
boolean
Liệu đối số có phải là không bắt buộc hay không.
|
defaultValue |
value (Value format)
Giá trị mặc định mà đối số nhận nếu không được cung cấp giá trị.
|
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-25 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2025-07-25 UTC."],[[["\u003cp\u003eThe API retrieves a comprehensive list of algorithms available for use in Earth Engine Expressions.\u003c/p\u003e\n"],["\u003cp\u003eAlgorithms are described by their name, purpose, return type, arguments, and deprecation status.\u003c/p\u003e\n"],["\u003cp\u003eEach algorithm argument is detailed, including its name, type, description, optionality, and default value.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication is required using specific OAuth scopes like \u003ccode\u003ehttps://www.googleapis.com/auth/earthengine\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made to the endpoint \u003ccode\u003eGET https://earthengine.googleapis.com/v1/{parent=projects/*}/algorithms\u003c/code\u003e, specifying the project ID.\u003c/p\u003e\n"]]],["To retrieve a list of available algorithms for use in Expressions, a `GET` request is sent to `https://earthengine.googleapis.com/v1/{parent=projects/*}/algorithms`. The request requires the `earthengine.computations.create` IAM permission. The response includes an array of algorithm objects. Each object contains the algorithm's `name`, `description`, `returnType`, `arguments`, and metadata such as whether it is `deprecated` or in `preview`. Each `argument` object contains its name, type, description, if it is `optional`, and its `defaultValue`.\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/v1/{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/v1/projects.algorithms/list#Algorithm) } ] } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `algorithms[]` | `object (`[Algorithm](/earth-engine/reference/rest/v1/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/v1/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/v1/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. |"]]
