Method: projects.algorithms.list

تحصل على قائمة بجميع الخوارزميات المتاحة للاستخدام في التعبيرات.

طلب HTTP

GET https://earthengine.googleapis.com/v1/{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)

القيمة التلقائية التي تأخذها الوسيطة في حال عدم تقديم قيمة