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} است.

vehicle State

enum ( VehicleState )

وضعیت وسیله نقلیه

supported Trip Types[]

enum ( TripType )

انواع سفرهای پشتیبانی شده توسط این وسیله نقلیه.

current Trips[]

string

فقط خروجی فهرست tripId برای سفرهایی که در حال حاضر به این وسیله نقلیه اختصاص داده شده است.

last Location

object ( VehicleLocation )

آخرین مکان گزارش شده خودرو

maximum Capacity

integer

تعداد کل سوارانی که این وسیله نقلیه می تواند حمل کند. درایور در این مقدار در نظر گرفته نمی شود. این مقدار باید بزرگتر یا مساوی یک باشد.

attributes[]

object ( VehicleAttribute )

فهرست ویژگی های خودرو یک وسیله نقلیه می تواند حداکثر 100 ویژگی داشته باشد و هر ویژگی باید یک کلید منحصر به فرد داشته باشد.

vehicle Type

object ( VehicleType )

مورد نیاز. نوع این وسیله نقلیه می تواند برای فیلتر کردن وسایل نقلیه در vehicles.search . همچنین بر ETA و محاسبات مسیر تأثیر می گذارد.

license Plate

object ( LicensePlate )

اطلاعات پلاک خودرو

route[]
(deprecated)

object ( TerminalLocation )

منسوخ شده: به جای آن از Vehicle.waypoints استفاده کنید.

current Route Segment

string

چند خطی که مسیری را که برنامه راننده قصد دارد تا ایستگاه بین راهی بعدی طی کند را مشخص می کند. این لیست همچنین در Trip.current_route_segment برای تمام سفرهای فعال اختصاص داده شده به وسیله نقلیه بازگردانده می شود.

توجه: این قسمت فقط برای استفاده توسط Driver SDK در نظر گرفته شده است. رمزگشایی هنوز پشتیبانی نمی شود.

current Route Segment Traffic

object ( TrafficPolylineData )

فقط ورودی Fleet Engine از این اطلاعات برای بهبود اشتراک گذاری سفر استفاده می کند. توجه: این قسمت فقط برای استفاده توسط Driver SDK در نظر گرفته شده است.

current Route Segment Version

string ( Timestamp format)

فقط خروجی زمانی که currentRouteSegment تنظیم شد. می‌تواند توسط مشتری ذخیره شود و در درخواست‌های vehicles.get بعدی ارسال شود تا از مسیرهای برگشتی که تغییر نکرده‌اند جلوگیری شود.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

current Route Segment End Point

object ( TripWaypoint )

نقطه ای که در آن currentRouteSegment به پایان می رسد. این می تواند توسط رانندگان در تماس vehicles.update روز رسانی یا به عنوان یک ایستگاه کامل سفر، یک نقطه بین LatLng یا به عنوان آخرین LatLng از قطعه currentRouteSegment ارائه شود. Fleet Engine پس از آن تمام تلاش خود را برای درون یابی به یک نقطه بین راه واقعی انجام می دهد اگر به طور کامل مشخص نشده باشد. این فیلد در تماس‌های vehicles.update نادیده گرفته می‌شود مگر اینکه currentRouteSegment نیز مشخص شده باشد.

remaining Distance Meters

integer

مسافت رانندگی باقیمانده برای قطعه currentRouteSegment . این مقدار همچنین در Trip.remaining_distance_meters برای تمام سفرهای فعال اختصاص داده شده به وسیله نقلیه برگردانده می شود. اگر فیلد currentRouteSegment خالی باشد، مقدار مشخص نشده است.

eta To First Waypoint

string ( Timestamp format)

ETA به اولین ورودی در قسمت waypoints . اگر قسمت waypoints خالی باشد یا قسمت Vehicle.current_route_segment خالی باشد، مقدار مشخص نیست.

هنگام به‌روزرسانی یک وسیله نقلیه، remainingTimeSeconds بر etaToFirstWaypoint در همان درخواست اولویت دارد.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

remaining Time Seconds

integer

فقط ورودی زمان باقیمانده رانندگی برای قطعه currentRouteSegment . اگر قسمت waypoints خالی باشد یا قسمت Vehicle.current_route_segment خالی باشد، مقدار مشخص نیست. اگر همه طرفین از یک ساعت استفاده می کنند، این مقدار باید با etaToFirstWaypoint - current_time مطابقت داشته باشد.

