Package google.maps.mapsplatformdatasets.v1

索引

MapsPlatformDatasets

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 のドキュメントをご覧ください。
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

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

DownloadDatasetRequest

データセットをダウンロードするためのリクエスト。

フィールド
name

string

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

DownloadDatasetResponse

データセットのダウンロードに対するレスポンス。

FileFormat

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

列挙型
FILE_FORMAT_UNSPECIFIED ファイル形式が指定されていません。
FILE_FORMAT_GEOJSON GeoJson ファイル。
FILE_FORMAT_KML KML ファイル。
FILE_FORMAT_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}）

ListDatasetsRequest

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

フィールド
parent

string

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

int32

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

string

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

ListDatasetsResponse

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

フィールド
datasets[]

Dataset

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

string

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

LocalFileSource

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

フィールド
filename

string

アップロードしたファイルの名前と拡張子。
file_format

FileFormat

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

ステータス

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

フィールド
state

State

ステータスの列挙型。
error_message

string

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

状態

データセットの状態のリスト。

列挙型
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 このデータセットはデータドリブンのスタイル設定に使用されます。