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)

פלט בלבד. השעה המשוערת שבה הנוסעים ייאספו או השעה שבה הם נאספו בפועל.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
currentRouteSegmentEndPoint

object (TripWaypoint)

פלט בלבד. נקודת הציון שבה מסתיים currentRouteSegment.
remainingDistanceMeters

integer

פלט בלבד. מרחק הנסיעה שנותר בשדה currentRouteSegment. הערך לא צוין אם הנסיעה לא הוקצתה לרכב, או אם הנסיעה הושלמה או בוטלה.
etaToFirstWaypoint

string (Timestamp format)

פלט בלבד. זמן ההגעה המשוער לנקודת הציון הבאה (הרשומה הראשונה בשדה remainingWaypoints). הערך לא מצוין אם הנסיעה לא הוקצה לרכב, או אם הנסיעה לא פעילה (הושלמה או בוטלה).

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
remainingTimeToFirstWaypoint

string (Duration format)

פלט בלבד. משך הזמן שממנו מוחזרים נתוני הנסיעה לזמן ב-Trip.eta_to_first_waypoint. הערך לא צוין אם הנסיעה לא הוקצתה לרכב, או אם הנסיעה לא פעילה (הושלמה או בוטלה).

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".
remainingWaypointsVersion

string (Timestamp format)

פלט בלבד. מציין את הפעם האחרונה שבה remainingWaypoints השתנה (נקודת ציון נוספה, הוסרה או שונתה).

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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 יוחזרו רק אם הם יעודכנו.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
numberOfPassengers

integer

קבוע. מספר הנוסעים בנסיעה הזו, לא כולל הנהג. כדי להחזיר רכב בתגובה vehicles.search, צריכה להיות קיבולת זמינה של רכב.
lastLocation

object (VehicleLocation)

פלט בלבד. מציין את המיקום האחרון המדווח של הרכב לאורך המסלול.
lastLocationSnappable

boolean

פלט בלבד. מציין אם אפשר להצמיד את lastLocation של הרכב ל-currentRouteSegment. False אם 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)

מציין מתי הופסקה העצירה.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
stopTime
(deprecated)

string (Timestamp format)

קלט בלבד. הוצא משימוש. משתמשים בשדה חותמת הזמן.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

TripView

בורר לקבוצות שונות של שדות נסיעה בתגובה מסוג trips.get. למידע נוסף, ראו AIP-157. סביר להניח שיתווספו עוד תצוגות.

טיפוסים בני מנייה (enum)
TRIP_VIEW_UNSPECIFIED ערך ברירת המחדל. כדי לשמור על תאימות לאחור, תצוגת ה-SDK תהיה ברירת המחדל של ה-API. כדי להבטיח יציבות ותמיכה, מומלץ ללקוחות לבחור TripView שאינו SDK.
SDK כולל שדות שעשויים להיות בלתי מובנים או לא נתמכים באמצעות ספריות שזמינות לציבור.
JOURNEY_SHARING_V1S השדות של הנסיעה מאוכלסים בתרחיש לדוגמה של שיתוף המסלול. התצוגה הזו מיועדת לתקשורת בין שרתים.

שיטות

create

 יצירת נסיעה ב-Fleet Engine והחזרת הנסיעה החדשה.

get

 קבלת מידע על נסיעה אחת.
הצגת כל הנסיעות ברכב ספציפי.

update

 נתוני הנסיעה מתעדכנים.