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

资源名称。Format: projects/{project}/datasets/{dataset_id}
display_name

string

直观易懂的名称，显示在控制台界面中。

在项目中必须是唯一的。
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

DownloadDataset 的响应对象。

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

必需。资源名称。Format: projects/{project}/datasets/{dataset_id}

还可以通过附加“@”和标记来提取某些特殊版本。Format: projects/{project}/datasets/{dataset_id}@{tag}

标记“active”：将包含最新完成版本的信息，如果数据集不包含版本，则值为 NOT_FOUND。

ImportDatasetRequest

请求导入新版数据集。

字段
name

string

必需。资源名称。Format: 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

必需。新创建的数据集版本的资源名称。Format: 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

必需。要更新的数据集的资源名称。Format: projects/{project}/datasets/{dataset_id}
update_mask

FieldMask

要更新的字段列表。

值“*”用于实行替换（默认）。

用量

用法指定了预期使用数据的位置，以告知如何处理数据。

枚举
USAGE_UNSPECIFIED 未设置此数据集的用途。
USAGE_DATA_DRIVEN_STYLING 此数据集将用于数据驱动型样式。