إشعار: يجب
إثبات أهلية جميع المشاريع غير التجارية المسجّلة لاستخدام Earth Engine قبل
15 أبريل 2025 من أجل الحفاظ على إمكانية الوصول إلى Earth Engine.
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
معرّف الموارد المنتظم لمورد يحتوي على رمز المصدر للخوارزمية تكون فارغة إذا لم يكن لدى المستخدم الإذن أو تعذّر تحديد عنوان URL معيّن.
|
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 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\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. |"]]
