Package google.maps.mapsplatformdatasets.v1alpha

インデックス

MapsPlatformDatasetsV1Alpha

Maps Platform Datasets API のサービス定義。

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

指定されたプロジェクトの新しいデータセットを作成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • mapsplatformdatasets.datasets.create

詳細については、IAM のドキュメントをご覧ください。

DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

指定されたデータセットを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • mapsplatformdatasets.datasets.delete

詳細については、IAM のドキュメントをご覧ください。

DownloadDataset

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

データセットをダウンロードします。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • mapsplatformdatasets.datasets.export

詳細については、IAM のドキュメントをご覧ください。

GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

データセットを取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • mapsplatformdatasets.datasets.get

詳細については、IAM のドキュメントをご覧ください。

ImportDataset

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

データセットの新しいバージョンのデータをインポートします。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • mapsplatformdatasets.datasets.import

詳細については、IAM のドキュメントをご覧ください。

ListDatasetErrors

rpc ListDatasetErrors(ListDatasetErrorsRequest) returns (ListDatasetErrorsResponse)

データセットのすべてのエラーを取得します(現在、これは DDS ユースケースでのみ機能します)。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • mapsplatformdatasets.datasets.get

詳細については、IAM のドキュメントをご覧ください。

ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

指定されたプロジェクトのすべてのデータセットを一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • mapsplatformdatasets.datasets.list

詳細については、IAM のドキュメントをご覧ください。

UpdateDatasetMetadata

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

データセットのメタデータを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • mapsplatformdatasets.datasets.update

詳細については、IAM のドキュメントをご覧ください。

CreateDatasetRequest

地図データセットの作成リクエスト。

フィールド
parent

string

必須。データセットを所有する親プロジェクト。形式: projects/{$project}

dataset

Dataset

必須。作成するデータセット バージョン。

データセット

地図プラットフォームのデータセットの表現。

フィールド
name

string

リソース名: projects/{project}/datasets/{dataset_id}

display_name

string

コンソール UI に表示される、人が読める名前。

description

string

このデータセットの説明。

version_id

string

データセットのバージョン ID。

usage[]

Usage

このデータセットの指定されたユースケース。

status

Status

出力専用。このデータセット バージョンのステータス。

create_time

Timestamp

出力専用。データセットが最初に作成された時刻。

update_time

Timestamp

出力専用。データセットのメタデータが最後に更新された時刻。

version_create_time

Timestamp

出力専用。このバージョンのデータセットが作成された時刻。(データセットにデータをインポートするときに発生しました)

version_description

string

出力専用。このバージョンのデータセットの説明。データセットにデータをインポートするときに指定します。

共用体フィールド data_source。データセットのデータのソースに関する詳細。data_source は次のいずれかになります。
local_file_source

LocalFileSource

1 回のアップロード用のデータセットのローカル ファイルソース。

gcs_source

GcsSource

1 回のアップロードのデータセットの Google Cloud Storage ファイルソース。

DeleteDatasetRequest

データセットを削除するリクエスト。

削除するデータセット。

フィールド
name

string

必須。形式: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

データセットのダウンロードをリクエストします。

フィールド
name

string

取得するデータセット。形式: projects/${project}/datasets/${dataset_id}

DownloadDatasetResponse

データセットのダウンロードからのレスポンス。

FileFormat

アップロードするファイルの形式。

列挙型
FILE_FORMAT_UNSPECIFIED ファイル形式が指定されていません。
FILE_FORMAT_GEOJSON GeoJson ファイル。
FILE_FORMAT_KML KML ファイル。
FILE_FORMAT_CSV CSV ファイル。

GcsSource

データソースが Google Cloud Storage にある場合の詳細。

フィールド
input_uri

string

ソースデータ URI。例: gs://my_bucket/my_object

file_format

FileFormat

Google Cloud Storage オブジェクトのファイル形式。これは主に検証に使用されます。

GetDatasetRequest

指定されたデータセットを取得するリクエスト。

フィールド
name

string

必須。リソース名。projects/{project}/datasets/{dataset_id}

ImportDatasetRequest

データセットの新しいバージョンのインポートをリクエストします。

フィールド
name

string