هنگام به‌روزرسانی یک وسیله نقلیه، remainingTimeSeconds بر etaToFirstWaypoint در همان درخواست اولویت دارد.

waypoints[]

object ( TripWaypoint )

نقاط بین راهی که به این وسیله نقلیه اختصاص داده شده است.

waypoints Version

string ( Timestamp format)

فقط خروجی آخرین باری که قسمت waypoints به روز شد. کلاینت‌ها باید این مقدار را کش کرده و آن را در GetVehicleRequest ارسال کنند تا مطمئن شوند که قسمت waypoints تنها در صورت به‌روزرسانی بازگردانده می‌شود.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

back To Back Enabled

boolean

نشان می دهد که آیا راننده سفرهای پشت سر هم را می پذیرد یا خیر. اگر true ، می‌تواند vehicles.search را شامل شود، حتی اگر در حال حاضر به یک سفر اختصاص داده شده باشد. مقدار پیش فرض false است.

navigation Status

enum ( NavigationStatus )

وضعیت ناوبری خودرو

device Settings

object ( DeviceSettings )

فقط ورودی اطلاعات مربوط به تنظیمات در دستگاه تلفن همراه که توسط راننده استفاده می شود.

حالت خودرو

وضعیت یک 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 . مقدار مشخصه می تواند از نوع رشته ای، bool یا دوگانه باشد. vehicle_attribute_value تنها می تواند یکی از موارد زیر باشد:
string Value

string

مقدار مشخصه را رشته ای تایپ کرد.

توجه: این همان فیلد value است که در نهایت منسوخ خواهد شد. برای ایجاد یا به‌روزرسانی روش‌ها، می‌توان از هر یک از فیلدها استفاده کرد، اما اکیداً توصیه می‌شود از stringValue استفاده کنید. اگر هم stringValue و هم value تنظیم شده باشند، باید یکسان باشند وگرنه خطایی ایجاد می شود. هر دو فیلد در پاسخ ها پر شده اند.

bool Value

boolean

مقدار مشخصه تایپ شده بولی.

number Value

number

مقدار مشخصه را دوبار تایپ کرد.

نوع وسیله نقلیه

نوع وسیله نقلیه.

نمایندگی JSON 
{
  "category": enum (Category)
}
فیلدها
category

enum ( Category )

دسته بندی نوع خودرو

دسته بندی

دسته بندی نوع خودرو

Enums
UNKNOWN پیش‌فرض، برای دسته‌های خودروهای نامشخص یا ناشناخته استفاده می‌شود.
AUTO یک ماشین
TAXI هر وسیله نقلیه ای که به عنوان یک تاکسی عمل می کند (معمولا دارای مجوز یا دارای مقررات قانونی).
TRUCK به طور کلی، وسیله نقلیه ای با ظرفیت ذخیره سازی زیاد.
TWO_WHEELER یک موتور سیکلت، موتور سیکلت یا وسایل نقلیه دو چرخ دیگر
BICYCLE حمل و نقل با نیروی انسانی
PEDESTRIAN یک وسیله نقلیه انسانی که معمولاً در حال راه رفتن یا دویدن است و در مسیرهای عابر پیاده حرکت می کند.

پلاک مجوز

اطلاعات پلاک خودرو برای جلوگیری از ذخیره اطلاعات قابل شناسایی شخصی، فقط حداقل اطلاعات مربوط به پلاک به عنوان بخشی از نهاد ذخیره می شود.

نمایندگی JSON 
{
  "countryCode": string,
  "lastCharacter": string
}
فیلدها
country Code

string

مورد نیاز. کد کشور/منطقه CLDR. به عنوان مثال، US برای ایالات متحده، یا IN برای هند.

last Character

string

آخرین رقم پلاک یا "-1" برای نشان دادن هیچ عددی در پلاک وجود ندارد.

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

TrafficPolylineData

شرایط ترافیکی در مسیر مورد انتظار خودرو.

نمایندگی JSON 
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
فیلدها
traffic Rendering

object ( VisualTrafficReportPolylineRendering )

یک نمایش چند خطی از سرعت ترافیک برای همه مناطق در طول یک مسیر از سفر مشتری.

VisualTrafficReportPolylineRendering

توضیح می دهد که چگونه مشتریان باید یک قسمت از چند خط را در طول مسیر رنگ آمیزی کنند.

نمایندگی JSON 
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
فیلدها
road Stretch[]

object ( RoadStretch )

