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)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและทศนิยมสูงสุด 9 หลัก ตัวอย่างเช่น "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

intermediateDestinations[]

object (TerminalLocation)

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

intermediateDestinationsVersion

string (Timestamp format)

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

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

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)

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

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่างเช่น "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

remainingWaypoints[]

object (TripWaypoint)

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

vehicleWaypoints[]

object (TripWaypoint)

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

route[]

object (LatLng)

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

currentRouteSegment

string

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

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

currentRouteSegmentVersion

string (Timestamp format)

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

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

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

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

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

currentRouteSegmentTrafficVersion

string (Timestamp format)

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

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

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

currentRouteSegmentEndPoint

object (TripWaypoint)

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

remainingDistanceMeters

integer

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

etaToFirstWaypoint

string (Timestamp format)

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

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

remainingTimeToFirstWaypoint

string (Duration format)

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

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

remainingWaypointsVersion

string (Timestamp format)

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

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

remainingWaypointsRouteVersion

string (Timestamp format)

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

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

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)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและทศนิยมสูงสุด 9 หลัก ตัวอย่างเช่น "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

stopTime
(deprecated)

string (Timestamp format)

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

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

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

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