Package google.maps.mapsplatformdatasets.v1

Chỉ mục

MapsPlatformDatasets

Đị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 một tập dữ liệu mới cho dự án đã 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 quản lý danh tính và quyền truy cập (IAM)

Cần có 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 quản lý danh tính và quyền truy cập (IAM)

Cần có 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 quản lý danh tính và quyền truy cập (IAM)

Cần có 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.
FetchDatasetErrors

rpc FetchDatasetErrors(FetchDatasetErrorsRequest) returns (FetchDatasetErrorsResponse)

Xem tất cả các lỗi của một 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 quản lý danh tính và quyền truy cập (IAM)

Cần có quyền IAM sau đây đối với tài nguyên dataset:

  • mapsplatformdatasets.datasets.get

Để 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 quản lý danh tính và quyền truy cập (IAM)

Cần có 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 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 quản lý danh tính và quyền truy cập (IAM)

Cần có 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ê mọi tập dữ liệu cho dự án đã 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 quản lý danh tính và quyền truy cập (IAM)

Cần có 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 quản lý danh tính và quyền truy cập (IAM)

Cần có 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 một tập dữ liệu bản đồ.

Trường
parent

string

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

Biểu diễn một tài nguyên tập dữ liệu.

Trường
name

string

Tên tài nguyên. Định dạng: dự án/{project}/datasets/{dataset_id}
display_name

string

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

Phải là duy nhất trong một dự án.
description

string

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

string

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

Usage

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 của tập dữ liệu gần đây nhất.
version_create_time

Timestamp

Chỉ có đầu ra. Thời điểm tạo phiên bản này.
version_description

string

Chỉ có đầu ra. Nội dung 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 kết hợp 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 đây:
local_file_source

LocalFileSource

Một nguồn tệp cục bộ cho tập dữ liệu cho một lượt tải lên.
gcs_source

GcsSource

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

DeleteDatasetRequest

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

Trường
name

string

Bắt buộc. Tên của tập dữ liệu cần xoá. Định dạng: dự án/{project}/datasets/{dataset_id}

DownloadDatasetRequest

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

Trường
name

string

Tên tài nguyên của tập dữ liệu cần tìm nạp. Định dạng: dự án/{project}/datasets/{dataset_id}

DownloadDatasetResponse

Đối tượng phản hồi của DownloadDataset.

FetchDatasetErrorsRequest

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
dataset

string

Bắt buộc. Tên của tập dữ liệu để liệt kê tất cả lỗi. Định dạng: dự án/{project}/datasets/{dataset_id}
page_size

int32

Số lỗi tối đa cần trả về trên mỗi trang.

Giá trị tối đa là 500; các giá trị trên 500 sẽ bị giới hạn ở mức 500.

Nếu bạn không chỉ định, trình xử lý sẽ trả về tối đa 50 lỗi.
page_token

string

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

FetchDatasetErrorsResponse

Đối tượng phản hồi của FetchDatasetErrors.

Trường
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ì sẽ không có trang tiếp theo.
errors[]

Status

Các lỗi liên quan đến một tập dữ liệu.

FileFormat

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

Enum
FILE_FORMAT_UNSPECIFIED Định dạng tệp không được chỉ đị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 nó 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 được 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. Định dạng: dự án/{project}/datasets/{dataset_id}

Cũng có thể tìm nạp một số phiên bản đặc biệt bằng cách thêm "@" và một thẻ. Định dạng: dự án/{project}/datasets/{dataset_id}@{tag}

Thẻ "đang hoạt động": Thông tin về phiên bản hoàn chỉnh mới nhất sẽ được đưa vào và NOT_FOUND nếu tập dữ liệu không có.

ImportDatasetRequest

Yêu cầu nhập 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. Định dạng: dự án/{project}/datasets/{dataset_id}
version_description

string

Nội dung mô tả về dữ liệu mới đang được nhập.
Trường kết hợp 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 đây:
local_file_source

LocalFileSource

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 trên Google Cloud Storage cho tập dữ liệu để nhập một lần.

ImportDatasetResponse

Đối tượng phản hồi của ImportDataset.

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. Định dạng: dự án/{project}/datasets/{dataset_id}@{version_id}

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 để liệt kê tất cả tập dữ liệu. Định dạng: dự án/{project}
page_size

int32

Số tập dữ liệu tối đa cần trả về trên mỗi trang.

Nếu không chỉ định (hoặc không), 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.
tag

string

Thẻ chỉ định phiên bản mong muốn cho mỗi tập dữ liệu.

Lưu ý rằng khi phân trang cũng được chỉ định, một số quá trình lọc có thể xảy ra sau khi phân trang, điều này có thể khiến phản hồi chứa ít tập dữ liệu hơn kích thước trang, ngay cả khi đó không phải là trang cuối cùng.

Thẻ "đang hoạt động": Mỗi tập dữ liệu trong câu trả lời sẽ bao gồm thông tin về phiên bản hoàn chỉnh mới nhất của tập dữ liệu đó. Tập dữ liệu sẽ bị bỏ qua nếu không có tập dữ liệu đó.

ListDatasetsResponse

Đối tượng phản hồi của ListDatasets.

Trường
datasets[]

Dataset

Tất cả tập dữ liệu cho 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ì sẽ không 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 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 tập dữ liệu.

Trường
state

State

Enum trạng thái của trạng thái.
error_message

string

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

Tiểu bang

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

Enum
STATE_UNSPECIFIED Trạng thái của tập dữ liệu này chưa được đặt.
STATE_IMPORTING Dữ liệu đang được nhập vào một tập dữ liệu.
STATE_IMPORT_SUCCEEDED Đã nhập dữ liệu vào tập dữ liệu thành công.
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 bị xoá.
STATE_DELETION_FAILED Trạng thái xoá không thành công. Trạng thái này thể hiện rằng bạn chưa xoá được tập dữ liệu. Có thể thử xoá lại.
STATE_PROCESSING Dữ liệu đang được xử lý.
STATE_PROCESSING_FAILED Trạng thái xử lý không thành công. Trạng thái này thể hiện rằng quá trình xử lý không thành công và có thể báo cáo lỗi.
STATE_NEEDS_REVIEW Trạng thái này hiện không được sử dụng.
STATE_PUBLISHING Trạng thái xuất bản. Trạng thái này thể hiện rằng quá trình xuất bản đang diễn ra.
STATE_PUBLISHING_FAILED Trạng thái không xuất bản được. Trạng thái này thể hiện rằng không xuất bản được. Bạn có thể thử xuất bản lại.
STATE_COMPLETED Trạng thái hoàn tất. Trạng thái này thể hiện tập dữ liệu đang có sẵn cho mục đích sử dụng cụ thể của tập dữ liệu đó.

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ên tài nguyên của tập dữ liệu cần cập nhật. Định dạng: dự án/{project}/datasets/{dataset_id}
update_mask

FieldMask

Danh sách các trường cần cập nhật.

Giá trị "*" được dùng để thay thế hoàn toàn (mặc định).

Cách sử dụng

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

Enum
USAGE_UNSPECIFIED Cách sử dụng tập dữ liệu này chưa được thiết lập.
USAGE_DATA_DRIVEN_STYLING Tập dữ liệu này sẽ được dùng để định kiểu theo hướng dữ liệu.