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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
intermediateDestinations[]

object (TerminalLocation)

אמצעי ההגעה לאתר עוצר לפי הסדר שבו תישלח בקשת הנסיעה (בנוסף לאיסוף ולהחזרה). בשלב הראשון, האפשרות הזו לא תיתמך בנסיעות משותפות.
intermediateDestinationsVersion

string (Timestamp format)

מציין את הפעם האחרונה שבה intermediateDestinations השתנה. השרת שלך צריך לשמור את הערך הזה במטמון ולהעביר אותו ב-UpdateTripRequest כשמעדכנים את intermediateDestinationIndex כדי להבטיח שה-intermediateDestinations לא ישתנה.

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

פלט בלבד. המסלול הצפוי לנסיעה זו אל הכניסה הראשונה ב-AdditionalWaypointspoints. שימו לב: ייתכן שציון הדרך הראשון שייך לנסיעה אחרת.
currentRouteSegment

string

פלט בלבד. נתיב מקודד לנקודת הדרך הבאה.

הערה: השדה הזה מיועד לשימוש ב-SDK של הנהג וב-SDK לצרכן בלבד. עדיין אין תמיכה בפענוח.
currentRouteSegmentVersion

string (Timestamp format)

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

הערה: השדה הזה מיועד לשימוש ב-SDK של הנהג וב-SDK לצרכן בלבד.

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

object (ConsumableTrafficPolyline)

פלט בלבד. מצב התנועה לאורך currentRouteSegment כשהם זמינים.

הערה: השדה הזה מיועד לשימוש ב-SDK של הנהג וב-SDK לצרכן בלבד.
currentRouteSegmentTrafficVersion

string (Timestamp format)

פלט בלבד. מציין את הפעם האחרונה שבה currentRouteSegmentTraffic השתנה.

הערה: השדה הזה מיועד לשימוש ב-SDK של הנהג וב-SDK לצרכן בלבד.

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

integer

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

object (VehicleLocation)

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

boolean

פלט בלבד. השדה הזה מציין אם אפשר להצמיד את lastLocation של הרכב ל-RouteSegment הנוכחי. הערך False אם lastLocation או currentRouteSegment לא קיימים. הוא מחושב על ידי Fleet Engine. המערכת תתעלם מעדכונים מלקוחות.
view

enum (TripView)

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

TripStatus

הסטטוס של נסיעה שמציין את ההתקדמות שלה.

טיפוסים בני מנייה (enums)
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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
stopTime
(deprecated)

string (Timestamp format)

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

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

TripView

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

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

שיטות

create

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

get

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

update

 מתבצע עדכון של נתוני הנסיעה.