必須。リソース名: projects/{project}/datasets/{dataset_id}

version_description

string

インポートされる新しいデータの説明。

共用体フィールド data_source。データセットのデータのソースに関する詳細。data_source は次のいずれかになります。
local_file_source

LocalFileSource

1 回限りのインポート用のデータセットのローカル ファイルソース。

gcs_source

GcsSource

1 回限りのインポート用のデータセットの Google Cloud Storage ファイルソース。

ImportDatasetResponse

データセットの新しいバージョンのインポートからのレスポンス。

フィールド
name

string

必須。新しく作成されたデータセット バージョンのリソース名。projects/{project}/datasets/{dataset_id}@{version_id}

ListDatasetErrorsRequest

データセットに属するエラーの詳細を一覧表示するリクエスト。

フィールド
name

string

必須。形式: projects/${project}/datasets/{dataset_id}

page_size

int32

ページごとに返すバージョンの最大数。デフォルトは 10 です。

page_token

string

前回の ListDatasetErrors 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ListDatasetErrorsResponse

ListDatasetErrors のレスポンス。エラー メッセージの繰り返し文字列を返します。

フィールド
error_messages[]

string

データセットに属するエラー。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListDatasetsRequest

プロジェクトのデータセットを一覧表示するリクエスト。

フィールド
parent

string

必須。すべてのデータセットを一覧表示するプロジェクトの名前。

page_size

int32

ページごとに返すバージョンの最大数。指定しない場合(または 0 の場合)、すべてのデータセットが返されます。

page_token

string

前回の ListDatasets 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ListDatasetsResponse

プロジェクトのデータセットを一覧表示するレスポンス。

フィールド
datasets[]

Dataset

プロジェクトのすべてのデータセット。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

LocalFileSource

ローカル ファイルの場合のデータソースに関する詳細。

フィールド
filename

string

アップロードされたファイルのファイル名と拡張子。

file_format

FileFormat

アップロードするファイルの形式。

ステータス

データセット バージョンのステータス。

フィールド
state

State

ステータスの状態列挙型。

error_message

string

失敗の理由を示すエラー メッセージ。データセットが失敗状態でない場合は空になります。

データセット バージョンの状態のリスト。ここで値を変更した場合は、Status ユーティリティ メソッドの更新を検討してください。

列挙型
STATE_UNSPECIFIED このデータセットの状態が設定されていません。
STATE_IMPORTING データセットのバージョンがインポートされます。
STATE_IMPORT_SUCCEEDED データセット バージョンのインポートが成功しました。
STATE_IMPORT_FAILED データセット バージョンをインポートできませんでした。
STATE_DELETING データセットは削除中です。
STATE_DELETION_FAILED 削除失敗状態。この状態は、データセットの削除が失敗したことを示します。削除は再試行されることがあります。
STATE_PROCESSING 処理ステータス。この状態は、データセットを派生データセットに照合して処理する初期状態を表します。
STATE_PROCESSING_FAILED 処理が失敗した状態。この状態は、処理が失敗し、エラーが報告される可能性があることを表します。
STATE_NEEDS_REVIEW 審査が必要な状態。この状態は、特定の用途で公開して提供できるデータがあることを示します。
STATE_PUBLISHING 公開ステータス。この状態は、公開が進行中であることを示します。
STATE_PUBLISHING_FAILED 公開に失敗した状態。この状態は、公開が失敗したことを表します。公開は再試行できます。
STATE_COMPLETED 完了状態。この状態は、データセットが特定の用途で使用できることを表します。

UpdateDatasetMetadataRequest

データセットのメタデータ フィールドの更新をリクエストします。

フィールド
dataset

Dataset

必須。更新するデータセット。データセットの名前は、更新するデータセットの識別に使用されます。名前の形式は projects/{project}/datasets/{dataset_id} です。

update_mask

FieldMask

更新するフィールドのリスト。完全な置換に値「*」をサポートします。

用途

使用目的は、データの使用目的を指定して、データの処理方法を通知します。

列挙型
USAGE_UNSPECIFIED このデータセットの使用状況が設定されていません。
USAGE_DATA_DRIVEN_STYLING このデータセットは、データドリブン スタイル設定に使用されます。