Package maps.fleetengine.delivery.v1

אינדקס

DeliveryService

השירות 'משלוח במייל האחרון'.

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 שצוין.

ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

הפונקציה מקבלת את כל הערכים מסוג DeliveryVehicle שעומדים בקריטריונים לסינון.

ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

הפונקציה מקבלת את כל הערכים מסוג Task שעומדים בקריטריונים לסינון.

SearchTasks

rpc SearchTasks(SearchTasksRequest) returns (SearchTasksResponse)

הוצא משימוש: יש להשתמש במקום זאת ב-GetTaskTrackingInfo.

UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

כתיבת נתונים מעודכנים של DeliveryVehicle ב-Feet 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.

BatchCreateTasksRequest

הודעת הבקשה BatchCreateTask.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה. הערה: אם מגדירים את השדה הזה, שדה הכותרת בהודעות CreateTaskRequest חייב להיות ריק, או להתאים לשדה הזה.

parent

string

חובה. משאב ההורה שמשותף לכל המשימות. הערך הזה חייב להיות בפורמט providers/{provider}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project. שדה ההורה בהודעות של CreateTaskRequest חייב להיות ריק, או שהוא חייב להתאים לשדה הזה.

requests[]

CreateTaskRequest

חובה. הודעת הבקשה שמציינת את המשאבים שיש ליצור. הערה: אפשר ליצור עד 500 משימות בבת אחת.

BatchCreateTasksResponse

הודעת התשובה BatchCreateTask.

שדות
tasks[]

Task

המשימות שנוצרו.

CreateDeliveryVehicleRequest

הודעת הבקשה CreateDeliveryVehicle.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה.

parent

string

חובה. חייב להיות בפורמט providers/{provider}. הספק צריך להיות מזהה הפרויקט ב-Google Cloud. לדוגמה: sample-cloud-project.

delivery_vehicle_id

string

חובה. מזהה הרכב למשלוח צריך להיות ייחודי בכפוף להגבלות הבאות:

  • חייבת להיות מחרוזת Unicode חוקית.
  • מוגבל לאורך מקסימלי של 64 תווים.
  • מנורמל לפי טופס נירמול Unicode C.
  • אינו יכול להכיל אף אחד מתווי ה-ASCII הבאים: '/', ':', '?', ',' או '#'.
delivery_vehicle

DeliveryVehicle

חובה. הישות DeliveryVehicle שצריך ליצור. כשיוצרים רכב מסירה חדש, אפשר להגדיר את השדות האופציונליים הבאים:

  • last_location
  • מאפיינים

הערה: המערכת מתעלמת מהשדה name של DeliveryVehicle. אין להגדיר את כל השדות האחרים של DeliveryVehicle. אחרת, תוחזר שגיאה.

CreateTaskRequest

הודעת הבקשה CreateTask.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה.

parent

string

חובה. חייב להיות בפורמט providers/{provider}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.

task_id

string

חובה. מזהה המשימה חייב להיות ייחודי, אבל הוא לא יכול להיות מזהה לצורכי מעקב אחר משלוחים. כדי לאחסן מזהה לצורכי מעקב אחר משלוח, משתמשים בשדה tracking_id. חשוב לשים לב שלמשימות מרובות יכול להיות אותו tracking_id. מזהי המשימות כפופים להגבלות הבאות:

  • חייבת להיות מחרוזת Unicode חוקית.
  • מוגבל לאורך מקסימלי של 64 תווים.
  • מנורמל לפי טופס נירמול Unicode C.
  • אינו יכול להכיל אף אחד מתווי ה-ASCII הבאים: '/', ':', '?', ',' או '#'.
task

Task

חובה. הישות של המשימה שצריך ליצור. כשיוצרים משימה, צריך למלא את השדות הבאים:

  • type
  • state (חייב להיות מוגדר ל-OPEN)
  • tracking_id (אסור להגדיר את הערך הזה למשימות UNAVAILABLE או SCHEDULED_STOP, אבל חובה לכל סוגי המשימות האחרים)
  • planned_location (אופציונלי ל-UNAVAILABLE משימות)
  • task_duration

