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 עבור כל הנסיעות הפעילות שהוקצו לרכב.

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

object (TrafficPolylineData)

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

string (Timestamp format)

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

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

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

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

חותמת זמן בפורמט "זולו" 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 יוחזר רק אם הוא מעודכן.

חותמת זמן בפורמט "זולו" 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.

טיפוסים בני מנייה (enums)
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)

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

קטגוריה

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

טיפוסים בני מנייה (enums)
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

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

סגנון

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

טיפוסים בני מנייה (enums)
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())

טיפוסים בני מנייה (enums)
UNKNOWN_LOCATION_POWER_SAVE_MODE מיקום לא מוגדר PowerSaveMode
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

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

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

PowerSource

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

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

שיטות

create

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

get

 מחזירה רכב ממנוע Fleet.

list

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

searchFuzzed
(deprecated)

 הוצאה משימוש: יש להשתמש במקום זאת ב-SearchVehicles.

update

 כתיבה של נתוני רכב מעודכנים אל Fleet Engine.

updateAttributes

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

updateLocation
(deprecated)

 הוצא משימוש: יש להשתמש בשיטה UpdateVehicle במקום זאת.