Package maps.fleetengine.delivery.v1

فهرست مطالب

خدمات تحویل

خدمات تحویل آخرین مایل.

BatchCreateTasks

rpc BatchCreateTasks( BatchCreateTasksRequest ) returns ( BatchCreateTasksResponse )

دسته ای از اشیاء Task جدید را ایجاد و برمی گرداند.

CreateDeliveryVehicle

rpc CreateDeliveryVehicle( CreateDeliveryVehicleRequest ) returns ( DeliveryVehicle )

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

CreateTask

rpc CreateTask( CreateTaskRequest ) returns ( Task )

یک شیء Task جدید ایجاد و برمی گرداند.

GetDeliveryVehicle

rpc GetDeliveryVehicle( GetDeliveryVehicleRequest ) returns ( DeliveryVehicle )

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

GetTask

rpc GetTask( GetTaskRequest ) returns ( Task )

اطلاعات مربوط به یک Task را دریافت می کند.

GetTaskTrackingInfo

rpc GetTaskTrackingInfo( GetTaskTrackingInfoRequest ) returns ( TaskTrackingInfo )

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

ListDelivery Vehicles

rpc ListDeliveryVehicles( ListDeliveryVehiclesRequest ) returns ( ListDeliveryVehiclesResponse )

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

ListTasks

rpc ListTasks( ListTasksRequest ) returns ( ListTasksResponse )

تمام Task را که معیارهای فیلتر مشخص شده را برآورده می کنند، دریافت می کند.

Search Tasks

rpc SearchTasks( SearchTasksRequest ) returns ( SearchTasksResponse )

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

UpdateDelivery Vehicle

rpc UpdateDeliveryVehicle( UpdateDeliveryVehicleRequest ) returns ( DeliveryVehicle )

داده های به روز DeliveryVehicle را در Fleet Engine می نویسد و Tasks به DeliveryVehicle اختصاص می دهد. شما نمی توانید نام DeliveryVehicle را به روز کنید. با این حال، می‌توانید remaining_vehicle_journey_segments به‌روزرسانی کنید، اما باید حاوی تمام VehicleJourneySegment باشد که در حال حاضر در DeliveryVehicle وجود دارد. task_id ها از remaining_vehicle_journey_segments بازیابی می شوند و اگر هنوز تخصیص نیافته اند، Tasks مربوط به آن ها به DeliveryVehicle اختصاص داده می شود.

UpdateTask

rpc UpdateTask( UpdateTaskRequest ) returns ( Task )

داده های Task به روز می کند.

درخواست BatchCreateTasks

پیام درخواست BatchCreateTask .

زمینه های
header

DeliveryRequestHeader

اختیاری. هدر درخواست استاندارد Delivery API. توجه: اگر این فیلد را تنظیم کنید، فیلد هدر در پیام‌های CreateTaskRequest یا باید خالی باشد یا باید با این فیلد مطابقت داشته باشد.

parent

string

ضروری. منبع والد مشترک با همه وظایف. این مقدار باید در قالب providers/{provider} باشد. provider باید شناسه پروژه Google Cloud باشد. به عنوان مثال، sample-cloud-project . فیلد والد در پیام‌های CreateTaskRequest یا باید خالی باشد یا باید با این فیلد مطابقت داشته باشد.

requests[]

CreateTaskRequest

ضروری. پیام درخواستی که منابعی را برای ایجاد مشخص می کند. توجه: شما می توانید حداکثر 500 کار را در یک دسته ایجاد کنید.

BatchCreateTasksResponse

پیام پاسخ BatchCreateTask .

زمینه های
tasks[]

Task

وظایف ایجاد شده

CreateDeliveryVehicleRequest

پیام درخواست CreateDeliveryVehicle .

زمینه های
header

DeliveryRequestHeader

اختیاری. هدر درخواست استاندارد Delivery API.

parent

string

ضروری. باید در قالب providers/{provider} باشد. ارائه دهنده باید شناسه پروژه Google Cloud باشد. به عنوان مثال، sample-cloud-project .

delivery_vehicle_id

string

ضروری. شناسه خودروی تحویلی باید منحصر به فرد باشد و مشمول محدودیت‌های زیر باشد:

  • باید یک رشته یونیکد معتبر باشد.
  • حداکثر به طول 64 کاراکتر محدود شده است.
  • طبق فرم C عادی سازی یونیکد نرمال شده است.
  • ممکن است حاوی هیچ یک از کاراکترهای ASCII زیر نباشد: «/»، «:»، «؟»، «،»، یا «#».
delivery_vehicle

DeliveryVehicle

ضروری. موجودیت DeliveryVehicle برای ایجاد. هنگام ایجاد یک وسیله نقلیه تحویل جدید، می توانید فیلدهای اختیاری زیر را تنظیم کنید:

  • آخرین محل
  • ویژگی های

توجه: قسمت name DeliveryVehicle نادیده گرفته شده است. تمام فیلدهای دیگر DeliveryVehicle نباید تنظیم شوند. در غیر این صورت، یک خطا برگردانده می شود.

CreateTaskRequest

پیام درخواست CreateTask .

زمینه های
header

DeliveryRequestHeader

اختیاری. هدر درخواست استاندارد Delivery API.

