REST Resource: selection.v1.projects.selectedRoutes

ทรัพยากร: SelectedRoute

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a request:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError)
}
ช่อง
name

string

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

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

string

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

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

ออบเจ็กต์ที่มีรายการคู่ "key": value เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
ปัจจุบันรองรับเฉพาะ DynamicRoute ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในคำขอ
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 ตามที่ระบุโดยชื่อ