הערה: המערכת מתעלמת מהשדה name של המשימה. אין להגדיר את כל שאר שדות המשימה. אחרת, תוחזר שגיאה.

DeliveryRequestHeader

כותרת בקשה מכילה שדות שמשותפים לכל הבקשות ל-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

רמת ה-API של Android של ה-SDK לשיחות. רלוונטית רק לערכות ה-SDK ל-Android. דוגמה לערך בשדה: 23.

trace_id

string

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

פלטפורמה

הפלטפורמה של ה-SDK לשיחות.

טיפוסים בני מנייה (enums)
PLATFORM_UNSPECIFIED ערך ברירת המחדל. ייעשה שימוש בערך הזה אם לא תציינו את הפלטפורמה.
ANDROID הבקשה מגיעה מ-Android.
IOS הבקשה מגיעה מ-iOS.
WEB הבקשה מגיעה מהאינטרנט.

SdkType

סוגים אפשריים של SDK.

טיפוסים בני מנייה (enums)
SDK_TYPE_UNSPECIFIED ערך ברירת המחדל. נעשה שימוש בערך הזה אם לא מזינים את הערך sdk_type.
CONSUMER ה-SDK לשיחות הוא 'צרכן'.
DRIVER ה-SDK לשיחות הוא Driver.
JAVASCRIPT ה-SDK המפעיל הוא JavaScript.

DeliveryVehicle

ההודעה DeliveryVehicle. רכב למשלוחים מוביל את המשלוחים ממחסן אל יעד מסירה, ומנקודת האיסוף אל התחנה. במקרים מסוימים, כלי רכב מובילים גם לשינוע משלוחים ישירות מנקודת האיסוף אל יעד המשלוח.

הערה: ממשקי API ל-gRPC ו-REST משתמשים במוסכמות שונות של מתן שמות לשדות. לדוגמה, השדה DeliveryVehicle.current_route_segment ב-gRPC API והשדה DeliveryVehicle.currentRouteSegment ב-API ל-REST מפנים לאותו שדה.

שדות
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) לכל המשימות הפעילות שמוקצות לרכב.

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

current_route_segment_end_point

LatLng

המיקום שבו current_route_segment מסתיים. שדה זה לא מאוכלס כרגע על ידי אפליקציית הנהג, אבל אפשר לספק אותו בשיחות UpdateDeliveryVehicle. מדובר בLatLng מתחנת הרכב הקרובה, או בLatLng האחרונה של הcurrent_route_segment. לאחר מכן, Fleet Engine יעשה כמיטב יכולתו כדי לבצע אינטרפולציה ל-VehicleStop אמיתי.

המערכת מתעלמת מהשדה הזה ב-UpdateDeliveryVehicle קריאות אם השדה current_route_segment ריק.

remaining_distance_meters

Int32Value

מרחק הנסיעה הנותר של current_route_segment. אפליקציית הנהיגה בדרך כלל מספקת את השדה הזה, אבל בנסיבות מסוימות Fleet Engine יבטל את הערך שהאפליקציה שולחת. מידע נוסף זמין בכתובת DeliveryVehicle.current_route_segment. השדה הזה מוחזר ב-Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) או ב-Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) לכל הערכים הפעילים של Task שהוקצו לרכב המסירה.

Fleet Engine מתעלם מהשדה הזה ב-UpdateDeliveryVehicleRequest אם השדה current_route_segment ריק.

remaining_duration

Duration

זמן הנסיעה הנותר של current_route_segment. אפליקציית הנהיגה בדרך כלל מספקת את השדה הזה, אבל בנסיבות מסוימות Fleet Engine יבטל את הערך שהאפליקציה שולחת. מידע נוסף זמין בכתובת DeliveryVehicle.current_route_segment. השדה הזה מוחזר ב-Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) או ב-Task.remainingVehicleJourneySegments[0].drivingDuration (REST) לכל המשימות הפעילות שמוקצות לרכב המסירה.

Fleet Engine מתעלם מהשדה הזה ב-UpdateDeliveryVehicleRequest אם השדה current_route_segment ריק.

remaining_vehicle_journey_segments[]

VehicleJourneySegment

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

attributes[]

DeliveryVehicleAttribute