parent

string

ضروری. باید در قالب providers/{provider} باشد. provider باید شناسه پروژه Google Cloud باشد. به عنوان مثال، sample-cloud-project .

task_id

string

ضروری. شناسه وظیفه باید منحصر به فرد باشد، اما نباید شناسه ردیابی محموله باشد. برای ذخیره شناسه رهگیری محموله، از قسمت tracking_id استفاده کنید. توجه داشته باشید که چندین کار می توانند یک tracking_id داشته باشند. شناسه های وظیفه مشمول محدودیت های زیر هستند:

  • باید یک رشته یونیکد معتبر باشد.
  • حداکثر به طول 64 کاراکتر محدود شده است.
  • طبق فرم C عادی سازی یونیکد نرمال شده است.
  • ممکن است حاوی هیچ یک از کاراکترهای ASCII زیر نباشد: «/»، «:»، «؟»، «،»، یا «#».
task

Task

ضروری. موجودیت وظیفه برای ایجاد. هنگام ایجاد یک Task، فیلدهای زیر مورد نیاز است:

  • type
  • state (باید روی OPEN تنظیم شود)
  • tracking_id (نباید برای کارهای UNAVAILABLE یا SCHEDULED_STOP تنظیم شود، اما برای همه انواع وظایف دیگر لازم است)
  • planned_location (اختیاری برای کارهای UNAVAILABLE )
  • task_duration

توجه: قسمت name Task نادیده گرفته می شود. تمام فیلدهای وظیفه دیگر نباید تنظیم شوند. در غیر این صورت، یک خطا برگردانده می شود.

DeliveryRequestHeader

یک RequestHeader شامل فیلدهای مشترک برای تمام درخواست های RPC تحویل است.

زمینه های
language_code

string

کد زبان BCP-47، مانند en-US یا sr-Latn. برای اطلاعات بیشتر، به http://www.unicode.org/reports/tr35/#Unicode_locale_identifier مراجعه کنید. اگر هیچ یک مشخص نشده باشد، پاسخ ممکن است به هر زبانی باشد و در صورت وجود چنین نامی، ترجیحاً انگلیسی باشد. مثال مقدار فیلد: en-US .

region_code

string

ضروری. کد منطقه CLDR منطقه ای که درخواست از آنجا منشاء می گیرد. مثال مقدار فیلد: US .

sdk_version

string

نسخه SDK تماس، در صورت وجود. قالب نسخه "major.minor.patch" است، به عنوان مثال: 1.1.2 .

os_version

string

نسخه سیستم عاملی که SDK فراخوانی روی آن اجرا می شود. نمونه های مقدار فیلد: 4.4.1 ، 12.1 .

device_model

string

مدل دستگاهی که SDK فراخوانی روی آن اجرا می‌شود. نمونه های مقدار فیلد: iPhone12,1 , SM-G920F .

sdk_type

SdkType

نوع SDK ارسال درخواست.

maps_sdk_version

string

نسخه MapSDK که در صورت وجود، SDK فراخوانی به آن بستگی دارد. قالب نسخه "major.minor.patch" است، به عنوان مثال: 5.2.1 .

nav_sdk_version

string

نسخه NavSDK که در صورت وجود، SDK فراخوانی به آن بستگی دارد. قالب نسخه "major.minor.patch" است، به عنوان مثال: 2.1.0 .

platform

Platform

پلتفرم SDK فراخوانی.

manufacturer

string

سازنده دستگاه Android از SDK تماس گیرنده، فقط برای SDK های Android قابل اجرا است. مثال مقدار فیلد: Samsung .

android_api_level

int32

سطح Android API SDK تماس، فقط برای Android SDK قابل اجرا است. مثال مقدار فیلد: 23 .

trace_id

string

شناسه اختیاری که می تواند برای اهداف ورود به سیستم به منظور شناسایی درخواست ارائه شود.

سکو

پلت فرم فراخوانی SDK.

Enums
PLATFORM_UNSPECIFIED مقدار پیش فرض اگر پلتفرم حذف شود از این مقدار استفاده می شود.
ANDROID درخواست از اندروید می آید.
IOS درخواست از iOS می آید.
WEB درخواست از وب می آید.

SdkType

انواع احتمالی SDK

Enums
SDK_TYPE_UNSPECIFIED مقدار پیش فرض اگر sdk_type حذف شده باشد از این مقدار استفاده می شود.
CONSUMER SDK فراخوانی Consumer است.
DRIVER SDK فراخوانی Driver است.
JAVASCRIPT SDK فراخوانی جاوا اسکریپت است.

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

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

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

زمینه های
name

string

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

last_location

DeliveryVehicleLocation

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

navigation_status

DeliveryVehicleNavigationStatus

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

current_route_segment

bytes

چند خط کدگذاری شده مسیری را که ناوبری توصیه می‌کند تا ایستگاه بعدی انتخاب کنید را مشخص می‌کند. برنامه درایور شما این را با رسیدن به ایستگاه یا عبور از آن و هنگامی که مسیریابی تغییر مسیر می دهد، به روز می کند. این 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) ​​استفاده نشود:

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

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

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

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

current_route_segment_end_point

LatLng

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

