Method: projects.algorithms.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הפונקציה מקבלת את הרשימה של כל האלגוריתמים שזמינים לשימוש בביטויים.
בקשת HTTP
GET https://earthengine.googleapis.com/v1beta/{parent=projects/*}/algorithms
כתובת ה-URL משתמשת בתחביר של Transcoding של 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
האם האלגוריתם הזה הוא תכונה בתוכנית Public Preview שעדיין לא זמינה לקהל הרחב.
|
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)
ערך ברירת המחדל של הארגומנט אם לא צוין ערך.
|
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 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. |"]]