רשימה של מאפיינים מותאמים אישית של כלי רכב למשלוח. לרכב מסירה יכול להיות לכל היותר 100 מאפיינים, ולכל מאפיין צריך להיות מפתח ייחודי.

type

DeliveryVehicleType

הסוג של כלי המשלוח הזה. אם המדיניות לא מוגדרת, ברירת המחדל תהיה AUTO.

DeliveryVehicleType

הסוג של כלי הרכב.

טיפוסים בני מנייה (enums)
DELIVERY_VEHICLE_TYPE_UNSPECIFIED הערך לא בשימוש.
AUTO מכונית.
TWO_WHEELER אופנוע, קטנוע או כלי רכב דו-גלגלי אחר
BICYCLE הובלה בכוח אדם.
PEDESTRIAN אדם נהגות, בדרך כלל הולך או רץ, שנוסע בשבילים להולכי רגל.

DeliveryVehicleAttribute

מתאר מאפיין של רכב כצמד מפתח/ערך. האורך של המחרוזת "key:value" לא יכול לחרוג מ-256 תווים.

שדות
key

string

מפתח המאפיין.

value

string

ערך המאפיין.

שדה איחוד delivery_vehicle_attribute_value. ערך המאפיין יכול להיות במחרוזת, בבוליאני או בטיפוס כפול. 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 בסיוע, מזהה מגדל סלולרי או נקודת גישה ל-Wi-Fi.
PASSIVE מזהה אנטנה סלולרית או נקודת גישה ל-Wi-Fi.
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 ספק המיקום המשולב של Android.
CORE_LOCATION ספק המיקום במערכות ההפעלה של Apple.

DeliveryVehicleNavigationStatus

סטטוס הניווט של הרכב.

טיפוסים בני מנייה (enums)
UNKNOWN_NAVIGATION_STATUS סטטוס הניווט לא צוין.
NO_GUIDANCE הניווט של אפליקציית הנהג נמצא במצב FREE_NAV.
ENROUTE_TO_DESTINATION ניתן לקבל ניווט במסלול מפורט והניווט באפליקציית הנהג עבר למצב GUIDED_NAV.
OFF_ROUTE הרכב סטי מהמסלול המוצע.
ARRIVED_AT_DESTINATION הרכב נמצא בטווח של כ-50 מטרים מהיעד.

GetDeliveryVehicleRequest

הודעת הבקשה GetDeliveryVehicle.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה.

name

string

חובה. חייב להיות בפורמט providers/{provider}/deliveryVehicles/{delivery_vehicle}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.

GetTaskRequest

הודעת הבקשה GetTask.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה.

name

string

חובה. חייב להיות בפורמט providers/{provider}/tasks/{task}. השדה provider חייב להיות מזהה הפרויקט ב-Google Cloud. לדוגמה, sample-cloud-project.

GetTaskTrackingInfoRequest

הודעת הבקשה GetTaskTrackingInfoRequest.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. כותרת הבקשה של ה-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

זה שינוי אופציונלי. כותרת הבקשה של ה-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. הגבלה היא חלק מהשאילתה בצורה attribute.<KEY> <COMPARATOR> <VALUE>. לדוגמה, attributes.foo = bar היא הגבלה 1.

viewport

Viewport

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

ListDeliveryVehiclesResponse

הודעת התשובה ListDeliveryVehicles.

שדות
delivery_vehicles[]

DeliveryVehicle

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

next_page_token

string

אפשר להעביר את האסימון הזה ב-ListDeliveryVehiclesRequest כדי להמשיך ברשימת התוצאות. כאשר כל התוצאות מוחזרות, השדה הזה לא ייכלל בתגובה או שהוא יהיה מחרוזת ריקה.

total_size

int64

המספר הכולל של רכבי מסירה שתואמים לקריטריונים של הבקשה, בכל הדפים.

ListTasksRequest

הודעת הבקשה ListTasks.

שדות
header

DeliveryRequestHeader

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

ListTasksResponse

התשובה ListTasks שמכילה את קבוצת המשימות שעומדות בקריטריוני הסינון בListTasksRequest.

שדות
tasks[]

Task

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

next_page_token