اگر قسمت current_route_segment خالی باشد، این فیلد در تماس‌های UpdateDeliveryVehicle نادیده گرفته می‌شود.

remaining_distance_meters

Int32Value

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

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

remaining_duration

Duration

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

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

remaining_vehicle_journey_segments[]

VehicleJourneySegment

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

attributes[]

DeliveryVehicleAttribute

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

type

DeliveryVehicleType

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

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

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

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

DeliveryVehicleAttribute

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

زمینه های
key

string

کلید ویژگی

value

string

مقدار ویژگی

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

string

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

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

bool_value

bool

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

number_value

double

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

DeliveryVehicleLocation

مکان، سرعت و حرکت وسیله نقلیه در یک نقطه از زمان.

زمینه های
location

LatLng

مکان وسیله نقلیه. وقتی به Fleet Engine ارسال می شود، مکان وسیله نقلیه یک مکان GPS است. وقتی آن را در یک پاسخ دریافت می‌کنید، مکان خودرو می‌تواند یک مکان GPS، یک مکان تکمیلی یا مکان تخمینی دیگری باشد. منبع در location_sensor مشخص شده است.

horizontal_accuracy
(deprecated)

DoubleValue

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

latlng_accuracy

DoubleValue

دقت location بر حسب متر به صورت شعاع.

heading

Int32Value

جهت حرکت وسیله نقلیه بر حسب درجه 0 نشان دهنده شمال است. محدوده معتبر [0,360) است.

bearing_accuracy
(deprecated)

DoubleValue

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

heading_accuracy

DoubleValue

دقت heading بر حسب درجه

altitude

DoubleValue

ارتفاع بر حسب متر بالاتر از WGS84.

vertical_accuracy
(deprecated)

DoubleValue

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

altitude_accuracy

DoubleValue

دقت altitude بر حسب متر

speed_kmph
(deprecated)

Int32Value

سرعت خودرو بر حسب کیلومتر در ساعت. منسوخ شده: به جای آن از speed استفاده کنید.

speed

DoubleValue

سرعت وسیله نقلیه بر حسب متر/ثانیه

speed_accuracy

DoubleValue

دقت speed بر حسب متر/ثانیه

update_time

Timestamp

زمانی که location توسط سنسور با توجه به ساعت سنسور گزارش شد.

server_time

Timestamp

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

location_sensor

DeliveryVehicleLocationSensor

ارائه دهنده داده های موقعیت مکانی (به عنوان مثال، GPS ).

is_road_snapped

BoolValue

اینکه آیا location به یک جاده متصل است یا خیر.

is_gps_sensor_enabled

BoolValue

فقط ورودی نشان می دهد که آیا سنسور GPS در دستگاه تلفن همراه فعال است یا خیر.

time_since_update

Int32Value

فقط ورودی زمان (بر حسب ثانیه) از زمانی که این مکان برای اولین بار به سرور ارسال شد. این برای اولین آپدیت صفر خواهد بود. اگر زمان ناشناخته باشد (مثلاً وقتی برنامه راه اندازی مجدد می شود)، این مقدار به صفر بازنشانی می شود.

num_stale_updates
(deprecated)

Int32Value

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

raw_location

LatLng

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

raw_location_time

Timestamp

مهر زمانی مرتبط با مکان خام.

raw_location_sensor

DeliveryVehicleLocationSensor

منبع مکان خام به طور پیش فرض برای GPS .

raw_location_accuracy

DoubleValue

دقت raw_location به صورت شعاع، بر حسب متر.

supplemental_location

LatLng

مکان تکمیلی ارائه شده توسط برنامه یکپارچه.

supplemental_location_time

Timestamp

مهر زمانی مرتبط با مکان تکمیلی.

supplemental_location_sensor

DeliveryVehicleLocationSensor

منبع مکان تکمیلی پیش‌فرض CUSTOMER_SUPPLIED_LOCATION است.

supplemental_location_accuracy

DoubleValue

دقت supplemental_location به صورت شعاع، بر حسب متر.

road_snapped
(deprecated)

bool

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

DeliveryVehicleLocationSensor

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

Enums
UNKNOWN_SENSOR سنسور نامشخص یا ناشناخته است.
GPS GPS یا کمکی GPS.
NETWORK GPS کمکی، شناسه برج سلولی، یا نقطه دسترسی WiFi.
PASSIVE شناسه برج سلولی یا نقطه دسترسی WiFi.
ROAD_SNAPPED_LOCATION_PROVIDER مکانی که توسط دستگاه تلفن همراه به عنوان محتمل ترین موقعیت جاده تعیین می شود.
CUSTOMER_SUPPLIED_LOCATION مکان ارائه شده توسط مشتری از یک منبع مستقل. به طور معمول، این مقدار برای مکانی استفاده می‌شود که از منابعی غیر از دستگاه تلفن همراهی که Driver SDK را اجرا می‌کند، ارائه می‌شود. اگر منبع اصلی با یکی از مقادیر enum دیگر توصیف شده است، از آن مقدار استفاده کنید. مکان‌هایی که CUSTOMER_SUPPLIED_LOCATION علامت‌گذاری شده‌اند معمولاً از طریق last_location.supplemental_location_sensor یک DeliveryVehicle ارائه می‌شوند.
FLEET_ENGINE_LOCATION مکانی که توسط Fleet Engine بر اساس سیگنال های موجود محاسبه می شود. فقط خروجی اگر این مقدار در یک درخواست دریافت شود رد می شود.
FUSED_LOCATION_PROVIDER ارائه دهنده مکان Fused Android.
CORE_LOCATION ارائه دهنده مکان در سیستم عامل های اپل.

