REST Resource: providers.deliveryVehicles

منبع: DeliveryVehicle

پیام DeliveryVehicle . وسیله نقلیه تحویل محموله ها را از انبار به محل تحویل و از محل تحویل به انبار حمل می کند. در برخی موارد، وسایل نقلیه تحویل نیز محموله ها را مستقیماً از محل وانت به محل تحویل حمل می کنند.

توجه: API های gRPC و REST از قراردادهای نامگذاری فیلدهای مختلف استفاده می کنند. برای مثال، فیلد DeliveryVehicle.current_route_segment در gRPC API و قسمت DeliveryVehicle.currentRouteSegment در REST API به همین فیلد اشاره دارد.

نمایندگی JSON 
{
  "name": string,
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "navigationStatus": enum (DeliveryVehicleNavigationStatus),
  "currentRouteSegment": string,
  "currentRouteSegmentEndPoint": {
    object (LatLng)
  },
  "remainingDistanceMeters": integer,
  "remainingDuration": string,
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "attributes": [
    {
      object (DeliveryVehicleAttribute)
    }
  ],
  "type": enum (DeliveryVehicleType)
}
فیلدها
name

string

نام منحصر به فرد این وسیله نقلیه تحویلی. قالب providers/{provider}/deliveryVehicles/{vehicle} است.

lastLocation

object ( DeliveryVehicleLocation )

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

navigationStatus

enum ( DeliveryVehicleNavigationStatus )

وضعیت ناوبری وسیله نقلیه تحویلی.

currentRouteSegment

string ( bytes format)

چند خط کدگذاری شده مسیری را که ناوبری توصیه می‌کند تا ایستگاه بعدی انتخاب کنید را مشخص می‌کند. برنامه درایور شما این را با رسیدن به ایستگاه یا عبور از آن و هنگامی که مسیریابی تغییر مسیر می دهد، به روز می کند. این LatLng ها در Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) یا Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) ​​برای همه Tasks های فعال اختصاص داده شده به وسیله نقلیه بازگردانده می شوند.

چند مورد وجود دارد که ممکن است از این فیلد برای پر کردن Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) یا Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) ​​استفاده نشود:

  • نقطه پایانی currentRouteSegment با DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) یا DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST) ​​مطابقت ندارد.

  • برنامه درایور اخیراً مکان خود را به‌روزرسانی نکرده است، بنابراین آخرین مقدار به‌روزرسانی‌شده برای این فیلد ممکن است قدیمی باشد.

  • برنامه راننده اخیراً مکان خود را به‌روزرسانی کرده است، اما currentRouteSegment قدیمی است و به توقف قبلی وسیله نقلیه اشاره می‌کند.

در این موارد، Fleet Engine این فیلد را با مسیری از VehicleStop اخیراً تصویب شده تا VehicleStop آینده پر می‌کند تا اطمینان حاصل کند که مصرف‌کننده این فیلد بهترین اطلاعات موجود در مسیر فعلی خودروی تحویل را دارد.

رشته ای با کد base64.

currentRouteSegmentEndPoint

object ( LatLng )

مکانی که در آن currentRouteSegment به پایان می رسد. این در حال حاضر توسط برنامه راننده پر نشده است، اما می توانید آن را در تماس های deliveryVehicles.patch ارائه کنید. این یا LatLng از توقف خودروی آینده است، یا آخرین LatLng از currentRouteSegment است. سپس Fleet Engine تمام تلاش خود را برای درون یابی به یک VehicleStop واقعی انجام می دهد.

اگر قسمت currentRouteSegment خالی باشد، این فیلد در تماس های deliveryVehicles.patch نادیده گرفته می شود.

remainingDistanceMeters

integer

