Method: projects.image.export

イメージを計算し、結果を複数のデスティネーションのいずれかに書き込むバッチ処理を開始します。

HTTP リクエスト

POST https://earthengine.googleapis.com/v1beta/{project=projects/*}/image:export

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

パスパラメータ

パラメータ
project

string

このリクエストのサービス ユーザーとして扱う必要がある Google Cloud Platform プロジェクトのプロジェクト ID またはプロジェクト番号。形式は projects/{project-id} です。

認可には、指定されたリソース project に対する次の IAM の権限が必要です。

  • earthengine.exports.create

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "expression": {
    object (Expression)
  },
  "description": string,
  "maxPixels": string,
  "grid": {
    object (PixelGrid)
  },
  "requestId": string,
  "workloadTag": string,
  "priority": integer,

  // Union field export_options can be only one of the following:
  "fileExportOptions": {
    object (ImageFileExportOptions)
  },
  "assetExportOptions": {
    object (ImageAssetExportOptions)
  }
  // End of list of possible types for union field export_options.
}
フィールド
expression

object (Expression)

計算してエクスポートするイメージに評価される式。

description

string

タスクのわかりやすい名前。

maxPixels

string (Int64Value format)

計算してエクスポートするピクセルの最大数。これは、意図したよりも大きなエクスポートを誤って開始するのを防ぐための安全対策です。デフォルト値は 1e8 ピクセルですが、この上限を増減するには、値を明示的に設定します。

grid

object (PixelGrid)

expression によって計算された画像を再投影してクリップする方法を表すパラメータ。指定しない場合、計算された画像全体がネイティブ投影で返されます。

requestId

string

重複したリクエストを検出するために使用される一意の文字列。同じユーザーが同じ空でない requestId を使用して複数のリクエストを送信した場合、長時間実行オペレーションが正常に開始されるのは、そのうちの 1 つのみです。requestId には、a ~ z、A ~ Z、0 ~ 9、- の文字を使用できます。requestId の最大長は 60 文字です。

workloadTag

string

この計算を追跡するためにユーザーが指定したラベル。

priority

integer

省略可。プロジェクト内のエクスポート タスクの優先度。優先度の高いタスクはより早くスケジュールされます。0 ~ 9999 の整数を指定してください。設定しない場合、デフォルトは 100 です。

共用体フィールド export_options。結果の保存場所と保存方法を記述するオプション。export_options は次のいずれかになります。
fileExportOptions

object (ImageFileExportOptions)

指定すると、ファイルとしてエクスポートするように構成します。

assetExportOptions

object (ImageAssetExportOptions)

指定すると、エクスポートを Earth Engine アセットとして構成します。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/earthengine
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/devstorage.full_control

詳細については、OAuth 2.0 Overview をご覧ください。

ImageAssetExportOptions

画像を Earth Engine アセットとして保存するためのオプション。

JSON 表現
{
  "pyramidingPolicy": enum (PyramidingPolicy),
  "pyramidingPolicyOverrides": {
    string: enum (PyramidingPolicy),
    ...
  },

  // Union field destination can be only one of the following:
  "earthEngineDestination": {
    object (EarthEngineDestination)
  }
  // End of list of possible types for union field destination.
}
フィールド
pyramidingPolicy

enum (PyramidingPolicy)

すべてのバンドにデフォルトで適用されるピラミッド化ポリシー。

pyramidingPolicyOverrides

map (key: string, value: enum (PyramidingPolicy))

バンドごとの特定のピラミッド ポリシーのオーバーライド。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

共用体フィールド destination。結果を書き込む場所。destination は次のいずれかになります。
earthEngineDestination

object (EarthEngineDestination)

指定すると、Earth Engine へのエクスポートを構成します。