DeliveryVehicleNavigationStatus

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

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

GetDeliveryVehicleRequest

پیام درخواست GetDeliveryVehicle .

زمینه های
header

DeliveryRequestHeader

اختیاری. هدر درخواست استاندارد Delivery API.

name

string

ضروری. باید در قالب providers/{provider}/deliveryVehicles/{delivery_vehicle} باشد. provider باید شناسه پروژه Google Cloud باشد. به عنوان مثال، sample-cloud-project .

GetTaskRequest

پیام درخواست GetTask .

زمینه های
header

DeliveryRequestHeader

اختیاری. هدر درخواست استاندارد Delivery API.

name

string

ضروری. باید در قالب providers/{provider}/tasks/{task} باشد. provider باید شناسه پروژه Google Cloud باشد. به عنوان مثال، sample-cloud-project .

GetTaskTrackingInfoRequest

پیام درخواست GetTaskTrackingInfoRequest .

زمینه های
header

DeliveryRequestHeader

اختیاری. هدر درخواست استاندارد Delivery API.

name

string

ضروری. باید در قالب providers/{provider}/taskTrackingInfo/{tracking_id} باشد. provider باید شناسه پروژه Google Cloud باشد و tracking_id باید شناسه ردیابی مرتبط با کار باشد. یک نام مثال می تواند providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id باشد.

ListDeliveryVehiclesRequest

پیام درخواست ListDeliveryVehicles .

زمینه های
header

DeliveryRequestHeader

اختیاری. هدر درخواست استاندارد Delivery API.

parent

string

ضروری. باید در قالب providers/{provider} باشد. provider باید شناسه پروژه Google Cloud باشد. به عنوان مثال، sample-cloud-project .

page_size

int32

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

page_token

string

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی ListDeliveryVehicles . برای بازیابی صفحه بعدی باید این را ارائه دهید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به ListDeliveryVehicles باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

filter

string

اختیاری. یک درخواست فیلتر برای اعمال در هنگام فهرست کردن وسایل نقلیه تحویل. برای نمونه هایی از نحو فیلتر http://aip.dev/160 را ببینید. اگر مقداری را مشخص نکنید، یا اگر یک رشته خالی برای فیلتر مشخص کنید، همه وسایل نقلیه تحویلی برگردانده می شوند.

توجه داشته باشید که تنها جستارهایی که برای ListDeliveryVehicles پشتیبانی می‌شوند، روی ویژگی‌های خودرو هستند (به عنوان مثال، attributes.<key> = <value> یا attributes.<key1> = <value1> AND attributes.<key2> = <value2> ). همچنین، تمام ویژگی ها به عنوان رشته ذخیره می شوند، بنابراین تنها مقایسه های پشتیبانی شده در برابر ویژگی ها، مقایسه رشته ها هستند. به منظور مقایسه با مقادیر یا مقادیر بولی، مقادیر باید به صراحت نقل قول شوند تا به عنوان رشته در نظر گرفته شوند (به عنوان مثال، attributes.<key> = "10" یا attributes.<key> = "true" ).

حداکثر تعداد محدودیت های مجاز در یک جستار فیلتر 50 است. محدودیت بخشی از پرس attributes.foo = bar جو attribute.<KEY> <COMPARATOR> <VALUE>

viewport

Viewport

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

ListDeliveryVehiclesResponse

پیام پاسخ ListDeliveryVehicles .

زمینه های
delivery_vehicles[]

DeliveryVehicle

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

next_page_token

string

برای ادامه فهرست کردن نتایج، می‌توانید این نشانه را در ListDeliveryVehiclesRequest ارسال کنید. وقتی همه نتایج برگردانده می شوند، این فیلد در پاسخ نخواهد بود یا یک رشته خالی خواهد بود.

total_size

int64

تعداد کل وسایل نقلیه تحویلی که با معیارهای درخواست مطابقت دارند، در همه صفحات.

ListTasksRequest

پیام درخواست ListTasks .

زمینه های
header

DeliveryRequestHeader

اختیاری. هدر درخواست استاندارد Delivery API.

parent

string

ضروری. باید در قالب providers/{provider} باشد. provider باید شناسه پروژه Google Cloud باشد. به عنوان مثال، sample-cloud-project .

page_size

int32

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

page_token

string

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

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به ListTasks باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

filter

string

اختیاری. یک درخواست فیلتر برای اعمال هنگام فهرست کردن Tasks. برای نمونه هایی از نحو فیلتر http://aip.dev/160 را ببینید. اگر مقداری را مشخص نکنید، یا اگر روی یک رشته خالی فیلتر کنید، تمام وظایف برگردانده می‌شوند. برای اطلاعات در مورد ویژگی های Task که می توانید روی آنها فیلتر کنید، به لیست وظایف مراجعه کنید.

