Package google.maps.mapsplatformdatasets.v1alpha

Chỉ mục

MapsPlatformDatasetsV1Alpha

Định nghĩa dịch vụ cho Maps Platform Datasets API.

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

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

Phạm vi cấp phép

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 trên 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 đã chỉ định .

Phạm vi cấp phép

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 trên 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 cấp phép

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 trên 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)

Nhận tập dữ liệu.

Phạm vi cấp phép

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 trên 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 cấp phép

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 trên tài nguyên name:

  • mapsplatformdatasets.datasets.import

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

rpc ListDatasetErrors(ListDatasetErrorsRequest) returns (ListDatasetErrorsResponse)

Nhận tất cả lỗi của một Tập dữ liệu (hiện tại, phương thức này chỉ hoạt động cho trường hợp sử dụng DDS).

Phạm vi cấp phép

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 trên tài nguyên name:

  • mapsplatformdatasets.datasets.get

Để 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ả các tập dữ liệu cho dự án đã chỉ định.

Phạm vi cấp phép

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 trên 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 cấp phép

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 trên 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 một tập dữ liệu trên Maps.

Trường
parent

string

Bắt buộc. Dự án gốc sẽ sở hữu tập dữ liệu. Định dạng: projects/{$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

Một bản trình bày về tập dữ liệu của nền tảng bản đồ.

Trường
name

string

Tên tài nguyên, projects/{project}/datasets/{dataset_id}
display_name

string

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

string

Nội dung mô tả về tập dữ liệu này .
version_id

string

Mã nhận dạng 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 gian tạo tập dữ liệu lần đầu tiên.
update_time

Timestamp

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

Timestamp

Chỉ có đầu ra. Thời gian tạo phiên bản tập dữ liệu này. (Lỗi 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. Nội dung mô tả cho phiên bản tập dữ liệu này. Khoá 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 cho tập dữ liệu. data_source chỉ có thể là một trong những trạng thái sau:
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

Một 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á một tập dữ liệu.

Tập dữ liệu sẽ bị xoá.

Trường
name

string

Bắt buộc. Định dạng: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

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

Trường
name

string

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

DownloadDatasetResponse

Phản hồi từ việc tải tập dữ liệu xuống.

FileFormat

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

Enum
FILE_FORMAT_UNSPECIFIED Định dạng tệp không xác định.
FILE_FORMAT_GEOJSON Tệp GeoJSON.
FILE_FORMAT_KML Tệp KML.
FILE_FORMAT_CSV CSV.

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.

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 dùng để xác thực.

GetDatasetRequest

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

Trường
name

string

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

ImportDatasetRequest

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

Trường
name

string

Bắt buộc. Tên tài nguyên, projects/{project}/datasets/{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 cho tập dữ liệu. data_source chỉ có thể là một trong những trạng thái sau:
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

Một 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 một phiên bản mới của tập dữ liệu.

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, projects/{project}/datasets/{dataset_id}@{version_id}

ListDatasetErrorsRequest

Yêu cầu liệt kê các lỗi chi tiết thuộc một Tập dữ liệu.

Trường
name

string

Bắt buộc. Định dạng: projects/${project}/datasets/{dataset_id}
page_size

int32

Số lượng phiên bản tối đa cần trả về cho mỗi trang. Giá trị mặc định là 10.
page_token

string

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

ListDatasetErrorsResponse

Phản hồi của ListDatasetErrors. Trả về một chuỗi lặp lại cho thông báo lỗi.

Trường
error_messages[]

string

Các lỗi thuộc về một Tập dữ liệu.
next_page_token

string

Một 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 bạn bỏ qua trường này, thì sẽ không có các trang tiếp theo.

ListDatasetsRequest

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

Trường
parent

string

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

int32

Số lượng phiên bản tối đa cần trả về cho mỗi trang. Nếu bạn không chỉ định (hoặc chỉ định giá trị 0), thì tất cả cá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 thông tin này để truy xuất trang tiếp theo.

ListDatasetsResponse

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

Trường
datasets[]

Dataset

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

string

Một 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 bạn bỏ qua trường này, thì sẽ không có các trang tiếp theo.

LocalFileSource

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

Trường
filename

string

Tên tệp và đuôi tệp của tệp được 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.

Trường
state

State

Trạng thái dưới dạng kiểu dữ liệu liệt kê (enum) của tiểu bang.
error_message

string

Thông báo lỗi cho biết lý do thất bại. Trường này sẽ trống nếu tập dữ liệu không ở trạng thái thất bại.

Tiểu bang

Danh sách các trạng thái của phiên bản tập dữ liệu. Nếu các giá trị được sửa đổi ở đây, hãy cân nhắc việc cập nhật các phương thức tiện ích Trạng thái.

Enum
STATE_UNSPECIFIED Trạng thái của tập dữ liệu này chưa được đặt.
STATE_IMPORTING Phiên bản tập dữ liệu đang được nhập.
STATE_IMPORT_SUCCEEDED Đã nhập thành công phiên bản tập dữ liệu.
STATE_IMPORT_FAILED Không nhập được phiên bản tập dữ liệu.
STATE_DELETING Tập dữ liệu đang trong quá trình bị xoá.
STATE_DELETION_FAILED Trạng thái xoá không thành công. Trạng thái này cho biết 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 quá trình so khớp và xử lý ban đầu của các tập dữ liệu thành các tập dữ liệu phái sinh.
STATE_PROCESSING_FAILED Trạng thái xử lý không thành công. Trạng thái này cho biết quá trình xử lý đã thất bại và có thể báo cáo lỗi.
STATE_NEEDS_REVIEW Trạng thái cần xem xét. Trạng thái này cho biết rằng dữ liệu có sẵn để xuất bản và phân phát cho mục đích sử dụng cụ thể.
STATE_PUBLISHING Trạng thái xuất bản. Trạng thái này cho biết quá trình xuất bản đang diễn ra.
STATE_PUBLISHING_FAILED Trạng thái xuất bản không thành công. 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ử lại việc xuất bản.
STATE_COMPLETED Trạng thái đã hoàn tất. Trạng thái này cho biết tập dữ liệu có sẵn cho mục đích sử dụng 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.

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

Mục đích sử dụng chỉ định nơi dữ liệu được dự định sử dụng để thông báo cách xử lý dữ liệu.

Enum
USAGE_UNSPECIFIED Chưa đặt chế độ sử dụng cho 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.