REST Resource: providers.trips

แหล่งข้อมูล: การเดินทาง

ข้อมูลเมตาของการเดินทาง

การแสดง JSON
{
  "name": string,
  "vehicleId": string,
  "tripStatus": enum (TripStatus),
  "tripType": enum (TripType),
  "pickupPoint": {
    object (TerminalLocation)
  },
  "actualPickupPoint": {
    object (StopLocation)
  },
  "actualPickupArrivalPoint": {
    object (StopLocation)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocation)
    }
  ],
  "intermediateDestinationsVersion": string,
  "intermediateDestinationIndex": integer,
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocation)
    }
  ],
  "actualIntermediateDestinations": [
    {
      object (StopLocation)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "actualDropoffPoint": {
    object (StopLocation)
  },
  "dropoffTime": string,
  "remainingWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "vehicleWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "route": [
    {
      object (LatLng)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolyline)
  },
  "currentRouteSegmentTrafficVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "remainingWaypointsVersion": string,
  "remainingWaypointsRouteVersion": string,
  "numberOfPassengers": integer,
  "lastLocation": {
    object (VehicleLocation)
  },
  "lastLocationSnappable": boolean,
  "view": enum (TripView)
}
ช่อง
name

string

เอาต์พุตเท่านั้น ในรูปแบบ "providers/{provider}/trips/{trip}"

vehicleId

string

รหัสของยานพาหนะที่เดินทางครั้งนี้

tripStatus

enum (TripStatus)

สถานะปัจจุบันของการเดินทาง

tripType

enum (TripType)

ประเภทการเดินทาง

pickupPoint

object (TerminalLocation)

สถานที่ที่ลูกค้าระบุว่าจะให้ไปรับ

actualPickupPoint

object (StopLocation)

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

actualPickupArrivalPoint

object (StopLocation)

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

pickupTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาในอนาคตโดยประมาณที่จะไปรับผู้โดยสาร หรือเวลาจริงที่ไปรับผู้โดยสาร

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

intermediateDestinations[]

object (TerminalLocation)

จุดแวะพักระหว่างทางตามคำขอการเดินทาง (นอกเหนือจากจุดรับและจุดส่ง) ฟีเจอร์นี้ยังไม่รองรับการเดินทางที่แชร์ในเบื้องต้น

intermediateDestinationsVersion

string (Timestamp format)

ระบุเวลาที่แก้ไข intermediateDestinations ครั้งล่าสุด เซิร์ฟเวอร์ควรแคชค่านี้และส่งค่าใน UpdateTripRequest เมื่ออัปเดต intermediateDestinationIndex เพื่อให้แน่ใจว่า intermediateDestinations จะไม่เปลี่ยนแปลง

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

intermediateDestinationIndex

integer

เมื่อ TripStatus เป็น ENROUTE_TO_INTERMEDIATE_DESTINATION ซึ่งเป็นตัวเลขระหว่าง [0..N-1] ที่ระบุปลายทางระหว่างทางที่ยานพาหนะจะข้ามไป เมื่อ TripStatus เป็น ARRIVED_AT_INTERMEDIATE_DESTINATION จะเป็นตัวเลขระหว่าง [0..N-1] ที่ระบุปลายทางกลางที่ยานพาหนะอยู่ ผู้ให้บริการเป็นผู้กำหนดค่านี้ หากไม่มี intermediateDestinations ระบบจะไม่สนใจฟิลด์นี้

actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

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

actualIntermediateDestinations[]

object (StopLocation)

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

dropoffPoint

object (TerminalLocation)

สถานที่ที่ลูกค้าระบุว่าจะให้ส่งสินค้า

actualDropoffPoint

object (StopLocation)

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

dropoffTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาในอนาคตโดยประมาณที่จะส่งผู้โดยสารที่จุดหมายปลายทาง หรือเวลาจริงที่ส่งผู้โดยสาร

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

remainingWaypoints[]

object (TripWaypoint)

เอาต์พุตเท่านั้น เส้นทางแบบเต็มจากตำแหน่งปัจจุบันไปยังจุดส่งผู้โดยสาร ซึ่งเส้นทางนี้อาจมีจุดแวะพักจากการเดินทางอื่นๆ

vehicleWaypoints[]

object (TripWaypoint)

ช่องนี้รองรับการจัดลําดับจุดแวะพักของการเดินทางด้วยตนเอง ซึ่งจะมีจุดแวะพักที่เหลือทั้งหมดสำหรับยานพาหนะที่มอบหมาย รวมถึงจุดรับและจุดส่งของสำหรับการเดินทางนี้ หากยังไม่ได้กำหนดการเดินทางให้กับยานพาหนะ Fleet Engine จะไม่สนใจช่องนี้ เซิร์ฟเวอร์จะป้อนข้อมูลในช่องนี้เฉพาะในการโทร trips.update และ trips.create เท่านั้น จะไม่ป้อนข้อมูลในการโทร trips.get ด้วยเหตุผลด้านความเป็นส่วนตัว

route[]

object (LatLng)

เอาต์พุตเท่านั้น เส้นทางที่คาดไว้สำหรับการเดินทางครั้งนี้ไปยังรายการแรกใน remainingWaypoints โปรดทราบว่าจุดแวะแรกอาจมาจากการเดินทางอื่น

currentRouteSegment

string

เอาต์พุตเท่านั้น เส้นทางที่เข้ารหัสไปยังจุดถัดไป

หมายเหตุ: ช่องนี้มีไว้สําหรับ Driver SDK และ Consumer SDK เท่านั้น ยังไม่รองรับการถอดรหัส

currentRouteSegmentVersion

string (Timestamp format)

เอาต์พุตเท่านั้น ระบุเวลาที่แก้ไขเส้นทางครั้งล่าสุด

หมายเหตุ: ช่องนี้มีไว้สําหรับ Driver SDK และ Consumer SDK เท่านั้น

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

currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

เอาต์พุตเท่านั้น ระบุสภาพการจราจรตาม currentRouteSegment เมื่อข้อมูลพร้อมใช้งาน

หมายเหตุ: ช่องนี้มีไว้สําหรับ Driver SDK และ Consumer SDK เท่านั้น

currentRouteSegmentTrafficVersion

string (Timestamp format)

เอาต์พุตเท่านั้น ระบุเวลาที่แก้ไข currentRouteSegmentTraffic ครั้งล่าสุด

หมายเหตุ: ช่องนี้มีไว้สําหรับ Driver SDK และ Consumer SDK เท่านั้น

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

currentRouteSegmentEndPoint

object (TripWaypoint)

เอาต์พุตเท่านั้น จุดสังเกตที่ currentRouteSegment สิ้นสุด

remainingDistanceMeters

integer

เอาต์พุตเท่านั้น ระยะทางที่เหลือในการขับรถในช่อง currentRouteSegment ระบบจะไม่ระบุค่าหากไม่ได้กำหนดการเดินทางให้กับยานพาหนะ หรือการเดินทางเสร็จสมบูรณ์หรือถูกยกเลิก

etaToFirstWaypoint

string (Timestamp format)

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

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

remainingTimeToFirstWaypoint

string (Duration format)

เอาต์พุตเท่านั้น ระยะเวลานับจากเวลาที่ระบบแสดงข้อมูลการเดินทางไปจนถึงเวลาที่ระบุใน Trip.eta_to_first_waypoint ระบบจะไม่ระบุค่าหากไม่ได้กำหนดการเดินทางให้กับยานพาหนะ หรือการเดินทางไม่ทำงาน (เสร็จสมบูรณ์หรือถูกยกเลิก)

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย s เช่น "3.5s"

remainingWaypointsVersion

string (Timestamp format)

เอาต์พุตเท่านั้น ระบุเวลาที่ remainingWaypoints มีการเปลี่ยนแปลงครั้งล่าสุด (มีการเพิ่ม นําออก หรือเปลี่ยนแปลงจุดสังเกต)

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

remainingWaypointsRouteVersion

string (Timestamp format)

เอาต์พุตเท่านั้น ระบุเวลาที่แก้ไข remainingWaypoints.path_to_waypoint และ remainingWaypoints.traffic_to_waypoint ครั้งล่าสุด แอปไคลเอ็นต์ควรแคชค่านี้และส่งค่าใน GetTripRequest เพื่อให้ระบบแสดงเส้นทางและการเข้าชมสําหรับ remainingWaypoints เฉพาะในกรณีที่มีการอัปเดตเท่านั้น

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

numberOfPassengers

integer

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

lastLocation

object (VehicleLocation)

เอาต์พุตเท่านั้น ระบุตำแหน่งล่าสุดที่รายงานของยานพาหนะตามเส้นทาง

lastLocationSnappable

boolean

เอาต์พุตเท่านั้น บ่งบอกว่าสามารถจับคู่ lastLocation ของยานพาหนะกับ currentRouteSegment ได้หรือไม่ เท็จหากไม่มี lastLocation หรือ currentRouteSegment ซึ่งคำนวณโดย Fleet Engine ระบบจะละเว้นการอัปเดตจากไคลเอ็นต์

view

enum (TripView)

ชุดย่อยของช่องการเดินทางที่สร้างขึ้นและวิธีตีความ

TripStatus

สถานะของการเดินทางที่บ่งบอกความคืบหน้า

Enum
UNKNOWN_TRIP_STATUS ค่าเริ่มต้นที่ใช้สำหรับสถานะการเดินทางที่ไม่ระบุหรือไม่รู้จัก
NEW การเดินทางที่สร้างขึ้นใหม่
ENROUTE_TO_PICKUP คนขับกำลังเดินทางไปยังจุดรับสินค้า
ARRIVED_AT_PICKUP คนขับมาถึงจุดรับแล้ว
ARRIVED_AT_INTERMEDIATE_DESTINATION คนขับมาถึงจุดหมายระหว่างทางและกำลังรอคนขับ
ENROUTE_TO_INTERMEDIATE_DESTINATION คนขับกำลังเดินทางไปยังจุดหมายระหว่างทาง (ไม่ใช่จุดส่งผู้โดยสาร)
ENROUTE_TO_DROPOFF คนขับได้รับผู้โดยสารแล้วและกำลังเดินทางไปยังจุดหมายถัดไป
COMPLETE ผู้โดยสารได้รับการส่งแล้วและการเดินทางเสร็จสมบูรณ์
CANCELED การเดินทางถูกยกเลิกก่อนที่คนขับ ผู้ขับขี่ หรือผู้ให้บริการร่วมเดินทางจะเข้าไปรับ

StopLocation

ตำแหน่งจริงที่หยุด (รับ/ส่ง)

การแสดง JSON
{
  "point": {
    object (LatLng)
  },
  "timestamp": string,
  "stopTime": string
}
ช่อง
point

object (LatLng)

ต้องระบุ ระบุตำแหน่งจริง

timestamp

string (Timestamp format)

ระบุเวลาที่หยุด

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

stopTime
(deprecated)

string (Timestamp format)

อินพุตเท่านั้น เลิกใช้งานแล้ว ใช้ช่องการประทับเวลา

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

TripView

ตัวเลือกสำหรับชุดช่องการเดินทางต่างๆ ในการตอบกลับ trips.get ดูบริบทได้ที่ AIP-157 และอาจมีการเพิ่มมุมมองเพิ่มเติม

Enum
TRIP_VIEW_UNSPECIFIED ค่าเริ่มต้น API จะแสดงเป็นมุมมอง SDK โดยค่าเริ่มต้นเพื่อความเข้ากันได้แบบย้อนหลัง เราขอแนะนำให้ลูกค้าเลือก TripView อื่นที่ไม่ใช่ SDK เพื่อให้มั่นใจว่าระบบจะเสถียรและได้รับการสนับสนุน
SDK มีฟิลด์ที่อาจตีความไม่ได้หรือไม่รองรับโดยใช้ไลบรารีที่เผยแพร่ต่อสาธารณะ
JOURNEY_SHARING_V1S ระบบจะป้อนข้อมูลในฟิลด์การเดินทางสำหรับ Use Case การแชร์เส้นทาง มุมมองนี้มีไว้สําหรับการสื่อสารแบบเซิร์ฟเวอร์ต่อเซิร์ฟเวอร์

เมธอด

create

สร้างการเดินทางใน Fleet Engine และแสดงการเดินทางใหม่

get

ดูข้อมูลเกี่ยวกับการเดินทาง 1 ครั้ง
ดูการเดินทางทั้งหมดของยานพาหนะหนึ่งๆ

update

อัปเดตข้อมูลการเดินทาง