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

rpc FetchDatasetErrors(FetchDatasetErrorsRequest) returns (FetchDatasetErrorsResponse)

データセットのすべてのエラーを取得します。

認可スコープ

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

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

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

  • mapsplatformdatasets.datasets.get

詳細については、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

必須。削除するデータセットの名前。形式: projects/{project}/datasets/{dataset_id}

DownloadDatasetRequest

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

フィールド
name

string

取得するデータセットのリソース名。形式: projects/{project}/datasets/{dataset_id}

DownloadDatasetResponse

DownloadDataset のレスポンス オブジェクト。

FetchDatasetErrorsRequest

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

フィールド
dataset

string

必須。すべてのエラーを一覧表示するデータセットの名前。形式: projects/{project}/datasets/{dataset_id}
page_size

int32

ページごとに返されるエラーの最大数。

最大値は 500 です。500 を超える値については 500 に制限されます。

指定しない場合、最大で 50 個のエラーが返されます。
page_token

string

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

FetchDatasetErrorsResponse

FetchDatasetErrors のレスポンス オブジェクト。

フィールド
next_page_token

string

次のページを取得するために page_token として送信できるトークン。

このフィールドを省略すると、後続のページはなくなります。
errors[]

Status

データセットに関連するエラーです。

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}

「@」を追加して一部の特殊なバージョンを取得することもできます。なります。形式: projects/{project}/datasets/{dataset_id}@{tag}

タグ「active」: 完了した最新のバージョンの情報が含まれます。データセットにバージョンがない場合は NOT_FOUND になります。

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

ImportDataset のレスポンス オブジェクト。

フィールド
name

string

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

ListDatasetsRequest

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

フィールド
parent

string

必須。すべてのデータセットを一覧表示するプロジェクトの名前。形式: projects/{project}
page_size

int32

ページごとに返されるデータセットの最大数。

指定しない（またはゼロ）と、すべてのデータセットが返されます。
page_token

string

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

string

各データセットに必要なバージョンを指定するタグ。

なお、ページ分けも指定されている場合、ページ分け後に一部のフィルタリングが行われることがあります。その場合、最後のページでなくても、レスポンスに含まれるデータセットがページサイズよりも少なくなる可能性があります。

タグ「アクティブ」: レスポンス内の各データセットには、完了した最新のバージョンの情報が含まれます。データセットに情報がない場合はスキップされます。

ListDatasetsResponse

ListDatasets のレスポンス オブジェクト。

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