Method: projects.algorithms.list

הפונקציה מקבלת את הרשימה של כל האלגוריתמים שזמינים לשימוש בביטויים.

בקשת HTTP

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

ערך ברירת המחדל של הארגומנט אם לא צוין ערך.