Package google.maps.roads.selection.v1

ดัชนี

RoadsSelection

คำจำกัดความของบริการสำหรับ Roads Selection API

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

สร้าง SelectedRoutes หลายรายการและเริ่มกำหนดเวลาเพื่อดึงข้อมูลแคชสำหรับแต่ละเส้นทางเป็นระยะๆ

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

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

  • https://www.googleapis.com/auth/cloud-platform
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

สร้าง SelectedRoute และเริ่มกำหนดเวลาเพื่อดึงข้อมูลแคชสำหรับเส้นทางเป็นระยะๆ

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

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

  • https://www.googleapis.com/auth/cloud-platform
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

ลบ SelectedRoute ที่ระบุสำหรับโปรเจ็กต์ที่ระบุ

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

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

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

รับ SelectedRoute ตามที่ระบุโดยชื่อ

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

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

  • https://www.googleapis.com/auth/cloud-platform
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

แสดงรายการ SelectedRoutes ทั้งหมดสำหรับโปรเจ็กต์ที่ระบุพร้อมการแบ่งหน้า

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

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

  • https://www.googleapis.com/auth/cloud-platform

BatchCreateSelectedRoutesRequest

ขอสร้าง SelectedRoute หลายรายการ

ช่อง
parent

string

ไม่บังคับ ทรัพยากรโปรเจ็กต์ที่เส้นทางที่เลือกทั้งหมดแชร์ รูปแบบ: projects/{project} หากตั้งค่านี้ไว้ ฟิลด์ระดับบนสุดในข้อความ CreateSelectedRouteRequest ต้องว่างเปล่าหรือตรงกับฟิลด์นี้
requests[]

CreateSelectedRouteRequest

ต้องระบุ ข้อความคำขอที่ระบุเส้นทางที่เลือกเพื่อสร้าง สร้างเส้นทางที่เลือกได้สูงสุด 1,000 เส้นทางในคราวเดียว

BatchCreateSelectedRoutesResponse

คำตอบจากการสร้าง SelectedRoute หลายรายการ

ช่อง
selected_routes[]

SelectedRoute

สร้าง SelectedRoutes แล้ว

CreateSelectedRouteRequest

ขอสร้าง SelectedRoute

ช่อง
parent

string

ต้องระบุ โปรเจ็กต์ที่จะสร้าง SelectedRoute รูปแบบ: projects/{project}
selected_route

SelectedRoute

ต้องระบุ SelectedRoute เพื่อสร้าง
selected_route_id

string

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

ค่านี้ควรมีอักขระ 4-63 ตัว และอักขระที่ใช้ได้คือ "a-z", "A-Z", "0-9" หรือ "-" หากไม่ได้ระบุหรือเว้นว่างไว้ ระบบจะสร้าง UUID หลังจากสร้างทรัพยากร

DeleteSelectedRouteRequest

คำขอให้ลบ SelectedRoute

ช่อง
name

string

ต้องระบุ ชื่อของ SelectedRoute ที่จะลบ รูปแบบ: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

คำขอรับ SelectedRoute

ช่อง
name

string

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

ListSelectedRoutesRequest

ขอให้แสดง SelectedRoute

ช่อง
parent

string

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

int32

ไม่บังคับ จำนวนผลลัพธ์ที่ควรแสดงสำหรับหน้าเว็บที่ระบุ หากไม่ได้ตั้งค่า ค่าเริ่มต้นจะเป็น 100 เมื่อระบุค่าเป็น 0 ระบบจะตั้งค่าเป็นค่าเริ่มต้น ค่าสูงสุดคือ 5,000 และค่าใดก็ตามที่สูงกว่า 5,000 จะตั้งค่าเป็น 5,000
page_token

string

ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้ ListSelectedRoutes ก่อนหน้า

ListSelectedRoutesResponse

คำตอบที่แสดงรายการ SelectedRoute

ช่อง
selected_routes[]