ListTasksResponse

پاسخ ListTasks که شامل مجموعه وظایفی است که معیارهای فیلتر را در ListTasksRequest دارند.

زمینه های
tasks[]

Task

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

next_page_token

string

برای ادامه فهرست کردن نتایج، این نشانه را در ListTasksRequest ارسال کنید. اگر همه نتایج برگردانده شده باشند، این فیلد یا یک رشته خالی است یا در پاسخ ظاهر نمی شود.

total_size

int64

تعداد کل وظایفی که با معیارهای درخواست مطابقت دارند، در همه صفحات.

LocationInfo

مکانی با هر گونه شناسه اضافی.

زمینه های
point

LatLng

مختصات مکان

SearchTasksRequest

منسوخ شده: در عوض GetTaskTrackingInfoRequest را به GetTaskTrackingInfo صادر کنید.

زمینه های
header

DeliveryRequestHeader

اختیاری. هدر درخواست استاندارد Delivery API.

parent

string

ضروری. باید در قالب providers/{provider} باشد. ارائه دهنده باید شناسه پروژه Google Cloud باشد. به عنوان مثال، sample-cloud-project .

tracking_id

string

ضروری. شناسه مجموعه وظایف مرتبط در حال درخواست. شناسه های ردیابی مشمول محدودیت های زیر هستند:

  • باید یک رشته یونیکد معتبر باشد.
  • حداکثر به طول 64 کاراکتر محدود شده است.
  • طبق فرم C عادی سازی یونیکد نرمال شده است.
  • ممکن است حاوی هیچ یک از کاراکترهای ASCII زیر نباشد: «/»، «:»، «؟»، «،»، یا «#».
page_size

int32

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

page_token

string

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی SearchTasks . برای بازیابی صفحه بعدی باید این مقدار را ارائه دهید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به SearchTasks باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

SearchTasksResponse

پاسخ SearchTasks . این شامل مجموعه ای از وظایف است که با معیارهای جستجو در SearchTasksRequest مطابقت دارد.

زمینه های
tasks[]

Task

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

next_page_token

string

برای ادامه فهرست کردن نتایج، این نشانه را در SearchTasksRequest ارسال کنید. اگر همه نتایج برگردانده شده باشند، این فیلد یا یک رشته خالی است یا در پاسخ ظاهر نمی شود.

وظیفه

یک Task در Delivery API نشان دهنده یک عمل واحد برای ردیابی است. به طور کلی، بین وظایف مربوط به حمل و نقل و وظایف شکستن تفاوت وجود دارد. یک محموله می تواند چندین کار مرتبط با آن داشته باشد. برای مثال، می‌تواند یک Task برای تحویل و یکی برای تحویل یا انتقال وجود داشته باشد. همچنین، وظایف مختلف برای یک محموله مشخص می تواند توسط وسایل نقلیه مختلف انجام شود. به عنوان مثال، یک وسیله نقلیه می‌تواند وانت را انجام دهد و محموله را به مرکز انتقال می‌دهد، در حالی که وسیله نقلیه دیگری همان محموله را از هاب به محل تحویل می‌برد.

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

زمینه های
name

string

باید در قالب providers/{provider}/tasks/{task} باشد.

type

Type

ضروری. تغییرناپذیر. نوع Task را مشخص می کند. به عنوان مثال، یک استراحت یا حمل و نقل.

state

State

ضروری. وضعیت فعلی اجرای Task.

task_outcome

TaskOutcome

نتیجه کار.

task_outcome_time

Timestamp

مهر زمانی که نشان می دهد چه زمانی نتیجه Task توسط ارائه دهنده تنظیم شده است.

task_outcome_location

LocationInfo

مکانی که نتیجه Task در آن تنظیم شد. این مقدار به عنوان بخشی از UpdateTask به روز می شود. اگر این مقدار به صراحت توسط ارائه‌دهنده به‌روزرسانی نشده باشد، Fleet Engine آن را به‌طور پیش‌فرض با آخرین مکان شناخته‌شده وسیله نقلیه (مکان خام ) پر می‌کند.

task_outcome_location_source

TaskOutcomeLocationSource

نشان می دهد که مقدار task_outcome_location از کجا آمده است.

tracking_id

string

تغییرناپذیر. این فیلد ذخیره سازی یک شناسه را تسهیل می کند، بنابراین می توانید از استفاده از نقشه های پیچیده اجتناب کنید. نمی‌توانید tracking_id برای Tasks از نوع UNAVAILABLE و SCHEDULED_STOP تنظیم کنید. این شناسه ها مشمول محدودیت های زیر هستند:

  • باید یک رشته یونیکد معتبر باشد.
  • حداکثر به طول 64 کاراکتر محدود شده است.
  • طبق فرم C عادی سازی یونیکد نرمال شده است.
  • ممکن است حاوی هیچ یک از کاراکترهای ASCII زیر نباشد: «/»، «:»، «؟»، «،»، یا «#».
delivery_vehicle_id

string

