Method: projects.algorithms.list

Lấy danh sách tất cả các thuật toán có thể sử dụng trong Biểu thức.

Yêu cầu HTTP

GET https://earthengine.googleapis.com/v1/{parent=projects/*}/algorithms

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
parent

string

Bắt buộc. Mã dự án hoặc số dự án của dự án Google Cloud Platform sẽ được coi là người dùng dịch vụ cho yêu cầu này. Định dạng là projects/{project-id}.

Việc uỷ quyền yêu cầu quyền IAM sau đây trên tài nguyên parent đã chỉ định:

  • earthengine.computations.create

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Tất cả thuật toán có sẵn để sử dụng trong Biểu thức.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "algorithms": [
    {
      object (Algorithm)
    }
  ]
}
Trường
algorithms[]

object (Algorithm)

Danh sách các thuật toán có sẵn.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • 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

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.

Thuật toán

Nội dung mô tả về một thuật toán có sẵn cho Biểu thức.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "description": string,
  "returnType": string,
  "arguments": [
    {
      object (AlgorithmArgument)
    }
  ],
  "deprecated": boolean,
  "deprecationReason": string,
  "hidden": boolean,
  "preview": boolean,
  "sourceCodeUri": string
}
Trường
name

string

Tên thuật toán, ở dạng "algorithms/...".
description

string

Nội dung mô tả thuật toán mà con người đọc được.
returnType

string

Tên của loại mà thuật toán trả về.
arguments[]

object (AlgorithmArgument)

Nội dung mô tả về các đối số mà thuật toán nhận được.
deprecated

boolean

Liệu thuật toán có ngừng hoạt động hay không.
deprecationReason

string

Nếu thuật toán này không còn được dùng nữa, hãy nêu lý do không dùng nữa.
hidden

boolean

Liệu thuật toán này có nên được ẩn trong các ứng dụng khách và không hiển thị theo mặc định hay không.
preview

boolean

Liệu thuật toán này có phải là tính năng xem trước và chưa được cung cấp rộng rãi cho đối tượng chung hay không.
sourceCodeUri

string

URI của tài nguyên chứa mã nguồn của thuật toán. Trống nếu người dùng không có quyền hoặc không xác định được URI cụ thể.

AlgorithmArgument

Nội dung mô tả đối số cho một thuật toán.

Biểu diễn dưới dạng JSON 
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
Trường
argumentName

string

Tên của đối số.
type

string

Tên của loại đối số.
description

string

Nội dung mô tả đối số mà con người đọc được.
optional

boolean

Liệu đối số có phải là không bắt buộc hay không.
defaultValue

value (Value format)

Giá trị mặc định mà đối số nhận nếu không được cung cấp giá trị.