Method: projects.algorithms.list
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
فهرستی از همه الگوریتم‌های موجود برای استفاده در Expression را دریافت می‌کند.
درخواست HTTP
GET https://earthengine.googleapis.com/v1/{parent=projects/*}/algorithms
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
parent | string مورد نیاز. شناسه پروژه یا شماره پروژه پروژه Google Cloud Platform که باید به عنوان مصرف کننده سرویس برای این درخواست در نظر گرفته شود. قالب projects/{project-id} است. مجوز نیاز به مجوز IAM زیر در parent منبع مشخص شده دارد: -
earthengine.computations.create
|
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
تمام الگوریتم های موجود برای استفاده در Expressions.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی 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 .
الگوریتم
شرح یک الگوریتم موجود برای Expressions.
| نمایندگی 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 خاصی مشخص نشود، خالی است. |
Argument الگوریتم
شرح یک آرگومان به یک الگوریتم.
| نمایندگی JSON |
|---|
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
| فیلدها |
|---|
argumentName | string نام استدلال. |
type | string نام نوع استدلال. |
description | string شرحی قابل خواندن برای انسان از استدلال. |
optional | boolean اینکه آیا آرگومان اختیاری است. |
defaultValue | value ( Value format) مقدار پیش فرضی که آرگومان می گیرد اگر مقداری ارائه نشود. |
،
فهرستی از همه الگوریتم‌های موجود برای استفاده در Expression را دریافت می‌کند.
درخواست HTTP
GET https://earthengine.googleapis.com/v1/{parent=projects/*}/algorithms
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
parent | string مورد نیاز. شناسه پروژه یا شماره پروژه پروژه Google Cloud Platform که باید به عنوان مصرف کننده سرویس برای این درخواست در نظر گرفته شود. قالب projects/{project-id} است. مجوز نیاز به مجوز IAM زیر در parent منبع مشخص شده دارد: -
earthengine.computations.create
|
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
تمام الگوریتم های موجود برای استفاده در Expressions.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی 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 .
الگوریتم
شرح یک الگوریتم موجود برای Expressions.
| نمایندگی 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 خاصی مشخص نشود، خالی است. |
Argument الگوریتم
شرح یک آرگومان به یک الگوریتم.
| نمایندگی JSON |
|---|
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
| فیلدها |
|---|
argumentName | string نام استدلال. |
type | string نام نوع استدلال. |
description | string شرحی قابل خواندن برای انسان از استدلال. |
optional | boolean اینکه آیا آرگومان اختیاری است. |
defaultValue | value ( Value format) مقدار پیش فرضی که آرگومان می گیرد اگر مقداری ارائه نشود. |
،
فهرستی از همه الگوریتم‌های موجود برای استفاده در Expression را دریافت می‌کند.
درخواست HTTP
GET https://earthengine.googleapis.com/v1/{parent=projects/*}/algorithms
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
parent | string مورد نیاز. شناسه پروژه یا شماره پروژه پروژه Google Cloud Platform که باید به عنوان مصرف کننده سرویس برای این درخواست در نظر گرفته شود. قالب projects/{project-id} است. مجوز نیاز به مجوز IAM زیر در parent منبع مشخص شده دارد: -
earthengine.computations.create
|
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
تمام الگوریتم های موجود برای استفاده در Expressions.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی 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 .
الگوریتم
شرح یک الگوریتم موجود برای Expressions.
| نمایندگی 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 خاصی مشخص نشود، خالی است. |
Argument الگوریتم
شرح یک آرگومان به یک الگوریتم.
| نمایندگی JSON |
|---|
{
"argumentName": string,
"type": string,
"description": string,
"optional": boolean,
"defaultValue": value
} |
| فیلدها |
|---|
argumentName | string نام استدلال. |
type | string نام نوع استدلال. |
description | string شرحی قابل خواندن برای انسان از استدلال. |
optional | boolean اینکه آیا آرگومان اختیاری است. |
defaultValue | value ( Value format) مقدار پیش فرضی که آرگومان می گیرد اگر مقداری ارائه نشود. |
،
فهرستی از همه الگوریتم‌های موجود برای استفاده در Expression را دریافت می‌کند.
درخواست HTTP
GET https://earthengine.googleapis.com/v1/{parent=projects/*}/algorithms
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
parent | string مورد نیاز. شناسه پروژه یا شماره پروژه پروژه Google Cloud Platform که باید به عنوان مصرف کننده سرویس برای این درخواست در نظر گرفته شود. قالب projects/{project-id} است. مجوز نیاز به مجوز IAM زیر در parent منبع مشخص شده دارد: -
earthengine.computations.create
|
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
تمام الگوریتم های موجود برای استفاده در Expressions.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
| نمایندگی 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 .
الگوریتم
شرح یک الگوریتم موجود برای Expressions.
| نمایندگی 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 خاصی مشخص نشود، خالی است. |
Argument الگوریتم
شرح یک آرگومان به یک الگوریتم.
| نمایندگی 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 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبت‌شده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[[["\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. |"]]
