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

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

string (Timestamp format)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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 וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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. 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)

מתי הפסקת הפעילות התרחשה.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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 וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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 ערך ברירת המחדל. כדי לשמור על תאימות לאחור, תצוגת ה-SDK תהיה ברירת המחדל של ה-API. כדי להבטיח יציבות ותמיכה, מומלץ ללקוחות לבחור TripView שאינו SDK.
SDK כולל שדות שעשויים להיות בלתי מובנים או לא נתמכים באמצעות ספריות שזמינות לציבור.
JOURNEY_SHARING_V1S השדות של הנסיעה מאוכלסים בתרחיש לדוגמה של שיתוף המסלול. התצוגה הזו מיועדת לתקשורת בין שרתים.

Methods

create

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

delete

 מחיקה של נסיעה אחת.

get

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

update

 עדכון נתוני הנסיעה.