Method: projects.algorithms.list

取得可在運算式中使用的所有演算法清單。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。應視為此要求服務用戶的 Google Cloud Platform 專案專案 ID 或專案編號。格式為 projects/{project-id}。

授權需要指定資源 parent 的下列 IAM 權限：

  • 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)

如果未提供值，引數會採用的預設值。