Package google.maps.mapsplatformdatasets.v1alpha

ดัชนี

MapsPlatformDatasetsV1Alpha

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

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

คำขอสร้างชุดข้อมูล Maps

ช่อง
parent

string

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

Dataset

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

ชุดข้อมูล

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

ช่อง
name

string

ชื่อทรัพยากร, โปรเจ็กต์/{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

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

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

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

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

ImportDatasetRequest

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

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากร, โปรเจ็กต์/{project}/datasets/{dataset_id}
version_description

string

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

LocalFileSource

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

GcsSource

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

ImportDatasetResponse

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

ช่อง
name

string

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

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

enum สถานะสำหรับสถานะ
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

ต้องระบุ ชุดข้อมูลที่จะอัปเดต ชื่อชุดข้อมูลจะใช้เพื่อระบุชุดข้อมูลที่จะอัปเดต ชื่อจะมีรูปแบบดังนี้: project/{project}/datasets/{dataset_id}
update_mask

FieldMask

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

การใช้งาน

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

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