Package google.maps.mapsplatformdatasets.v1

索引

MapsPlatformDatasets

地圖平台 Datasets API 的服務定義。

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

為指定專案建立新資料集。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform
身分與存取權管理權限

必須具備 parent 資源的下列 IAM 權限:

  • mapsplatformdatasets.datasets.create

詳情請參閱身分與存取權管理說明文件

DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

刪除指定資料集。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform
身分與存取權管理權限

必須具備 name 資源的下列 IAM 權限:

  • mapsplatformdatasets.datasets.delete

詳情請參閱身分與存取權管理說明文件

DownloadDataset

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

下載資料集。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform
身分與存取權管理權限

必須具備 name 資源的下列 IAM 權限:

  • mapsplatformdatasets.datasets.export

詳情請參閱身分與存取權管理說明文件

GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

取得資料集。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform
身分與存取權管理權限

必須具備 name 資源的下列 IAM 權限:

  • mapsplatformdatasets.datasets.get

詳情請參閱身分與存取權管理說明文件

ImportDataset

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

為資料集匯入新版本的資料。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform
身分與存取權管理權限

必須具備 name 資源的下列 IAM 權限:

  • mapsplatformdatasets.datasets.import

詳情請參閱身分與存取權管理說明文件

ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

列出指定專案的所有資料集。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform
身分與存取權管理權限

必須具備 parent 資源的下列 IAM 權限:

  • mapsplatformdatasets.datasets.list

詳情請參閱身分與存取權管理說明文件

UpdateDatasetMetadata

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

更新資料集的中繼資料。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform
身分與存取權管理權限

必須具備 name 資源的下列 IAM 權限:

  • mapsplatformdatasets.datasets.update

詳情請參閱身分與存取權管理說明文件

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

單一上傳作業的資料集本機檔案來源。

gcs_source

GcsSource

單一上傳作業的資料集 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 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

一次匯入的資料集的本機檔案來源。

gcs_source

GcsSource

一次匯入的資料集的 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 這個資料集會用於資料導向樣式。