SelectedRoute

หน้าของ SelectedRoutes ที่จัดเก็บไว้ในโปรเจ็กต์ที่ระบุในคำขอ
next_page_token

string

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

SelectedRoute

SelectedRoute แสดงถึงเส้นทางที่เฉพาะเจาะจงซึ่งลูกค้าต้องการดึงข้อมูล (เช่น ระยะเวลา) เป็นระยะๆ สำหรับกรณีการใช้งานที่ทำสัญญาไว้

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของ SelectedRoute

รูปแบบ: projects/{project}/selectedRoutes/{selected_route}
display_name

string

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

Timestamp

เอาต์พุตเท่านั้น เวลาที่สร้างเส้นทางที่เลือกเป็นครั้งแรก
state

State

เอาต์พุตเท่านั้น สถานะของเส้นทางที่เลือก
route_attributes

map<string, string>

ไม่บังคับ แอตทริบิวต์ที่กำหนดเองสำหรับเส้นทางที่เลือก การเพิ่มเส้นทางจะช่วยให้กรอง / จัดกลุ่มเส้นทางได้เมื่อดึงข้อมูลเส้นทางย้อนหลังและแบบเรียลไทม์ ระบบรองรับแอตทริบิวต์สูงสุด 10 รายการต่อเส้นทาง คีย์และค่าแต่ละรายการควรเป็นสตริงที่ไม่ว่างเปล่าและมีอักขระได้สูงสุด 100 ตัว คีย์ต้องไม่ขึ้นต้นด้วย "goog"
ฟิลด์ Union route_type ปัจจุบันรองรับเฉพาะ DynamicRoute เท่านั้น route_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
dynamic_route

DynamicRoute

SelectedRoute เป็นเส้นทางแบบไดนามิก
validation_error

ValidationError

เอาต์พุตเท่านั้น ข้อผิดพลาดในการตรวจสอบเส้นทางที่เลือกเมื่อสถานะเป็น STATE_INVALID

DynamicRoute

ซึ่งแสดงถึงเส้นทางที่มีจุดอ้างอิง (ต้นทาง ปลายทาง และจุดกลาง) ระบบรับประกันว่าเส้นทางจริงจะผ่านจุดแวะพักทั้งหมด แต่เส้นทางอาจเปลี่ยนแปลงเป็นครั้งคราวเนื่องจากสภาพการจราจรที่แตกต่างกัน

ช่อง
origin

LatLng

ต้องระบุ สถานที่ต้นทางของเส้นทาง
destination

LatLng

ต้องระบุ ตำแหน่งสิ้นสุดของเส้นทาง
intermediates[]

LatLng

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

รัฐ

สถานะของเส้นทางที่เลือก

Enum
STATE_UNSPECIFIED ไม่ได้ตั้งค่าสถานะของเส้นทางนี้
STATE_SCHEDULING ระบบได้สร้างเส้นทางและกำลังกำหนดเวลาแล้ว
STATE_RUNNING สร้างเส้นทางแล้วและมีกำหนดการที่ใช้งานอยู่
STATE_DELETING มีการทำเครื่องหมายเส้นทางเพื่อลบแล้ว
STATE_VALIDATING เส้นทางอยู่ระหว่างการตรวจสอบ
STATE_INVALID เส้นทางไม่ถูกต้องตามเกณฑ์การตรวจสอบอย่างใดอย่างหนึ่ง

ValidationError

ข้อผิดพลาดในการตรวจสอบเส้นทางที่เลือก

Enum
VALIDATION_ERROR_UNSPECIFIED ไม่ได้ตั้งค่าข้อผิดพลาดในการตรวจสอบเส้นทางนี้
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION เส้นทางอยู่นอกเขตอำนาจศาลของโครงการ
VALIDATION_ERROR_LOW_ROAD_USAGE เส้นทางมีการใช้งานถนนต่ำ (มีผู้สัญจรผ่านน้อยมาก)