فقط خروجی شناسه وسیله نقلیه ای که این وظیفه را انجام می دهد. شناسه خودروهای تحویلی مشمول محدودیت‌های زیر است:

  • باید یک رشته یونیکد معتبر باشد.
  • حداکثر به طول 64 کاراکتر محدود شده است.
  • طبق فرم C عادی سازی یونیکد نرمال شده است.
  • ممکن است حاوی هیچ یک از کاراکترهای ASCII زیر نباشد: «/»، «:»، «؟»، «،»، یا «#».
planned_location

LocationInfo

تغییرناپذیر. مکانی که وظیفه تکمیل خواهد شد. برای کارهای UNAVAILABLE اختیاری است، اما برای همه وظایف دیگر لازم است.

task_duration

Duration

ضروری. تغییرناپذیر. زمان لازم برای اجرای یک Task در این مکان.

target_time_window

TimeWindow

پنجره زمانی که در طی آن کار باید تکمیل شود.

journey_sharing_info

JourneySharingInfo

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

task_tracking_view_config

TaskTrackingViewConfig

پیکربندی برای ردیابی کار که مشخص می کند کدام عناصر داده تحت چه شرایطی برای کاربران نهایی قابل مشاهده است.

attributes[]

TaskAttribute

لیستی از ویژگی های Task سفارشی. هر ویژگی باید یک کلید منحصر به فرد داشته باشد.

JourneySharingInfo

سفر به اشتراک گذاری زمینه های خاص.

زمینه های
remaining_vehicle_journey_segments[]

VehicleJourneySegment

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

بخش اول، Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) یا Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST)، حاوی اطلاعات مسیر از آخرین مکان شناخته شده راننده تا VehicleStop آینده است. اطلاعات مسیر فعلی معمولاً از برنامه راننده می آید، به جز مواردی که در اسناد برای DeliveryVehicle.current_route_segment ذکر شده است. بخش‌های دیگر در Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) یا Task.journeySharingInfo.remainingVehicleJourneySegments (REST) ​​توسط Fleet Engine پر شده‌اند. آنها اطلاعات مسیر بین VehicleStops باقی مانده را ارائه می دهند.

last_location

DeliveryVehicleLocation

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

last_location_snappable

bool

نشان می دهد که آیا می توان آخرین مکان وسیله نقلیه را به current_route_segment منتقل کرد یا خیر. اگر last_location یا current_route_segment وجود نداشته باشد، این مقدار False است. این مقدار توسط Fleet Engine محاسبه می شود. به‌روزرسانی‌های مشتریان نادیده گرفته می‌شوند.

حالت

وضعیت یک وظیفه. این نشان دهنده پیشرفت Tasks است.

Enums
STATE_UNSPECIFIED پیش فرض برای یک وضعیت وظیفه نامشخص یا ناشناخته استفاده می شود.
OPEN یا Task هنوز به وسیله نقلیه تحویلی اختصاص داده نشده است، یا وسیله نقلیه تحویلی هنوز از توقف خودروی تعیین شده توسط Task عبور نکرده است.
CLOSED هنگامی که وسیله نقلیه عبور می کند، وسیله نقلیه را برای این کار متوقف کنید.

نتیجه وظیفه

نتیجه تلاش برای اجرای یک Task. وقتی TaskState بسته می شود، TaskOutcome نشان می دهد که آیا با موفقیت کامل شده است یا خیر.

Enums
TASK_OUTCOME_UNSPECIFIED نتیجه Task قبل از تنظیم مقدار آن.
SUCCEEDED کار با موفقیت انجام شد.
FAILED یا کار انجام نشد، یا لغو شد.

TaskOutcomeLocationSource

هویت منبعی که task_outcome_location را پر کرده است.

Enums
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED نتیجه کار قبل از تنظیم.
PROVIDER ارائه دهنده task_outcome_location مشخص کرده است.
LAST_VEHICLE_LOCATION ارائه دهنده task_outcome_location را مشخص نکرده است، بنابراین Fleet Engine از آخرین مکان شناخته شده وسیله نقلیه استفاده کرد.

تایپ کنید

نوع وظیفه

Enums
TYPE_UNSPECIFIED به طور پیش فرض، نوع وظیفه ناشناخته است.
PICKUP وظیفه پیکاپ اقدامی است که برای تحویل گرفتن محموله از مشتری انجام می شود. وانت های انباری یا تغذیه کننده خودرو باید از نوع SCHEDULED_STOP استفاده کنند.
DELIVERY وظیفه تحویل، اقدامی است که برای تحویل یک محموله به مشتری نهایی انجام می شود. وسایل نقلیه انباری یا تغذیه کننده باید از نوع SCHEDULED_STOP استفاده کنند.
SCHEDULED_STOP یک کار توقف برنامه ریزی شده برای اهداف برنامه ریزی استفاده می شود. به عنوان مثال، می تواند نشان دهنده تحویل یا تحویل محموله ها از وسایل نقلیه تغذیه کننده یا انبارها باشد. نباید برای هر محموله ای که از مشتری نهایی تحویل گرفته یا تحویل داده می شود استفاده شود.
UNAVAILABLE وظیفه ای که به این معنی است که وسیله نقلیه برای سرویس در دسترس نیست. به عنوان مثال، زمانی که راننده استراحت می کند، یا زمانی که وسیله نقلیه در حال سوخت گیری است، این اتفاق می افتد.

