Package google.maps.mapsplatformdatasets.v1

ดัชนี

MapsPlatformDatasets

คำจำกัดความของบริการสำหรับ 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
FetchDatasetErrors

rpc FetchDatasetErrors(FetchDatasetErrorsRequest) returns (FetchDatasetErrorsResponse)

ได้รับข้อผิดพลาดทั้งหมดของชุดข้อมูล

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

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

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

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

  • mapsplatformdatasets.datasets.get

ดูข้อมูลเพิ่มเติมได้ในเอกสารประกอบ 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

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

ช่อง
parent

string

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

Dataset

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

ชุดข้อมูล

การนำเสนอทรัพยากรชุดข้อมูล

ช่อง
name

string

ชื่อทรัพยากร รูปแบบ: projects/{project}/datasets/{dataset_id}
display_name

string

ชื่อที่มนุษย์อ่านได้ ซึ่งแสดงใน UI ของคอนโซล

ต้องไม่ซ้ำกันภายในโปรเจ็กต์
description

string

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

string

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

Usage

Use Case ที่ระบุสำหรับชุดข้อมูลนี้
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 สำหรับชุดข้อมูลสำหรับการอัปโหลด 1 ครั้ง

DeleteDatasetRequest

คำขอลบชุดข้อมูล

ช่อง
name

string

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

DownloadDatasetRequest

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

ช่อง
name

string

ชื่อทรัพยากรของชุดข้อมูลที่จะดึงข้อมูล รูปแบบ: projects/{project}/datasets/{dataset_id}

DownloadDatasetResponse

ออบเจ็กต์การตอบสนองของ DownloadDataset

FetchDatasetErrorsRequest

คำขอแสดงรายการข้อผิดพลาดโดยละเอียดที่เป็นของชุดข้อมูล

ช่อง
dataset

string

ต้องระบุ ชื่อชุดข้อมูลที่จะแสดงข้อผิดพลาดทั้งหมด รูปแบบ: projects/{project}/datasets/{dataset_id}
page_size

int32

จำนวนข้อผิดพลาดสูงสุดที่จะแสดงใน 1 หน้า

ค่าสูงสุดคือ 500 ค่าที่มากกว่า 500 จะถูกจำกัดไว้ที่ 500

หากไม่ระบุ ระบบจะแสดงข้อผิดพลาดสูงสุด 50 รายการ
page_token

string

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

FetchDatasetErrorsResponse

ออบเจ็กต์การตอบสนองของ FetchDatasetErrors

ช่อง
next_page_token

string

โทเค็นที่ส่งเป็น page_token เพื่อเรียกข้อมูลหน้าถัดไปได้

หากเว้นช่องนี้ไว้ จะไม่มีหน้าลำดับต่อมา
errors[]

Status

ข้อผิดพลาดที่เกี่ยวข้องกับชุดข้อมูล

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}

สามารถดึงข้อมูลเวอร์ชันพิเศษบางเวอร์ชันโดยต่อท้าย "@" และแท็ก รูปแบบ: projects/{project}/datasets/{dataset_id}@{tag}

แท็ก "ใช้งานอยู่": จะรวมข้อมูลของเวอร์ชันที่เสร็จสมบูรณ์ล่าสุด และ NOT_FOUND หากชุดข้อมูลไม่มีข้อมูล

ImportDatasetRequest

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

ช่อง
name

string

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

string

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

LocalFileSource

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

GcsSource

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

ImportDatasetResponse

ออบเจ็กต์การตอบสนองของ ImportDataset

ช่อง
name

string

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

ListDatasetsRequest

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

ช่อง
parent

string

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

int32

จำนวนชุดข้อมูลสูงสุดที่จะแสดงผลต่อ 1 หน้า

หากไม่ระบุ (หรือ 0) ระบบจะแสดงผลชุดข้อมูลทั้งหมด
page_token

string

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

string

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

โปรดทราบว่าเมื่อมีการระบุการใส่เลขหน้าด้วย การกรองบางอย่างอาจเกิดขึ้นหลังจากการใส่เลขหน้า ซึ่งอาจทำให้คำตอบมีชุดข้อมูลน้อยกว่าขนาดหน้าแม้ว่าจะไม่ใช่หน้าสุดท้ายก็ตาม

แท็ก "ใช้งานอยู่": ชุดข้อมูลแต่ละรายการในการตอบกลับจะรวมข้อมูลของเวอร์ชันที่เสร็จสมบูรณ์ล่าสุด และระบบจะข้ามชุดข้อมูลนี้หากไม่มีชุดข้อมูล

ListDatasetsResponse

ออบเจ็กต์การตอบสนองของ ListDatasets

ช่อง
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

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

FieldMask

รายการช่องที่จะอัปเดต

ค่า "*" ใช้เพื่อแทนที่โดยสมบูรณ์ (ค่าเริ่มต้น)

การใช้งาน

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

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