Method: projects.algorithms.list

式で使用できるすべてのアルゴリズムのリストを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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)

値が指定されていない場合に引数に適用されるデフォルト値。