string

כדי להמשיך להציג את התוצאות, צריך להעביר את האסימון הזה ב-ListTasksRequest. אם כל התוצאות הוחזרו, השדה הזה הוא מחרוזת ריקה או שהוא לא מופיע בתגובה.

total_size

int64

המספר הכולל של משימות שתואמות לקריטריונים של הבקשה, בכל הדפים.

LocationInfo

מיקום עם מזהים נוספים, אם יש.

שדות
point

LatLng

הקואורדינטות של המיקום.

SearchTasksRequest

הוצא משימוש: גיליון GetTaskTrackingInfoRequests עד GetTaskTrackingInfo במקום זאת.

שדות
header

DeliveryRequestHeader

זה שינוי אופציונלי. כותרת הבקשה של ה-API למסירה הרגילה.

parent

string

חובה. חייב להיות בפורמט providers/{provider}. הספק צריך להיות מזהה הפרויקט ב-Google Cloud. לדוגמה: sample-cloud-project.

tracking_id

string

חובה. המזהה של קבוצת המשימות הקשורות שהתבקשו. מזהים לצורכי מעקב כפופים להגבלות הבאות:

  • חייבת להיות מחרוזת Unicode חוקית.
  • מוגבל לאורך מקסימלי של 64 תווים.
  • מנורמל לפי טופס נירמול Unicode C.
  • אינו יכול להכיל אף אחד מתווי ה-ASCII הבאים: '/', ':', '?', ',' או '#'.
page_size

int32

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

page_token

string

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

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

SearchTasksResponse

התגובה SearchTasks. היא מכילה את קבוצת המשימות שעומדות בקריטריונים לחיפוש ב-SearchTasksRequest.

שדות
tasks[]

Task

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

next_page_token

string

כדי להמשיך להציג את התוצאות, צריך להעביר את האסימון הזה ב-SearchTasksRequest. אם כל התוצאות הוחזרו, השדה הזה הוא מחרוזת ריקה או שהוא לא מופיע בתגובה.

משימה

משימה ב- Delivery API מייצגת פעולה יחידה למעקב. באופן כללי, יש הבחנה בין Tasks שקשורות למשלוח לבין משימות מנותקות. לכל משלוח יכולות להיות כמה משימות. לדוגמה, יכולה להיות משימה אחת לאיסוף ומשימה אחת למסירה או להעברה. כמו כן, כלי רכב שונים יכולים לטפל במשימות שונות במשלוח נתון. לדוגמה, רכב אחד יכול לטפל באיסוף ולהביא את המשלוח למרכז, ורכב אחר יכול לנסוע עם אותו משלוח מהמרכז אל נקודת ההורדה.

הערה: ממשקי API ל-gRPC ו-REST משתמשים במוסכמות שונות של מתן שמות לשדות. לדוגמה, השדה Task.journey_sharing_info ב-gRPC API והשדה Task.journeySharingInfo ב-API ל-REST מפנים לאותו שדה.

שדות
name

string

חייב להיות בפורמט providers/{provider}/tasks/{task}.

type

Type

חובה. בלתי משתנה. מגדיר את סוג המשימה. לדוגמה, הפסקה או משלוח.

state

State

חובה. מצב הביצוע הנוכחי של המשימה.

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 למשימות מסוג UNAVAILABLE וגם SCHEDULED_STOP. המזהים האלה כפופים להגבלות הבאות:

  • חייבת להיות מחרוזת Unicode חוקית.
  • מוגבל לאורך מקסימלי של 64 תווים.
  • מנורמל לפי טופס נירמול Unicode C.
  • אינו יכול להכיל אף אחד מתווי ה-ASCII הבאים: '/', ':', '?', ',' או '#'.
delivery_vehicle_id

string

פלט בלבד. מזהה הרכב שמבצע את המשימה הזו. מזהי כלי רכב כפופים להגבלות הבאות:

  • חייבת להיות מחרוזת Unicode חוקית.
  • מוגבל לאורך מקסימלי של 64 תווים.
  • מנורמל לפי טופס נירמול Unicode C.
  • אינו יכול להכיל אף אחד מתווי ה-ASCII הבאים: '/', ':', '?', ',' או '#'.
