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

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)

ค่าเริ่มต้นที่อาร์กิวเมนต์จะใช้หากไม่ได้ระบุค่า