REST Resource: providers.vehicles

{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    object (VehicleLocation)
  },
  "maximumCapacity": integer,
  "attributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "vehicleType": {
    object (VehicleType)
  },
  "licensePlate": {
    object (LicensePlate)
  },
  "route": [
    {
      object (TerminalLocation)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentTraffic": {
    object (TrafficPolylineData)
  },
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeSeconds": integer,
  "waypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "waypointsVersion": string,
  "backToBackEnabled": boolean,
  "navigationStatus": enum (NavigationStatus),
  "deviceSettings": {
    object (DeviceSettings)
  }
}

string

פלט בלבד. השם הייחודי של הרכב הזה. הפורמט הוא providers/{provider}/vehicles/{vehicle}.

enum (VehicleState)

מצב הרכב.

enum (TripType)

סוגי הנסיעות שנתמכים ברכב הזה.

string

פלט בלבד. רשימת אפליקציות של tripId לנסיעות שמוקצות כרגע לרכב הזה.

object (VehicleLocation)

המיקום המדווח האחרון של הרכב.

integer

מספר הנוסעים הכולל ברכב הזה. הנהג לא נלקח בחשבון בערך הזה. הערך הזה חייב להיות גדול מ-1 או שווה לו.

object (VehicleAttribute)

רשימת מאפיינים של רכבים. לרכב אפשר להזין עד 100 מאפיינים, ולכל מאפיין צריך להיות מפתח ייחודי.

object (VehicleType)

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

object (LicensePlate)

פרטי לוחית הרישוי של הרכב.

object (TerminalLocation)

הוצא משימוש: במקומו צריך להשתמש ברכיב Vehicle.waypoints.

string

הקו הפוליגוני שמציין את המסלול שאפליקציית הנהג מתכוונת לעבור אל ציון הדרך הבא. הרשימה הזו מוחזרת גם בTrip.current_route_segment לכל הנסיעות הפעילות שמוקצות לרכב.

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

object (TrafficPolylineData)

קלט בלבד. המידע הזה משמש את Fleet Engine כדי לשפר את שיתוף הנסיעות. הערה: השדה הזה מיועד לשימוש רק ב-Driver SDK.

string (Timestamp format)

פלט בלבד. השעה שבה הוגדר currentRouteSegment. הלקוח יכול לאחסן אותו ולהעביר אותו בבקשות עתידיות של vehicles.get כדי למנוע מסלולים חוזרים שלא השתנו.

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

object (TripWaypoint)

ציון הדרך שבו מסתיים currentRouteSegment. מידע זה יכול להיות מסופק על ידי נהגים בשיחות vehicles.update כציון דרך מלא, כציון דרך LatLng או כLatLng האחרון בcurrentRouteSegment. לאחר מכן, Fleet Engine יעשה כמיטב יכולתו כדי לבצע אינטרפולציה לציון דרך ממשית, אם הוא לא צוין במלואו. המערכת מתעלמת מהשדה הזה בקריאות vehicles.update, אלא אם צוין גם currentRouteSegment.

integer

מרחק הנסיעה שנותר עבור currentRouteSegment. הערך הזה מוחזר גם בTrip.remaining_distance_meters לכל הנסיעות הפעילות שמוקצות לרכב. הערך לא צוין אם השדה currentRouteSegment ריק.

string (Timestamp format)

זמן ההגעה המשוער לרשומה הראשונה בשדה waypoints. הערך לא צוין אם השדה waypoints ריק או שהשדה Vehicle.current_route_segment ריק.

כשמעדכנים רכב, remainingTimeSeconds מקבל עדיפות על פני etaToFirstWaypoint באותה בקשה.

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

integer

קלט בלבד. זמן הנסיעה שנותר ל-currentRouteSegment. הערך לא צוין אם השדה waypoints ריק או שהשדה Vehicle.current_route_segment ריק. הערך צריך להתאים ל-etaToFirstWaypoint - current_time אם כל הצדדים משתמשים באותו שעון.

כשמעדכנים רכב, remainingTimeSeconds מקבל עדיפות על פני etaToFirstWaypoint באותה בקשה.

object (TripWaypoint)

שאר נקודות הדרך שהוקצו לרכב הזה.

string (Timestamp format)

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

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

boolean

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

enum (NavigationStatus)

סטטוס הניווט של הרכב.

object (DeviceSettings)

קלט בלבד. מידע על ההגדרות במכשיר הנייד שמשמש את הנהג/ת.

{
  "key": string,
  "value": string,

  // Union field vehicle_attribute_value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field vehicle_attribute_value.
}

string

המַּפתח של המאפיין. אסור שמפתחות יכילו את תו הנקודתיים (:).

string

ערך המאפיין.

string

ערך מאפיין שהוקלד במחרוזת.

הערה: השדה הזה זהה לשדה value, שבסופו של דבר יצא משימוש. כדי ליצור או לעדכן שיטות, אפשר להשתמש בכל אחד מהשדות, אבל מומלץ מאוד להשתמש ב-stringValue. אם גם stringValue וגם value מוגדרים, הם צריכים להיות זהים אחרת תישלח הודעת שגיאה. שני השדות מאוכלסים בתשובות.

boolean

ערך מאפיין בוליאני.

number

ערך המאפיין הוקלד פעמיים.

{
  "category": enum (Category)
}

enum (Category)

קטגוריית סוג הרכב

{
  "countryCode": string,
  "lastCharacter": string
}

string

חובה. קוד המדינה או האזור במאגר CLDR. לדוגמה, US לארצות הברית או IN להודו.

string

הספרה האחרונה של לוחית הרישוי או '1-' כדי לציין שלוחית הרישוי לא מכילה ערך מספרי.

• "ABC 1234" -> '4'
• 'AB 123 CD' -> '3'
• 'ABCDEF' -> " -1"

{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}

object (VisualTrafficReportPolylineRendering)

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

{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}

object (RoadStretch)

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

בהיעדר קטע דרך לסגנון, הלקוח צריך להחיל את ברירת המחדל של המסלול.

{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}

enum (Style)

חובה. הסגנון שצריך להחיל.

integer

חובה. צריך להחיל את הסגנון בין התאריכים [offsetMeters, offsetMeters + lengthMeters).

integer

חובה. אורך הנתיב שבו צריך להחיל את הסגנון.

{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}

enum (LocationPowerSaveMode)

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

boolean

האם המכשיר נמצא כרגע במצב חיסכון בסוללה.

boolean

האם המכשיר במצב אינטראקטיבי.

object (BatteryInfo)

מידע על מצב הסוללה.

{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}

enum (BatteryStatus)

סטטוס הסוללה, אם היא מלאה או נטענת וכו'.

enum (PowerSource)

הסטטוס של מקור החשמל.

number

אחוז הסוללה הנוכחי [0-100].