Method: projects.assets.getPixels

画像アセットからピクセルを取得します。このカスタム メソッドを使用すると、呼び出し元は画像から任意のピクセル タイルをリクエストできます。必要に応じて、バンドと地図投影を指定することもできます。マスキングされたデータまたは欠落しているデータは、ゼロとしてエンコードされます。

リクエストは、リクエストのディメンション（ピクセル単位）、リクエストされた画像バンドの数、各バンドのピクセルあたりのバイト数の積として計算される、リクエストあたり 48 MB の非圧縮データに制限されます。リクエストは、いずれかのディメンションで最大 32,000 ピクセル、最大 1,024 バンドに制限されています。これらの上限を超えるリクエストは、エラーコード 400（BAD_REQUEST）になります。

成功した場合、レスポンスの本文には、リクエストの fileFormat フィールドで指定されたエンコードでリクエストされたピクセルデータが含まれます。

HTTP リクエスト

POST https://earthengine.googleapis.com/v1/{name=projects/*/assets/**}:getPixels

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

パスパラメータ

パラメータ
name

string

必須。ピクセルを取得する画像アセットの名前。name の形式は「projects/*/assets/**」です（例: 「projects/earthengine-legacy/assets/users/[USER]/[ASSET]」）。ユーザー所有のアセットはすべて、プロジェクト「earthengine-legacy」に含まれています（例: 「projects/earthengine-legacy/assets/users/foo/bar」）。その他のアセットはすべてプロジェクト「earthengine-public」に含まれています（例: "projects/earthengine-public/assets/LANDSAT").

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

  • earthengine.assets.get

リクエストの本文

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

JSON 表現 
{
  "fileFormat": enum (ImageFileFormat),
  "grid": {
    object (PixelGrid)
  },
  "region": {
    object
  },
  "bandIds": [
    string
  ],
  "visualizationOptions": {
    object (VisualizationOptions)
  },
  "workloadTag": string
}
フィールド
fileFormat

enum (ImageFileFormat)

ピクセル値を返す出力ファイル形式。
grid

object (PixelGrid)

データを取得するピクセル グリッドを記述するパラメータ。デフォルトは、データのネイティブ ピクセル グリッドです。
region

object (Struct format)

指定されている場合、返されるデータの領域。GeoJSON ジオメトリ オブジェクトとして指定します（RFC 7946 を参照）。返される画像は常に長方形であるため、出力座標系で指定されたジオメトリの境界ボックスが実際に使用されます。grid.dimensions も指定すると、グリッドはリクエストされたサイズに再スケーリングされます。
bandIds[]

string

指定されている場合、ピクセルを取得する特定のバンドセットを指定します。バンドは ID で識別されます。これは、ImageBand プロトコルの id フィールドで示されます。
visualizationOptions

object (VisualizationOptions)

存在する場合は、元のデータではなく、データの 8 ビット RGB ビジュアリゼーションを生成するために適用する一連のビジュアリゼーション オプション。
workloadTag

string

この計算をトラッキングするためにユーザーが指定したタグ。

レスポンスの本文

成功した場合、レスポンスはメソッドによって定義された形式の汎用 HTTP レスポンスになります。

認可スコープ

以下のいずれかの 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 をご覧ください。