Package google.maps.mapsplatformdatasets.v1alpha

ดัชนี

MapsPlatformDatasetsV1Alpha

คำจำกัดความของบริการสำหรับ Maps Platform Datasets API

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

สร้างชุดข้อมูลใหม่สำหรับโปรเจ็กต์ที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform
สิทธิ์ IAM

ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากร parent

  • mapsplatformdatasets.datasets.create

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบเกี่ยวกับ IAM
DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

ลบชุดข้อมูลที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform
สิทธิ์ IAM

ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากร name

  • mapsplatformdatasets.datasets.delete

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบเกี่ยวกับ IAM
DownloadDataset

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

ดาวน์โหลดชุดข้อมูล

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform
สิทธิ์ IAM

ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากร name

  • mapsplatformdatasets.datasets.export

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบเกี่ยวกับ IAM
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

รับชุดข้อมูล

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform
สิทธิ์ IAM

ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากร name

  • mapsplatformdatasets.datasets.get

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบเกี่ยวกับ IAM
ImportDataset

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

นำเข้าข้อมูลเวอร์ชันใหม่สำหรับชุดข้อมูล

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform
สิทธิ์ IAM

ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากร name

  • mapsplatformdatasets.datasets.import

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบเกี่ยวกับ IAM
ListDatasetErrors

rpc ListDatasetErrors(ListDatasetErrorsRequest) returns (ListDatasetErrorsResponse)

รับข้อผิดพลาดทั้งหมดของชุดข้อมูล (ปัจจุบันใช้ได้กับกรณีการใช้งาน DDS เท่านั้น)

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform
สิทธิ์ IAM

ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากร name

  • mapsplatformdatasets.datasets.get

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบเกี่ยวกับ IAM
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

แสดงรายการชุดข้อมูลทั้งหมดสำหรับโปรเจ็กต์ที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform
สิทธิ์ IAM

ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากร parent

  • mapsplatformdatasets.datasets.list

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบเกี่ยวกับ IAM
UpdateDatasetMetadata

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

อัปเดตข้อมูลเมตาสำหรับชุดข้อมูล

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform
สิทธิ์ IAM

ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากร name

  • mapsplatformdatasets.datasets.update

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบเกี่ยวกับ IAM

CreateDatasetRequest

ขอสร้างชุดข้อมูลแผนที่

ช่อง
parent

string

ต้องระบุ โปรเจ็กต์หลักที่จะเป็นเจ้าของชุดข้อมูล รูปแบบ: projects/{$project}
dataset

Dataset

ต้องระบุ เวอร์ชันชุดข้อมูลที่จะสร้าง

ชุดข้อมูล

การแสดงชุดข้อมูลแพลตฟอร์มแผนที่

ช่อง
name

string

ชื่อทรัพยากร projects/{project}/datasets/{dataset_id}
display_name

string

ชื่อที่ผู้ใช้อ่านได้ซึ่งแสดงใน UI ของคอนโซล
description

string

คำอธิบายของชุดข้อมูลนี้
version_id

string

รหัสเวอร์ชันของชุดข้อมูล
usage[]

Usage

กรณีการใช้งานที่ระบุสำหรับชุดข้อมูลนี้
status

Status

เอาต์พุตเท่านั้น สถานะของชุดข้อมูลเวอร์ชันนี้
create_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่สร้างชุดข้อมูลเป็นครั้งแรก
update_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่อัปเดตข้อมูลเมตาของชุดข้อมูลครั้งล่าสุด
version_create_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่สร้างชุดข้อมูลเวอร์ชันนี้ (เกิดขึ้นเมื่อนำเข้าข้อมูลไปยังชุดข้อมูล)
version_description

string

เอาต์พุตเท่านั้น คำอธิบายสำหรับชุดข้อมูลเวอร์ชันนี้ โดยจะระบุเมื่อนำเข้าข้อมูลไปยังชุดข้อมูล
ฟิลด์ Union 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

การตอบกลับจากการดาวน์โหลดชุดข้อมูล

FileFormat

รูปแบบของไฟล์ที่กำลังอัปโหลด

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

ImportDatasetRequest

ส่งคำขอเพื่อนำเข้าชุดข้อมูลเวอร์ชันใหม่

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากร projects/{project}/datasets/{dataset_id}
version_description

string

คำอธิบายของข้อมูลใหม่ที่กำลังนำเข้า
ฟิลด์ Union data_source รายละเอียดเกี่ยวกับแหล่งที่มาของข้อมูลสำหรับชุดข้อมูล data_source ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
local_file_source

