Pengumuman: Semua project nonkomersial yang terdaftar untuk menggunakan Earth Engine sebelum
15 April 2025 harus
memverifikasi kelayakan nonkomersial untuk mempertahankan akses Earth Engine.
Method: projects.algorithms.list
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Mendapatkan daftar semua algoritma yang tersedia untuk digunakan dalam Ekspresi.
Permintaan HTTP
GET https://earthengine.googleapis.com/v1alpha/{parent=projects/*}/algorithms
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
parent |
string
Wajib. Project ID atau nomor project project Google Cloud Platform yang harus diperlakukan sebagai konsumen layanan untuk permintaan ini. Format adalah projects/{project-id}.
Otorisasi memerlukan izin IAM berikut pada resource parent yang ditentukan:
earthengine.computations.create
|
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Semua algoritma yang tersedia untuk digunakan dalam Ekspresi.
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
{
"algorithms": [
{
object (Algorithm)
}
]
} |
| Kolom |
algorithms[] |
object (Algorithm)
Daftar algoritma yang tersedia.
|
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
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
Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.
Algoritma
Deskripsi algoritma yang tersedia untuk Ekspresi.
| Representasi JSON |
{
"name": string,
"description": string,
"returnType": string,
"arguments": [
{
object (AlgorithmArgument)
}
],
"deprecated": boolean,
"deprecationReason": string,
"hidden": boolean,
"preview": boolean,
"sourceCodeUri": string
} |
| Kolom |
name |
string
Nama algoritma, dalam bentuk "algorithms/...".
|
description |
string
Deskripsi algoritma yang dapat dibaca manusia.
|
returnType |
string
Nama jenis yang ditampilkan algoritma.
|
arguments[] |
object (AlgorithmArgument)
Deskripsi argumen yang digunakan algoritma.
|
deprecated |
boolean
Apakah algoritma tidak digunakan lagi.
|
deprecationReason |
string
Jika algoritma ini tidak digunakan lagi, alasan penghentian penggunaannya.
|
hidden |
boolean
Apakah algoritma ini harus disembunyikan di aplikasi klien dan tidak ditampilkan secara default.
|
preview |
boolean
Apakah algoritma ini adalah fitur pratinjau dan belum tersedia secara luas untuk audiens umum.
|
sourceCodeUri |
string
URI resource yang berisi kode sumber algoritma. Kosong jika pengguna tidak memiliki izin atau URI tertentu tidak dapat ditentukan.
|
AlgorithmArgument
Deskripsi argumen untuk algoritma.
| Representasi JSON |
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
| Kolom |
argumentName |
string
Nama argumen.
|
type |
string
Nama jenis argumen.
|
description |
string
Deskripsi argumen yang dapat dibaca manusia.
|
optional |
boolean
Apakah argumen bersifat opsional.
|
defaultValue |
value (Value format)
Nilai default yang diambil argumen jika nilai tidak diberikan.
|
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 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. |"]]
