REST Resource: providers.vehicles

משאב: רכב

מטא-נתונים של הרכב.

ייצוג ב-JSON 
{
  "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)
  }
}
שדות
name

string

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

enum (VehicleState)

מצב הרכב.
supportedTripTypes[]

enum (TripType)

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

string

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

object (VehicleLocation)

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

integer

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

object (VehicleAttribute)

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

object (VehicleType)

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

object (LicensePlate)

פרטי לוחית הרישוי של הרכב.
route[]
(deprecated)

object (TerminalLocation)

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

string

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

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

object (TrafficPolylineData)

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

string (Timestamp format)

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

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

object (TripWaypoint)

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

integer

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

string (Timestamp format)

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

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

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

integer

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

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

object (TripWaypoint)

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

string (Timestamp format)

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

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

boolean

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

enum (NavigationStatus)

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

object (DeviceSettings)

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

VehicleState

המצב של Vehicle.

טיפוסים בני מנייה (enum)
UNKNOWN_VEHICLE_STATE ברירת מחדל, משמשת למצבים של רכבים שלא צוינו או לא מזוהים.
OFFLINE הרכב לא מקבל נסיעות חדשות. הערה: יכול להיות שהרכב ימשיך לפעול במצב הזה במהלך נסיעה שהוקצתה לו.
ONLINE ניתן לאשר נסיעות חדשות ברכב.

VehicleAttribute

מתאר מאפיין רכב כצמד מפתח/ערך. אורך המחרוזת 'key:value' לא יכול לחרוג מ-256 תווים.

ייצוג ב-JSON 
{
  "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.
}
שדות
key

string

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

string

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

string

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

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

boolean

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

number

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

VehicleType

סוג הרכב.

ייצוג JSON 
{
  "category": enum (Category)
}
שדות
category

enum (Category)

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

קטגוריה

קטגוריות של סוגי כלי רכב

טיפוסים בני מנייה (enum)
UNKNOWN ברירת מחדל, משמשת לקטגוריות רכב שלא צוינו או לא מזוהות.
AUTO מכונית.
TAXI כל כלי רכב שמשמש כמונית (בדרך כלל ברישיון או בפיקוח).
TRUCK באופן כללי, רכב עם קיבולת אחסון גדולה.
TWO_WHEELER אופנוע, טוסטוס או כלי רכב דו-גלגלי אחר
BICYCLE תחבורה מונעת על ידי אדם.
PEDESTRIAN כלי רכב בני אדם, שבדרך כלל הולכים או רצים, נעשים לאורך שבילים להולכי רגל.

LicensePlate

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

ייצוג JSON 
{
  "countryCode": string,
  "lastCharacter": string
}
שדות
countryCode

string

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

string

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

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

TrafficPolylineData

מצב התנועה לאורך מסלול הרכב הצפוי.

ייצוג JSON 
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
שדות
trafficRendering

object (VisualTrafficReportPolylineRendering)

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

VisualTrafficReportPolylineRendering

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

ייצוג JSON 
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
שדות
roadStretch[]

object (RoadStretch)

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

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

RoadStretch

מקטע אחד של כביש שצריך להציג.

ייצוג JSON 
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
שדות
style

enum (Style)

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

integer

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

integer

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

סגנון

סגנון התנועה, שמציין את מהירות התנועה.

טיפוסים בני מנייה (enum)
STYLE_UNSPECIFIED לא נבחר סגנון.
SLOWER_TRAFFIC התנועה מאטה.
TRAFFIC_JAM יש פקק תנועה.

DeviceSettings

מידע על הגדרות שונות במכשיר הנייד.

ייצוג ב-JSON 
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
שדות
locationPowerSaveMode

enum (LocationPowerSaveMode)

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

boolean

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

boolean

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

object (BatteryInfo)

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

LocationPowerSaveMode

איך תכונות המיקום מוגדרות כך שיפעלו בנייד כשהתכונה 'חיסכון בסוללה' מופעלת במכשיר. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

טיפוסים בני מנייה (enum)
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode לא מוגדר
LOCATION_MODE_NO_CHANGE מצב חיסכון בסוללה לא אמור להשפיע על ספקי המיקום, או שהוא מושבת.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF יש להשבית את ספק המיקום המבוסס על GPS כשמצב חיסכון בסוללה מופעל והמכשיר לא אינטראקטיבי.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF צריך להשבית את כל ספקי המיקום כשמצב החיסכון בסוללה מופעל והמכשיר לא אינטראקטיבי.
LOCATION_MODE_FOREGROUND_ONLY כל ספקי המיקום ימשיכו להיות זמינים, אבל יש לספק תיקוני מיקום רק לאפליקציות שפועלות בחזית.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF התכונה 'מיקום' לא תושבת, אבל מנהל המיקום ויסות את כל הבקשות לספקים כשהמכשיר לא אינטראקטיבי.

BatteryInfo

מידע על הסוללה של המכשיר.

ייצוג ב-JSON 
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
שדות
batteryStatus

enum (BatteryStatus)

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

enum (PowerSource)

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

number

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

BatteryStatus

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

טיפוסים בני מנייה (enum)
UNKNOWN_BATTERY_STATUS מצב הסוללה לא ידוע.
BATTERY_STATUS_CHARGING הסוללה נטענת.
BATTERY_STATUS_DISCHARGING הסוללה פורקת.
BATTERY_STATUS_FULL הסוללה מלאה.
BATTERY_STATUS_NOT_CHARGING הסוללה לא נטענת.
BATTERY_STATUS_POWER_LOW הסוללה חלשה.

PowerSource

סוג המטען שמשמש לטעינת הסוללה.

טיפוסים בני מנייה (enum)
UNKNOWN_POWER_SOURCE מקור החשמל לא ידוע.
POWER_SOURCE_AC מקור החשמל הוא מטען לחשמל.
POWER_SOURCE_USB מקור החשמל הוא יציאת USB.
POWER_SOURCE_WIRELESS מקור הכוח הוא אלחוטי.
POWER_SOURCE_UNPLUGGED הסוללה לא מחוברת.

שיטות

create

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

get

 מחזירה רכב מ-Fleet Engine.

list

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

update

 כתיבת נתוני הרכב המעודכנים ב-Fleet Engine.

updateAttributes

 עדכון חלקי של מאפייני הרכב.