planned_location

LocationInfo

בלתי משתנה. המיקום שבו המשימה תושלם. אופציונלי ל-UNAVAILABLE משימות, אבל חובה לכל שאר המשימות.

task_duration

Duration

חובה. בלתי משתנה. הזמן הדרוש לביצוע משימה במיקום הזה.

target_time_window

TimeWindow

חלון הזמן שבמהלכו צריך להשלים את המשימה.

journey_sharing_info

JourneySharingInfo

פלט בלבד. שדות ספציפיים לשיתוף של נסיעות. לא מאוכלס כשהמדינה היא CLOSED.

task_tracking_view_config

TaskTrackingViewConfig

התצורה של מעקב משימות, שמציינת אילו רכיבי נתונים גלויים למשתמשי הקצה ובאילו נסיבות.

attributes[]

TaskAttribute

רשימה של מאפייני משימה בהתאמה אישית. לכל מאפיין צריך להיות מפתח ייחודי.

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. הערך הזה מוגדר כ-False אם המדיניות last_location או current_route_segment לא קיימים. הערך הזה מחושב על ידי Fleet Engine. המערכת מתעלמת מעדכונים מלקוחות.

ארץ

המצב של משימה. סימון ההתקדמות ב-Tasks.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED ברירת מחדל. משמש למצב המשימה לא צוין או לא מזוהה.
OPEN יכול להיות שהמשימה עדיין לא הוקצתה לרכב מסירה, או שהרכב עוד לא עבר את תחנת העצירה שהוקצתה לTask.
CLOSED כשהרכב עובר עם עצירת הרכב במשימה הזו.

TaskOutcome

התוצאה של ניסיון לבצע משימה. כשהיעד TaskState סגור, הערך TaskOutcome מציין אם הפעולה הושלמה בהצלחה.

טיפוסים בני מנייה (enums)
TASK_OUTCOME_UNSPECIFIED תוצאת המשימה לפני שהערך שלה הוגדר.
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. ערך המאפיין יכול להיות במחרוזת, בבוליאני או בטיפוס כפול. אם לא הוגדר אף ערך, הפרמטר TaskAttribute string_value יאוחסן כמחרוזת הריקה "". הערך task_attribute_value יכול להיות רק אחת מהאפשרויות הבאות:
string_value

string

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

bool_value

bool

ערך מאפיין הקלד בוליאני.

number_value

double

ערך מאפיין שהוקלד פעמיים.

TaskTrackingInfo

ההודעה TaskTrackingInfo. ההודעה מכילה פרטי מעקב אחר משימות שישמשו להצגה. אם מזהה לצורכי מעקב משויך למספר משימות, Fleet Engine משתמש בשיטה היוריסטית כדי להחליט באיזו משימה לבחור באיזו גרסה של TaskTrackingInfo.

שדות
name

string

חייב להיות בפורמט providers/{provider}/taskTrackingInfo/{tracking}, כאשר tracking מייצג את המזהה לצורכי מעקב.

tracking_id

string

בלתי משתנה. המזהה לצורכי מעקב של משימה. * חייבת להיות מחרוזת Unicode חוקית. * מוגבל לאורך מקסימלי של 64 תווים. * מנורמל בהתאם לטופס נירמול Unicode 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_outcome

TaskOutcome

התוצאה של ניסיון לבצע משימה.

task_outcome_time

Timestamp

חותמת הזמן שמציינת מתי הספק הגדיר את תוצאת המשימה.

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

רכיב הנתונים הזה גלוי למשתמשי הקצה אם מספר העצירה שנותר <= left_stop_count_threshold.

duration_until_estimated_arrival_time_threshold

Duration

רכיב הנתונים הזה גלוי למשתמשי הקצה אם זמן ההגעה המשוער עד לעצירה <= duration_until_estimated_arrival_time_threshold.

remaining_driving_distance_meters_threshold

int32

רכיב הנתונים הזה גלוי למשתמשי הקצה אם מרחק הנסיעה שנותר במטרים הוא במטרים <= still_driving_distance_meters_threshold.

always

bool