LocalFileSource

แหล่งที่มาของไฟล์ในเครื่องสำหรับชุดข้อมูลสำหรับการนำเข้าครั้งเดียว
gcs_source

GcsSource

แหล่งที่มาของไฟล์ Google Cloud Storage สำหรับชุดข้อมูลสำหรับการนำเข้าแบบครั้งเดียว

ImportDatasetResponse

การตอบกลับจากการนำเข้าชุดข้อมูลเวอร์ชันใหม่

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของเวอร์ชันชุดข้อมูลที่สร้างขึ้นใหม่ projects/{project}/datasets/{dataset_id}@{version_id}

ListDatasetErrorsRequest

ขอแสดงข้อผิดพลาดโดยละเอียดที่อยู่ในชุดข้อมูล

ช่อง
name

string

ต้องระบุ รูปแบบ: projects/${project}/datasets/{dataset_id}
page_size

int32

จำนวนเวอร์ชันสูงสุดที่จะแสดงต่อหน้า ค่าเริ่มต้นคือ 10
page_token

string

โทเค็นหน้าเว็บที่ได้รับจากการเรียก ListDatasetErrors ก่อนหน้า ระบุข้อมูลนี้เพื่อดึงข้อมูลหน้าถัดไป

ListDatasetErrorsResponse

การตอบกลับของ ListDatasetErrors แสดงผลสตริงที่ซ้ำกันสำหรับข้อความแสดงข้อผิดพลาด

ช่อง
error_messages[]

string

ข้อผิดพลาดที่อยู่ในชุดข้อมูล
next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อดึงข้อมูลหน้าถัดไปได้ หากละเว้นช่องนี้ จะไม่มีหน้าถัดไป

ListDatasetsRequest

ขอแสดงชุดข้อมูลสำหรับโปรเจ็กต์

ช่อง
parent

string

ต้องระบุ ชื่อของโปรเจ็กต์ที่จะแสดงชุดข้อมูลทั้งหมด
page_size

int32

จำนวนเวอร์ชันสูงสุดที่จะแสดงต่อหน้า หากไม่ระบุ (หรือเป็น 0) ระบบจะแสดงผลชุดข้อมูลทั้งหมด
page_token

string

โทเค็นหน้าเว็บที่ได้รับจากการเรียก ListDatasets ก่อนหน้า ระบุข้อมูลนี้เพื่อดึงข้อมูลหน้าถัดไป

ListDatasetsResponse

การตอบกลับเพื่อแสดงรายการชุดข้อมูลสำหรับโปรเจ็กต์

ช่อง
datasets[]

Dataset

ชุดข้อมูลทั้งหมดสำหรับโปรเจ็กต์
next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อดึงข้อมูลหน้าถัดไปได้ หากละเว้นช่องนี้ จะไม่มีหน้าถัดไป

LocalFileSource

รายละเอียดเกี่ยวกับแหล่งข้อมูลเมื่อเป็นไฟล์ในเครื่อง

ช่อง
filename

string

ชื่อไฟล์และนามสกุลของไฟล์ที่อัปโหลด
file_format

FileFormat

รูปแบบของไฟล์ที่กำลังอัปโหลด

สถานะ

สถานะของเวอร์ชันชุดข้อมูล

ช่อง
state

State

การแจงนับสถานะ
error_message

string

ข้อความแสดงข้อผิดพลาดที่ระบุสาเหตุของความล้มเหลว โดยจะว่างเปล่าหากชุดข้อมูลไม่ได้อยู่ในสถานะล้มเหลว

รัฐ

รายการสถานะของเวอร์ชันชุดข้อมูล หากมีการแก้ไขค่าที่นี่ โปรดพิจารณาอัปเดตวิธีการยูทิลิตีสถานะ

Enum
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

รายการฟิลด์ที่จะอัปเดต รองรับค่า "*" สำหรับการแทนที่ทั้งหมด

การใช้งาน

การใช้งานจะระบุตำแหน่งที่ต้องการใช้ข้อมูลเพื่อแจ้งวิธีประมวลผลข้อมูล

Enum
USAGE_UNSPECIFIED ไม่ได้ตั้งค่าการใช้งานชุดข้อมูลนี้
USAGE_DATA_DRIVEN_STYLING ระบบจะใช้ชุดข้อมูลนี้สำหรับการจัดรูปแบบตามข้อมูล