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

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

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

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

list

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

update

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

updateAttributes

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