Package google.maps.mapsplatformdatasets.v1alpha

Chỉ mục

MapsPlatformDatasetsV1Alpha

Định nghĩa dịch vụ cho API Tập dữ liệu Nền tảng Maps.

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

Tạo tập dữ liệu mới cho dự án được chỉ định.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
Quyền IAM

Yêu cầu quyền IAM sau đây đối với tài nguyên parent:

  • mapsplatformdatasets.datasets.create

Để biết thêm thông tin, hãy xem tài liệu về IAM.

DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

Xoá tập dữ liệu được chỉ định .

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
Quyền IAM

Yêu cầu quyền IAM sau đây đối với tài nguyên name:

  • mapsplatformdatasets.datasets.delete

Để biết thêm thông tin, hãy xem tài liệu về IAM.

DownloadDataset

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

Tải một tập dữ liệu xuống.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
Quyền IAM

Yêu cầu quyền IAM sau đây đối với tài nguyên name:

  • mapsplatformdatasets.datasets.export

Để biết thêm thông tin, hãy xem tài liệu về IAM.

GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Lấy tập dữ liệu.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
Quyền IAM

Yêu cầu quyền IAM sau đây đối với tài nguyên name:

  • mapsplatformdatasets.datasets.get

Để biết thêm thông tin, hãy xem tài liệu về IAM.

ImportDataset

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

Nhập một phiên bản mới của dữ liệu cho tập dữ liệu.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
Quyền IAM

Yêu cầu quyền IAM sau đây đối với tài nguyên name:

  • mapsplatformdatasets.datasets.import

Để biết thêm thông tin, hãy xem tài liệu về IAM.

ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Liệt kê tất cả tập dữ liệu của dự án được chỉ định.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
Quyền IAM

Yêu cầu quyền IAM sau đây đối với tài nguyên parent:

  • mapsplatformdatasets.datasets.list

Để biết thêm thông tin, hãy xem tài liệu về IAM.

UpdateDatasetMetadata

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

Cập nhật siêu dữ liệu cho tập dữ liệu.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
Quyền IAM

Yêu cầu quyền IAM sau đây đối với tài nguyên name:

  • mapsplatformdatasets.datasets.update

Để biết thêm thông tin, hãy xem tài liệu về IAM.

CreateDatasetRequest

Yêu cầu tạo tập dữ liệu bản đồ.

Các trường
parent

string

Bắt buộc. Dự án mẹ sẽ sở hữu tập dữ liệu này. Định dạng: project/{$project}

dataset

Dataset

Bắt buộc. Phiên bản tập dữ liệu cần tạo.

Tập dữ liệu

Hình minh hoạ một tập dữ liệu của nền tảng bản đồ.

Các trường
name

string

Tên tài nguyên, dự án/{project}/tập dữ liệu/{dataset_id}

display_name

string

Tên dễ đọc, hiển thị trong giao diện người dùng của bảng điều khiển .

description

string

Mô tả của tập dữ liệu này .

version_id

string

Mã phiên bản của tập dữ liệu.

usage[]

Usage

(Các) trường hợp sử dụng được chỉ định cho tập dữ liệu này.

status

Status

Chỉ có đầu ra. Trạng thái của phiên bản tập dữ liệu này.

create_time

Timestamp

Chỉ có đầu ra. Thời điểm tập dữ liệu được tạo lần đầu tiên.

update_time

Timestamp

Chỉ có đầu ra. Thời điểm cập nhật siêu dữ liệu gần đây nhất.

version_create_time

Timestamp

Chỉ có đầu ra. Thời điểm phiên bản tập dữ liệu này được tạo. (Việc này xảy ra khi nhập dữ liệu vào tập dữ liệu)

version_description

string

Chỉ có đầu ra. Mô tả cho phiên bản tập dữ liệu này. Giá trị này được cung cấp khi nhập dữ liệu vào tập dữ liệu.

Trường nhóm data_source. Thông tin chi tiết về nguồn dữ liệu của tập dữ liệu. data_source chỉ có thể là một trong những trạng thái sau đây:
local_file_source

LocalFileSource

Một nguồn tệp cục bộ cho tập dữ liệu để tải lên một lần.

gcs_source

GcsSource

Nguồn tệp Google Cloud Storage cho tập dữ liệu để tải lên một lần.

DeleteDatasetRequest

Yêu cầu xoá tập dữ liệu.

Tập dữ liệu cần xoá.

Các trường
name

string

Bắt buộc. Format: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

Yêu cầu tải tập dữ liệu xuống.

Các trường
name

string

Tập dữ liệu cần tìm nạp. Format: projects/${project}/datasets/${dataset_id}

DownloadDatasetResponse

Phản hồi sau khi tải tập dữ liệu xuống.

FileFormat

Định dạng của tệp đang được tải lên.

Enum
FILE_FORMAT_UNSPECIFIED Định dạng tệp chưa được chỉ định.
FILE_FORMAT_GEOJSON Tệp GeoJson.
FILE_FORMAT_KML Tệp KML.
FILE_FORMAT_CSV CSV xuống.

GcsSource

Thông tin chi tiết về nguồn dữ liệu khi nguồn dữ liệu đó nằm trong Google Cloud Storage.

Các trường
input_uri

string

URI dữ liệu nguồn. Ví dụ: gs://my_bucket/my_object.