مسافت رانندگی باقیمانده برای currentRouteSegment . برنامه Driver معمولاً این فیلد را فراهم می کند، اما برخی شرایط وجود دارد که در آن Fleet Engine مقدار ارسال شده توسط برنامه را لغو می کند. برای اطلاعات بیشتر، به DeliveryVehicle.current_route_segment مراجعه کنید. این فیلد در Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) یا Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) ​​برای همه Task فعال اختصاص داده شده به وسیله نقلیه تحویل داده شده است.

اگر قسمت currentRouteSegment خالی باشد، Fleet Engine این فیلد را در UpdateDeliveryVehicleRequest نادیده می گیرد.

remainingDuration

string ( Duration format)

زمان باقیمانده رانندگی برای currentRouteSegment . برنامه Driver معمولاً این فیلد را فراهم می کند، اما برخی شرایط وجود دارد که در آن Fleet Engine مقدار ارسال شده توسط برنامه را لغو می کند. برای اطلاعات بیشتر، به DeliveryVehicle.current_route_segment مراجعه کنید. این فیلد در Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) یا Task.remainingVehicleJourneySegments[0].drivingDuration (REST) ​​برای همه وظایف فعال اختصاص داده شده به وسیله نقلیه تحویل داده شده است.

اگر قسمت currentRouteSegment خالی باشد، Fleet Engine این فیلد را در UpdateDeliveryVehicleRequest نادیده می گیرد.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' ختم می شود. مثال: "3.5s" .

remainingVehicleJourneySegments[]

object ( VehicleJourneySegment )

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

attributes[]

object ( DeliveryVehicleAttribute )

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

type

enum ( DeliveryVehicleType )

نوع این وسیله نقلیه تحویلی. اگر تنظیم نشود، به طور پیش‌فرض روی AUTO خواهد بود.

DeliveryVehicleNavigationStatus

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

Enums
UNKNOWN_NAVIGATION_STATUS وضعیت ناوبری نامشخص
NO_GUIDANCE ناوبری برنامه Driver در حالت FREE_NAV است.
ENROUTE_TO_DESTINATION پیمایش گام به گام در دسترس است و پیمایش برنامه Driver وارد حالت GUIDED_NAV شده است.
OFF_ROUTE خودرو از مسیر پیشنهادی خارج شده است.
ARRIVED_AT_DESTINATION وسیله نقلیه تقریباً 50 متر از مقصد فاصله دارد.

DeliveryVehicleAttribute

یک ویژگی وسیله نقلیه را به عنوان یک جفت کلید-مقدار توصیف می کند. طول رشته "key:value" نمی تواند از 256 کاراکتر تجاوز کند.

نمایندگی JSON 
{
  "key": string,
  "value": string,

  // Union field delivery_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
  // delivery_vehicle_attribute_value.
}
فیلدها
key

string

کلید ویژگی

value

string

مقدار ویژگی

فیلد اتحادیه delivery_vehicle_attribute_value . مقدار مشخصه می تواند از نوع رشته ای، bool یا دوگانه باشد. delivery_vehicle_attribute_value تنها می تواند یکی از موارد زیر باشد:
stringValue

string

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

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

boolValue

boolean

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

numberValue

number

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

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

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

Enums
DELIVERY_VEHICLE_TYPE_UNSPECIFIED مقدار استفاده نشده است
AUTO یک ماشین
TWO_WHEELER یک موتور سیکلت، موتور سیکلت یا وسایل نقلیه دو چرخ دیگر
BICYCLE حمل و نقل با نیروی انسانی
PEDESTRIAN یک وسیله نقلیه انسانی که معمولاً در حال راه رفتن یا دویدن است و در مسیرهای عابر پیاده حرکت می کند.

روش ها

create

 یک DeliveryVehicle جدید ایجاد و برمی گرداند.

get

 نمونه DeliveryVehicle مشخص شده را برمی گرداند.

list

 همه DeliveryVehicle هایی را دریافت می کند که معیارهای فیلتر مشخص شده را دارند.

patch

 داده های به روز DeliveryVehicle را در Fleet Engine می نویسد و Tasks به DeliveryVehicle اختصاص می دهد.