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

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

rpc FetchDatasetErrors(FetchDatasetErrorsRequest) returns (FetchDatasetErrorsResponse)

取得資料集的所有錯誤。

授權範圍

需要下列 OAuth 範圍：

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

必須具備 dataset 資源的下列 IAM 權限：

  • mapsplatformdatasets.datasets.get

詳情請參閱身分與存取權管理說明文件。
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

必要欄位。要刪除的資料集名稱。格式：projects/{project}/datasets/{dataset_id}

DownloadDatasetRequest

要求下載資料集。

欄位
name

string

待擷取資料集的資源名稱。格式：projects/{project}/datasets/{dataset_id}

DownloadDatasetResponse

下載資料集的回應物件。

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 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

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

GcsSource

資料集的 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

指定每個資料集所需版本的標記。

請注意，如果也指定了分頁，有些篩選功能會在分頁後發生，這可能會導致回應包含的資料集數量少於頁面大小，即使不是最後一頁也一樣。

標記「active」：回應中的每個資料集都會包含其最新完成版本的資訊，如果沒有資料集，則會略過該資料集。

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