TaskAttribute

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

زمینه های
key

string

کلید ویژگی کلیدها ممکن است حاوی کاراکتر دو نقطه (:) نباشند.

فیلد اتحادیه task_attribute_value . مقدار مشخصه می تواند از نوع رشته ای، bool یا دوگانه باشد. اگر هیچ یک تنظیم نشده باشد، TaskAttribute string_value به عنوان رشته خالی "" ذخیره می شود. task_attribute_value تنها می تواند یکی از موارد زیر باشد:
string_value

string

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

bool_value

bool

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

number_value

double

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

TaskTrackingInfo

پیام TaskTrackingInfo . پیام حاوی اطلاعات ردیابی کار است که برای نمایش استفاده خواهد شد. اگر شناسه ردیابی با چندین کار مرتبط باشد، Fleet Engine از یک اکتشافی برای تصمیم گیری اینکه TaskTrackingInfo کدام Task را انتخاب کند، استفاده می کند.

زمینه های
name

string

باید در قالب providers/{provider}/taskTrackingInfo/{tracking} باشد، جایی که tracking نشان دهنده شناسه ردیابی است.

tracking_id

string

تغییرناپذیر. شناسه ردیابی یک کار. * باید یک رشته یونیکد معتبر باشد. * محدود به حداکثر طول 64 کاراکتر. * طبق فرم C عادی سازی یونیکد عادی شده است. * ممکن است حاوی هیچ یک از کاراکترهای ASCII زیر نباشد: '/'، ':'، '?'، '،'، یا '#'.

vehicle_location

DeliveryVehicleLocation

آخرین مکان خودرو

route_polyline_points[]

LatLng

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

remaining_stop_count

Int32Value

تعداد توقف هایی که وسیله نقلیه تا رسیدن به ایستگاه وظیفه باقی مانده است، از جمله توقف کار را نشان می دهد. به عنوان مثال، اگر توقف بعدی خودرو، توقف کار باشد، مقدار 1 خواهد بود.

remaining_driving_distance_meters

Int32Value

مجموع مسافت باقیمانده بر حسب متر تا VehicleStop مورد علاقه.

estimated_arrival_time

Timestamp

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

estimated_task_completion_time

Timestamp

مهر زمانی که زمان تخمینی تکمیل یک کار را نشان می دهد.

state

State

وضعیت فعلی اجرای Task.

task_outcome

TaskOutcome

نتیجه تلاش برای اجرای یک Task.

task_outcome_time

Timestamp

مهر زمانی که نشان می دهد چه زمانی نتیجه Task توسط ارائه دهنده تنظیم شده است.

planned_location

LocationInfo

تغییرناپذیر. مکانی که وظیفه تکمیل خواهد شد.

target_time_window

TimeWindow

پنجره زمانی که در طی آن کار باید تکمیل شود.

attributes[]

TaskAttribute

ویژگی های سفارشی تنظیم شده روی کار.

TaskTrackingViewConfig

پیام پیکربندی که تعیین می کند چه زمانی یک عنصر داده از یک وظیفه باید برای کاربران نهایی قابل مشاهده باشد.

زمینه های
route_polyline_points_visibility

VisibilityOption

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

estimated_arrival_time_visibility

VisibilityOption

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

estimated_task_completion_time_visibility

VisibilityOption

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

remaining_driving_distance_visibility

VisibilityOption

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

remaining_stop_count_visibility

VisibilityOption

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

vehicle_location_visibility

VisibilityOption

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

VisibilityOption

پیام گزینه ای که تعیین می کند چه زمانی یک عنصر داده باید برای کاربران نهایی قابل مشاهده باشد.

زمینه های
visibility_option فیلد اتحادیه. گزینه دید خاص انتخاب شده است. visibility_option تنها می تواند یکی از موارد زیر باشد:
remaining_stop_count_threshold

int32

اگر تعداد توقف باقیمانده <= resting_stop_count_threshold باشد، این عنصر داده برای کاربران نهایی قابل مشاهده است.

duration_until_estimated_arrival_time_threshold

Duration

این عنصر داده برای کاربران نهایی قابل مشاهده است در صورتی که ETA به توقف <= duration_until_estimated_arrival_time_threshold باشد.

remaining_driving_distance_meters_threshold

int32

اگر مسافت رانندگی باقیمانده به متر <= resting_driving_distance_meters_threshold باشد، این عنصر داده برای کاربران نهایی قابل مشاهده است.

always

bool

اگر روی true تنظیم شود، این عنصر داده همیشه برای کاربران نهایی بدون آستانه قابل مشاهده است. این قسمت را نمی توان به غلط تنظیم کرد.

never

bool

در صورت تنظیم صحیح ، این عنصر داده همیشه از کاربران نهایی بدون آستانه پنهان است. این قسمت را نمی توان به غلط تنظیم کرد.

پنجره زمان

یک محدوده زمانی

زمینه های
start_time

Timestamp

ضروری. زمان شروع پنجره زمان (شامل).

end_time

Timestamp

ضروری. زمان پایان پنجره زمان (فراگیر).

به روز شده

پیام درخواست UpdateDeliveryVehicle .

زمینه های
header

DeliveryRequestHeader