file_format

FileFormat

Định dạng tệp của đối tượng Google Cloud Storage. Thông tin này chủ yếu được dùng để xác thực.

GetDatasetRequest

Yêu cầu lấy tập dữ liệu đã chỉ định.

Các trường
name

string

Bắt buộc. Tên tài nguyên. dự án/{project}/datasets/{dataset_id}

ImportDatasetRequest

Yêu cầu nhập phiên bản mới của tập dữ liệu.

Các trường
name

string

Bắt buộc. Tên tài nguyên, dự án/{project}/tập dữ liệu/{dataset_id}

version_description

string

Nội dung mô tả về dữ liệu mới đang được nhập.

Trường nhóm data_source. Thông tin chi tiết về nguồn dữ liệu của tập dữ liệu. data_source chỉ có thể là một trong những trạng thái sau đây:
local_file_source

LocalFileSource

Một nguồn tệp cục bộ cho tập dữ liệu để nhập một lần.

gcs_source

GcsSource

Nguồn tệp Google Cloud Storage cho tập dữ liệu để nhập một lần.

ImportDatasetResponse

Phản hồi từ việc nhập phiên bản mới của tập dữ liệu.

Các trường
name

string

Bắt buộc. Tên tài nguyên của phiên bản tập dữ liệu mới tạo, các dự án/{project}/datasets/{dataset_id}@{version_id}

ListDatasetsRequest

Yêu cầu liệt kê các tập dữ liệu của dự án.

Các trường
parent

string

Bắt buộc. Tên của dự án để liệt kê tất cả tập dữ liệu.

page_size

int32

Số phiên bản tối đa cần trả về trên mỗi trang. Nếu không chỉ định (hoặc bằng 0), tất cả tập dữ liệu sẽ được trả về.

page_token

string

Mã thông báo trang, nhận được từ lệnh gọi ListDatasets trước đó. Cung cấp mã này để truy xuất trang tiếp theo.

ListDatasetsResponse

Phản hồi cho các tập dữ liệu danh sách của dự án.

Các trường
datasets[]

Dataset

Tất cả tập dữ liệu của dự án.

next_page_token

string

Mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu trường này bị bỏ qua thì không có trang tiếp theo nào.

LocalFileSource

Thông tin chi tiết về nguồn dữ liệu khi đó là một tệp cục bộ.

Các trường
filename

string

Tên và đuôi tệp của tệp đã tải lên.

file_format

FileFormat

Định dạng của tệp đang được tải lên.

Trạng thái

Trạng thái của phiên bản tập dữ liệu.

Các trường
state

State

Enum trạng thái cho trạng thái.

error_message

string

Thông báo lỗi cho biết lý do không thực hiện được. Giá trị này sẽ trống nếu tập dữ liệu không ở trạng thái không đạt.

Tiểu bang

Danh sách các trạng thái của tập dữ liệu.

Enum
STATE_UNSPECIFIED Chưa đặt trạng thái của tập dữ liệu này.
STATE_IMPORTING Dữ liệu đang được nhập vào một tập dữ liệu.
STATE_IMPORT_SUCCEEDED Đã nhập thành công dữ liệu vào tập dữ liệu.
STATE_IMPORT_FAILED Không nhập được dữ liệu vào tập dữ liệu.
STATE_DELETING Tập dữ liệu đang trong quá trình xoá.
STATE_DELETION_FAILED Trạng thái không xoá được. Trạng thái này thể hiện việc xoá tập dữ liệu không thành công. Bạn có thể thử xoá lại.
STATE_PROCESSING Trạng thái xử lý. Trạng thái này thể hiện hoạt động so khớp và xử lý tập dữ liệu ban đầu với các tập dữ liệu phái sinh.
STATE_PROCESSING_FAILED Dữ liệu đang được xử lý.
STATE_NEEDS_REVIEW Trạng thái này hiện không được sử dụng.
STATE_PUBLISHING Trạng thái phát hành. Trạng thái này cho biết rằng hệ thống đang phát hành nội dung.
STATE_PUBLISHING_FAILED Trạng thái không xuất bản được. Trạng thái này cho biết quá trình xuất bản không thành công. Bạn có thể thử xuất bản lại.
STATE_COMPLETED Trạng thái đã hoàn thành. Trạng thái này thể hiện rằng tập dữ liệu có thể được sử dụng trong một số trường hợp cụ thể.

UpdateDatasetMetadataRequest

Yêu cầu cập nhật các trường siêu dữ liệu của tập dữ liệu.

Các trường
dataset

Dataset

Bắt buộc. Tập dữ liệu cần cập nhật. Tên của tập dữ liệu được dùng để xác định tập dữ liệu cần cập nhật. Tên có định dạng: Projects/{project}/datasets/{dataset_id}

update_mask

FieldMask

Danh sách các trường cần cập nhật. Hỗ trợ giá trị "*" để thay thế hoàn toàn.

Cách sử dụng

Trường hợp sử dụng chỉ định vị trí dự kiến sử dụng dữ liệu để cung cấp thông tin về cách xử lý dữ liệu.

Enum
USAGE_UNSPECIFIED Chưa đặt cách sử dụng tập dữ liệu này.
USAGE_DATA_DRIVEN_STYLING Tập dữ liệu này sẽ được dùng để định kiểu dựa trên dữ liệu.