Method: projects.algorithms.list
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
รับรายการอัลกอริทึมทั้งหมดที่ใช้ได้ในนิพจน์
คำขอ HTTP
GET https://earthengine.googleapis.com/v1beta/{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
ชื่ออัลกอริทึมในรูปแบบ "algorithms/..."
|
description |
string
คำอธิบายอัลกอริทึมที่มนุษย์อ่านได้
|
returnType |
string
ชื่อของประเภทที่อัลกอริทึมแสดงผล
|
arguments[] |
object (AlgorithmArgument)
คำอธิบายอาร์กิวเมนต์ที่อัลกอริทึมใช้
|
deprecated |
boolean
อัลกอริทึมเลิกใช้งานหรือไม่
|
deprecationReason |
string
หากเลิกใช้งานอัลกอริทึมนี้ เหตุผลของการเลิกใช้งาน
|
hidden |
boolean
การตั้งค่าว่าควรซ่อนอัลกอริทึมนี้ในแอปพลิเคชันไคลเอ็นต์หรือไม่และไม่ให้แสดงโดยค่าเริ่มต้น
|
preview |
boolean
อัลกอริทึมนี้เป็นฟีเจอร์เวอร์ชันตัวอย่างและยังไม่พร้อมให้บริการแก่ผู้ใช้ทั่วไปในวงกว้างหรือไม่
|
sourceCodeUri |
string
URI ของทรัพยากรที่มีซอร์สโค้ดของอัลกอริทึม ว่าง หากผู้ใช้ไม่มีสิทธิ์หรือไม่สามารถระบุ URI ที่เฉพาะเจาะจงได้
|
AlgorithmArgument
คำอธิบายอาร์กิวเมนต์ของอัลกอริทึม
| การแสดง JSON |
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
| ช่อง |
argumentName |
string
ชื่อของอาร์กิวเมนต์
|
type |
string
ชื่อประเภทของอาร์กิวเมนต์
|
description |
string
คำอธิบายอาร์กิวเมนต์ที่มนุษย์อ่านได้
|
optional |
boolean
ระบุว่าอาร์กิวเมนต์เป็นแบบบังคับหรือไม่
|
defaultValue |
value (Value format)
ค่าเริ่มต้นที่อาร์กิวเมนต์จะใช้หากไม่ได้ระบุค่า
|
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers 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\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. |"]]
