REST Resource: selection.v1.projects.selectedRoutes

แหล่งข้อมูล: SelectedRoute

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

การแสดง JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "state": enum (State),
  "routeAttributes": {
    string: string,
    ...
  },

  // Union field route_type can be only one of the following:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of list of possible types for union field route_type.
  "validationError": enum (ValidationError)
}
ช่อง
name

string

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

รูปแบบ: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

ไม่บังคับ ชื่อที่แสดงของเส้นทาง ช่องนี้เป็นช่องที่ไม่บังคับที่ลูกค้าใช้ได้ ไม่จำเป็นต้องไม่ซ้ำกัน
createTime

string (Timestamp format)

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

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
state

enum (State)

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

map (key: string, value: string)

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

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่าง: { "name": "wrench", "mass": "1.3kg", "count": "3" }
ฟิลด์ Union route_type ปัจจุบันรองรับเฉพาะ DynamicRoute route_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
dynamicRoute

object (DynamicRoute)

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

enum (ValidationError)

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

DynamicRoute

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

การแสดง JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
ช่อง
origin

object (LatLng)

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

object (LatLng)

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

object (LatLng)

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

LatLng

ออบเจ็กต์ที่แสดงถึงคู่ละติจูด/ลองจิจูด แสดงเป็นคู่ของค่า Double เพื่อแสดงละติจูดและลองจิจูดเป็นองศา ออบเจ็กต์นี้ต้องเป็นไปตามมาตรฐาน WGS84 เว้นแต่จะระบุไว้เป็นอย่างอื่น ค่าต้องอยู่ในช่วงที่แปลงเป็นมาตรฐานแล้ว

การแสดง JSON 
{
  "latitude": number,
  "longitude": number
}
ช่อง
latitude

number

ละติจูดเป็นองศา ต้องอยู่ในช่วง [-90.0, +90.0]
longitude

number

ลองจิจูดเป็นองศา ต้องอยู่ในช่วง [-180.0, +180.0]

สถานะ

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

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 เส้นทางมีการใช้งานถนนต่ำ (มีผู้ผ่านเส้นทางน้อยมาก)

เมธอด

batchCreate

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

batchDelete

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

batchUpdate

 อัปเดตแหล่งข้อมูล SelectedRoute หลายรายการตามที่ระบุโดยชื่อ

create

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

delete

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

get

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

list

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

patch

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