اختیاری. هدر درخواست API تحویل استاندارد.

delivery_vehicle

DeliveryVehicle

ضروری. به روزرسانی موجودیت DeliveryVehicle برای استفاده. توجه: شما نمی توانید نام DeliveryVehicle را به روز کنید.

update_mask

FieldMask

ضروری. ماسک میدانی که نشان می دهد کدام قسمت از بخش های DeliveryVehicle برای به روزرسانی است. توجه داشته باشید که update_mask باید حداقل یک قسمت داشته باشد.

این یک لیست جدا از کاما از نام های کاملاً واجد شرایط است. مثال: "remaining_vehicle_journey_segments" .

updateTaskRequest

پیام درخواست UpdateTask .

زمینه های
header

DeliveryRequestHeader

اختیاری. هدر درخواست API تحویل استاندارد.

task

Task

ضروری. کار مرتبط با بروزرسانی. زمینه های زیر توسط موتور ناوگان نگهداری می شود. آنها را با استفاده از Task.update به روز نکنید.

  • last_location .
  • last_location_snappable .
  • name .
  • remaining_vehicle_journey_segments .
  • task_outcome_location_source .

توجه: پس از تنظیم آن نمی توانید مقدار task_outcome را تغییر دهید.

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

update_mask

FieldMask

ضروری. ماسک زمینه ای که نشان می دهد کدام قسمت های کار را برای به روزرسانی نشان می دهد. توجه: update_mask باید حداقل یک قسمت داشته باشد.

این یک لیست جدا از کاما از نام های کاملاً واجد شرایط است. مثال: "task_outcome,task_outcome_time,task_outcome_location" .

وسیله نقلیه

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

زمینه های
stop

VehicleStop

محل توقف را به همراه Task مرتبط با توقف مشخص می کند. در صورتی که این بخش سفر بخشی از JourneySharingInfo باشد ، برخی از زمینه های Vehiclestop ممکن است حضور نداشته باشند.

driving_distance_meters

Int32Value

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

driving_duration

Duration

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

اگر این زمینه در Task.remaining_vehicle_journey_segments[0].driving_duration (GRPC) یا Task.remainingVehicleJourneySegments[0].drivingDuration (استراحت) ، سپس ممکن است با مقدار از DeliveryVehicle.remaining_duration (GRPC) یا DeliveryVehicle.remainingDuration (استراحت). این مدت زمان رانندگی باقی مانده از آخرین مکان شناخته شده برنامه راننده را به جای زمان رانندگی از توقف قبلی فراهم می کند.

path[]

LatLng

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

اگر این زمینه در وظیفه مسیر تعریف شده باشد Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (GRPC) یا Task.journeySharingInfo.remainingVehicleJourneySegments[0].path ) ، پس از آن ممکن است آن را با DecodeDed LatLng S DeliveryVehicle.current_route_segment (GRPC) یا DeliveryVehicle.currentRouteSegment (استراحت). این مسیر رانندگی را از آخرین مکان شناخته شده برنامه درایور به جای مسیر از توقف قبلی فراهم می کند.

وسیله نقلیه

نکته ای را توصیف می کند که یک وسیله نقلیه برای انجام یک یا چند Task متوقف می شود.

زمینه های
planned_location

LocationInfo

ضروری. محل توقف توجه داشته باشید که مکانهای موجود در Task ممکن است دقیقاً با این مکان مطابقت نداشته باشند ، اما در فاصله کوتاهی از آن قرار خواهند گرفت. این قسمت در پاسخ یک GetTask یا تماس SearchTasks جمع نمی شود.

tasks[]

TaskInfo

لیست Task S در این توقف انجام می شود. این قسمت در پاسخ به تماس GetTask یا SearchTasks جمع نمی شود.

state

State

وضعیت VehicleStop . این قسمت در پاسخ یک GetTask یا تماس SearchTasks جمع نمی شود.

حالت

وضعیت فعلی یک VehicleStop .

نماد
STATE_UNSPECIFIED ناشناخته.
NEW ایجاد شده ، اما نه به طور فعال مسیریابی.
ENROUTE مسیریابی اختصاص داده شده و فعال.
ARRIVED وارد توقف شد. فرض می کند که وقتی وسیله نقلیه به ایستگاه بعدی مسیریابی می شود ، تمام توقف های قبلی به پایان رسیده است.

مربوط به کار

اطلاعات اضافی در مورد کار انجام شده در این توقف.

زمینه های
task_id

string

شناسه کار این قسمت در پاسخ یک GetTask یا تماس SearchTasks جمع نمی شود. شناسه های کار مشمول محدودیت های زیر هستند:

  • باید یک رشته معتبر یونیکد باشد.
  • محدود به حداکثر طول 64 کاراکتر.
  • با توجه به فرم عادی سازی یونیکد c .
  • ممکن است هیچ یک از شخصیت های ASCII زیر را شامل نشود: "/" ، "،" ، "؟" ، "،" ، یا "#".
task_duration

Duration

فقط خروجی زمان لازم برای انجام کار.

target_time_window

TimeWindow

فقط خروجی پنجره زمانی که در طی آن باید به اتمام برسد. این فقط در پاسخ به GetDeliveryVehicle تنظیم شده است.