اختیاری. امتداد جاده ای که باید در امتداد چند خط ارائه شود. کشش ها تضمین می شوند که همپوشانی ندارند و لزوماً کل مسیر را در بر نمی گیرند.

در صورت عدم وجود کشش جاده به سبک، مشتری باید پیش فرض را برای مسیر اعمال کند.

RoadStretch

یک جاده که باید رندر شود.

نمایندگی JSON 
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
فیلدها
style

enum ( Style )

مورد نیاز. سبکی که باید اعمال شود.

offset Meters

integer

مورد نیاز. سبک باید بین [offsetMeters, offsetMeters + lengthMeters) اعمال شود.

length Meters

integer

مورد نیاز. طول مسیری که در آن استایل اعمال می شود.

سبک

سبک ترافیک، نشان دهنده سرعت ترافیک.

Enums
STYLE_UNSPECIFIED هیچ سبکی انتخاب نشده است.
SLOWER_TRAFFIC تردد در حال کند شدن است.
TRAFFIC_JAM ترافیک است.

تنظیمات دستگاه

اطلاعات مربوط به تنظیمات مختلف در دستگاه تلفن همراه.

نمایندگی JSON 
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
فیلدها
location Power Save Mode

enum ( LocationPowerSaveMode )

وقتی «بهینه‌سازی باتری» روشن است، ویژگی‌های مکان چگونه تنظیم می‌شوند تا در دستگاه رفتار کنند.

is Power Save Mode

boolean

اینکه آیا دستگاه در حال حاضر در حالت صرفه جویی در مصرف انرژی است یا خیر.

is Interactive

boolean

اینکه آیا دستگاه در حالت تعاملی است.

battery Info

object ( BatteryInfo )

اطلاعاتی در مورد وضعیت باتری

LocationPowerSaveMode

وقتی ویژگی «بهینه‌سازی باتری» دستگاه‌ها روشن است، ویژگی‌های مکان چگونه پیکربندی می‌شوند تا در دستگاه تلفن همراه رفتار کنند. ( https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode() )

Enums
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 موقعیت مکانی خاموش نخواهد شد، اما LocationManager تمام درخواست‌های ارائه‌دهندگان را هنگامی که دستگاه غیرتعاملی باشد، کنترل می‌کند.

BatteryInfo

اطلاعاتی در مورد باتری دستگاه

نمایندگی JSON 
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
فیلدها
battery Status

enum ( BatteryStatus )

وضعیت باتری، پر بودن یا شارژ شدن و غیره

power Source

enum ( PowerSource )

وضعیت منبع تغذیه باتری

battery Percentage

number

درصد باتری فعلی [0-100].

وضعیت باتری

وضعیت باتری، پر بودن یا شارژ شدن و غیره

Enums
UNKNOWN_BATTERY_STATUS وضعیت باتری نامشخص است.
BATTERY_STATUS_CHARGING باتری در حال شارژ شدن است.
BATTERY_STATUS_DISCHARGING باتری در حال تخلیه است.
BATTERY_STATUS_FULL باتری پر است.
BATTERY_STATUS_NOT_CHARGING باتری شارژ نمی شود.
BATTERY_STATUS_POWER_LOW شارژ باتری کم است.

منبع تغذیه

نوع شارژر مورد استفاده برای شارژ باتری

Enums
UNKNOWN_POWER_SOURCE منبع تغذیه ناشناخته
POWER_SOURCE_AC منبع تغذیه یک شارژر AC است.
POWER_SOURCE_USB منبع تغذیه یک پورت USB است.
POWER_SOURCE_WIRELESS منبع تغذیه بی سیم است.
POWER_SOURCE_UNPLUGGED باتری قطع شده است.

روش ها

create

 یک وسیله نقلیه جدید مرتبط با یک ارائه‌دهنده سهم یا تحویل بر اساس تقاضا را نشان می‌دهد.

get

 یک وسیله نقلیه را از موتور ناوگان برمی‌گرداند.

list

 فهرست صفحه بندی شده ای از وسایل نقلیه مرتبط با ارائه دهنده ای را برمی گرداند که با گزینه های درخواست مطابقت دارند.
فهرستی از وسایل نقلیه را برمی‌گرداند که با گزینه‌های درخواست مطابقت دارند.

update

 داده های به روز شده خودرو را در Fleet Engine می نویسد.

update Attributes

 تا حدی ویژگی های خودرو را به روز می کند.