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 עתידיות כדי למנוע החזרת מסלולים שלא השתנו.

הפורמט הזה משתמש ב-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. הנהגים יכולים לספק את המידע הזה בקריאות 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 באותה בקשה.

הפורמט הזה משתמש ב-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".
remainingTimeSeconds

integer

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

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

object (TripWaypoint)

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

string (Timestamp format)

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

הפורמט הזה משתמש ב-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".
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. הערך של המאפיין יכול להיות מסוג מחרוזת, bool או double. הערך של vehicle_attribute_value יכול להיות רק אחת מהאפשרויות הבאות:
stringValue

string

ערך מאפיין מסוג מחרוזת.

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

boolean

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

number

ערך מאפיין מסוג double.

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 Undefined 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 המיקום לא יושבת, אבל LocationManager יאט את כל הבקשות לספקים כשהמכשיר לא אינטראקטיבי.

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 מקור הכוח הוא מטען AC.
POWER_SOURCE_USB מקור החשמל הוא יציאת USB.
POWER_SOURCE_WIRELESS מקור הכוח הוא אלחוטי.
POWER_SOURCE_UNPLUGGED הסוללה לא מחוברת.

Methods

create

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

get

 הפונקציה מחזירה רכב מ-Fleet Engine.

list

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

update

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

updateAttributes

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