אם הערך מוגדר כ-True, רכיב הנתונים תמיד גלוי למשתמשי הקצה ללא ערכי סף. אי אפשר להגדיר את השדה הזה כ-False.

never

bool

אם המדיניות מוגדרת כ-True, רכיב הנתונים הזה תמיד יהיה מוסתר ממשתמשי הקצה ללא ערכי סף. אי אפשר להגדיר את השדה הזה כ-False.

TimeWindow

טווח זמן.

שדות
start_time

Timestamp

חובה. שעת ההתחלה של חלון הזמן (כולל).

end_time

Timestamp

חובה. שעת הסיום של חלון הזמן (כולל).

UpdateDeliveryVehicleRequest

הודעת הבקשה 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

חובה. המשימה שמשויכת לעדכון. השדות הבאים מנוהלים על ידי Fleet Engine. אין לעדכן אותם באמצעות 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"

VehicleJourneySegment

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

שדות
stop

VehicleStop

מציין את מיקום העצירה, עם סימני ה-Task המשויכים לתחנה. יכול להיות שחלק מהשדות של AutomotiveStop לא יופיעו אם קטע הנסיעה הזה הוא חלק מ-JourneySharingInfo.

driving_distance_meters

Int32Value

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

driving_duration

Duration

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

אם השדה הזה מוגדר בנתיב Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) או Task.remainingVehicleJourneySegments[0].drivingDuration (REST), אפשר לאכלס אותו בערך מ-DeliveryVehicle.remaining_duration (gRPC) או DeliveryVehicle.remainingDuration (REST). המדד הזה מספק את משך הנסיעה שנותר מהמיקום האחרון הידוע של אפליקציית הנהג, ולא את זמן הנסיעה מהתחנה הקודמת.

path[]

LatLng

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

אם השדה הזה מוגדר בנתיב Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) או Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST), יכול להיות שהוא יאוכלס ב-LatLngs שמפוענחים מ-DeliveryVehicle.current_route_segment (gRPC) או מ-DeliveryVehicle.currentRouteSegment (REST). ההגדרה הזו מספקת את נתיב הנסיעה מהמיקום האחרון הידוע של אפליקציית הנהג ולא מנתיב הנסיעה מהתחנה הקודמת.

VehicleStop

מתארת נקודה שבה הרכב עוצר כדי לבצע שנייה אחת או יותר של Task.

שדות
planned_location

LocationInfo

חובה. מיקום התחנה. לתשומת ליבך: ייתכן שהמיקומים בTask לא תואמים בדיוק למיקום הזה, אבל הם יהיו במרחק קצר ממנו. השדה הזה לא יאוכלס בתגובה של GetTask או בתגובה לקריאה ל-SearchTasks.

tasks[]

TaskInfo

רשימת הTask שצריך לבצע בתחנה הזו. השדה הזה לא יאוכלס בתגובה לקריאה ל-GetTask או ל-SearchTasks.

state

State

המדינה של VehicleStop. השדה הזה לא יאוכלס בתגובה של GetTask או בתגובה לקריאה ל-SearchTasks.

ארץ

המצב הנוכחי של VehicleStop.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED לא ידוע.
NEW הניתוב נוצר, אבל לא הניתוב באופן פעיל.
ENROUTE הוקצתה וניתוב באופן פעיל.
ARRIVED הגעת לעצירה. ההנחה היא שכשהרכב במסלול לתחנה הבאה, כל העצירות הקודמות הושלמו.

TaskInfo

מידע נוסף על המשימה שבוצעה בעצירה הזו.

שדות
task_id

string

מזהה המשימה. השדה הזה לא יאוכלס בתגובה של GetTask או בתגובה לקריאה ל-SearchTasks. מזהי המשימות כפופים להגבלות הבאות:

  • חייבת להיות מחרוזת Unicode חוקית.
  • מוגבל לאורך מקסימלי של 64 תווים.
  • מנורמל לפי טופס נירמול Unicode C.
  • אינו יכול להכיל אף אחד מתווי ה-ASCII הבאים: '/', ':', '?', ',' או '#'.
task_duration

Duration

פלט בלבד. הזמן הנדרש לביצוע המשימה.

target_time_window

TimeWindow

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