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

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

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

integer

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

object (VehicleLocation)

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

boolean

פלט בלבד. מציינת אם אפשר להצמיד את lastLocation של הרכב לקטע המסלול הנוכחי. הערך הוא 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)

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

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

שיטות

create

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

get

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

update

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