Package maps.fleetengine.v1

אינדקס

TripService

שירות ניהול נסיעות.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

יצירת נסיעה ב-Fleet Engine והחזרת הנסיעה החדשה.

GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

קבלת מידע על נסיעה אחת.

ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

דיווח על שימוש בנסיעות לחיוב.

SearchTrips

rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse)

הצגת כל הנסיעות ברכב ספציפי.

UpdateTrip

rpc UpdateTrip(UpdateTripRequest) returns (Trip)

עדכון נתוני הנסיעה.

VehicleService

שירות ניהול כלי רכב.

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

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

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

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

השדות הבאים של Vehicle מתעלמים כשיוצרים Vehicle:

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

כל שאר השדות הם אופציונליים, והמערכת משתמשת בהם אם הם צוינו.

GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

הפונקציה מחזירה רכב מ-Fleet Engine.

ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

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

SearchVehicles

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

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

UpdateVehicle

rpc UpdateVehicle(UpdateVehicleRequest) returns (Vehicle)

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

כשמעדכנים Vehicle, אי אפשר לעדכן את השדות הבאים כי הם מנוהלים על ידי השרת:

  • currentTrips
  • availableCapacity
  • current_route_segment_version
  • waypoints_version

גם לא ניתן לעדכן את הרכב name.

אם השדה attributes מתעדכן, כל המאפיינים של הרכב מוחלפים במאפיינים שצוינו בבקשה. אם רוצים לעדכן רק חלק מהמאפיינים, אפשר לעיין בשיטה UpdateVehicleAttributes. באופן דומה, אפשר לעדכן את השדה waypoints, אבל הוא חייב להכיל את כל נקודות העצירה ששמורות כרגע ברכב, ולא נקודות עצירה אחרות.

UpdateVehicleAttributes

rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse)

עדכון חלקי של מאפייני הרכב. רק המאפיינים שצוינו בבקשה יעודכנו. מאפיינים אחרים לא ישתנו. הערה: המצב שונה ב-UpdateVehicle, שבו כל השדה attributes יוחלף בשדה שמופיע ב-UpdateVehicleRequest, והמאפיינים שלא מופיעים בבקשה יוסרו.

BatteryInfo

מידע על הסוללה של המכשיר.

שדות
battery_status

BatteryStatus

סטטוס הסוללה, אם היא מלאה או נטענת וכו'.

power_source

PowerSource

סטטוס מקור החשמל של הסוללה.

battery_percentage

float

אחוז הטעינה הנוכחי של הסוללה [0-100].

BatteryStatus

סטטוס הסוללה, אם היא מלאה או נטענת וכו'.

טיפוסים בני מנייה (enum)
UNKNOWN_BATTERY_STATUS מצב הסוללה לא ידוע.
BATTERY_STATUS_CHARGING הסוללה נטענת.
BATTERY_STATUS_DISCHARGING הסוללה נטענת.
BATTERY_STATUS_FULL הסוללה מלאה.
BATTERY_STATUS_NOT_CHARGING הסוללה לא נטענת.
BATTERY_STATUS_POWER_LOW הסוללה חלשה.

BillingPlatformIdentifier

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

טיפוסים בני מנייה (enum)
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED ברירת מחדל. משמש לפלטפורמות לא ספציפיות.
SERVER הפלטפורמה היא שרת לקוח.
WEB הפלטפורמה היא דפדפן אינטרנט.
ANDROID הפלטפורמה היא מכשיר נייד עם Android.
IOS הפלטפורמה היא מכשיר נייד עם iOS.
OTHERS פלטפורמות אחרות שלא מפורטות ברשימה הזו.

ConsumableTrafficPolyline

צפיפות התנועה לאורך המסלול של הרכב.

שדות
speed_reading_interval[]

SpeedReadingInterval

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

encoded_path_to_waypoint

string

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

CreateTripRequest

הודעת הבקשה של CreateTrip.

שדות
header

RequestHeader

כותרת הבקשה הרגילה של Fleet Engine.

parent

string

חובה. הפורמט הנדרש הוא providers/{provider}. הספק חייב להיות מזהה הפרויקט (לדוגמה, sample-cloud-project) של פרויקט Google Cloud שבו חשבון השירות שמבצע את הקריאה הזו הוא חבר.

trip_id

string

חובה. מזהה נסיעה ייחודי. בכפוף להגבלות הבאות:

  • צריכה להיות מחרוזת Unicode חוקית.
  • האורך המקסימלי הוא 64 תווים.
  • מנורמלים לפי Unicode Normalization Form C.
  • אסור לכלול את תווים ה-ASCII הבאים: '/',‏ ':',‏ '?',‏ ',' או '#'.
trip

Trip

חובה. ישות הנסיעה שרוצים ליצור.

כשיוצרים נסיעה, צריך למלא את השדות הבאים:

  • trip_type
  • pickup_point

אם תספקו את השדות הבאים, המערכת תשתמש בהם:

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

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

רק נסיעות מסוג EXCLUSIVE תומכות ב-intermediate_destinations.

כשהערך של vehicle_id מוגדר לנסיעה משותפת, צריך לספק את הרשימה של Trip.vehicle_waypoints כדי לציין את הסדר של נקודות הדרך הנותרות ברכב. אחרת, סדר נקודות הדרך לא יהיה ידוע.

כשמציינים את הערך Trip.vehicle_waypoints, הרשימה צריכה להכיל את כל נקודות העצירה הנותרות של הנסיעות ברכב, ללא נקודות עצירה נוספות. צריך לסדר את נקודות העצירה האלה כך שבנסיעה מסוימת, נקודת האיסוף תהיה לפני היעדים הביניים, וכל היעדים הביניים יהיו לפני נקודת ההורדה. נקודות הדרך של נסיעה מסוג EXCLUSIVE לא יכולות להיות משובצות בנסיעות אחרות.

המערכת משתמשת בשדות trip_id, ‏ waypoint_type ו-location, והיא מתעלמת מכל שאר השדות של TripWaypoint ב-vehicle_waypoints.

CreateVehicleRequest

CreateVehicle בקשה להודעה.

שדות
header

RequestHeader

כותרת הבקשה הרגילה של Fleet Engine.

parent

string

חובה. הפורמט הנדרש הוא providers/{provider}. הספק חייב להיות מזהה הפרויקט (לדוגמה, sample-cloud-project) של פרויקט Google Cloud שבו חשבון השירות שמבצע את הקריאה הזו הוא חבר.

vehicle_id

string

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

  • צריכה להיות מחרוזת Unicode חוקית.
  • האורך המקסימלי הוא 64 תווים.
  • מנורמלים לפי Unicode Normalization Form C.
  • אסור לכלול את תווים ה-ASCII הבאים: '/',‏ ':',‏ '?',‏ ',' או '#'.
vehicle

Vehicle

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

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

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

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

כל שאר השדות הם אופציונליים, והמערכת משתמשת בהם אם הם צוינו.

DeviceSettings

מידע על הגדרות שונות במכשיר הנייד.

שדות
location_power_save_mode

LocationPowerSaveMode

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

is_power_save_mode

bool

אם המכשיר נמצא כרגע במצב חיסכון בסוללה.

is_interactive

bool

אם המכשיר במצב אינטראקטיבי.

battery_info

BatteryInfo

מידע על מצב הסוללה.

GetTripRequest

הודעת הבקשה של GetTrip.

שדות
header

RequestHeader

כותרת הבקשה הרגילה של Fleet Engine.

name

string

חובה. הפורמט הנדרש הוא providers/{provider}/trips/{trip}. הספק חייב להיות מזהה הפרויקט (לדוגמה, sample-cloud-project) של פרויקט Google Cloud שבו חשבון השירות שמבצע את הקריאה הזו הוא חבר.

view

TripView

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

current_route_segment_version

Timestamp

השדה מציין את חותמת הזמן המינימלית (לא כולל) שלגביה מתבצעת אחזור של נתוני Trip.route או Trip.current_route_segment. אם נתוני המסלול לא השתנו מאז חותמת הזמן הזו, שדה המסלול לא מוגדר בתגובה. אם לא צוין ערך מינימלי, נתוני המסלול מאוחזרים תמיד.

remaining_waypoints_version

Timestamp

מציין את חותמת הזמן המינימלית (לא כולל) שלגביה מתבצעת אחזור של Trip.remaining_waypoints. אם הם לא השתנו מאז חותמת הזמן הזו, השדות remaining_waypoints לא מוגדרים בתגובה. אם לא מציינים את השדה הזה, תמיד מתבצע אחזור של remaining_waypoints.

route_format_type

PolylineFormatType

הפורמט של המסלול הנוכחי שמוחזר, LAT_LNG_LIST_TYPE (ב-Trip.route) או ENCODED_POLYLINE_TYPE (ב-Trip.current_route_segment). ברירת המחדל היא LAT_LNG_LIST_TYPE.

current_route_segment_traffic_version

Timestamp

מציין את חותמת הזמן המינימלית (לא כולל) שלגביה מתבצע אחזור של Trip.current_route_segment_traffic. אם נתוני התנועה לא השתנו מאז חותמת הזמן הזו, השדה current_route_segment_traffic לא מוגדר בתגובה. אם לא צוין מינימום, נתוני התנועה תמיד מאוחזרים. לתשומת ליבכם: התכונה 'תנועה' זמינה רק ללקוחות עם פתרון לנסיעות ולמשלוחים על פי דרישה.

remaining_waypoints_route_version

Timestamp

מציין את חותמת הזמן המינימלית (לא כולל) שלגביה מתבצע אחזור של נתוני Trip.remaining_waypoints.traffic_to_waypoint ו-Trip.remaining_waypoints.path_to_waypoint. אם הנתונים לא השתנו מאז חותמת הזמן הזו, השדות שלמעלה לא מוגדרים בתגובה. אם לא מציינים את remaining_waypoints_route_version, תמיד מתבצעת אחזור של התנועה והנתיב.

GetVehicleRequest

GetVehicle בקשה להודעה.

שדות
header

RequestHeader

כותרת הבקשה הרגילה של Fleet Engine.

name

string

חובה. הפורמט הנדרש הוא providers/{provider}/vehicles/{vehicle}. הספק חייב להיות מזהה הפרויקט (לדוגמה, sample-cloud-project) של פרויקט Google Cloud שבו חשבון השירות שמבצע את הקריאה הזו הוא חבר.

current_route_segment_version

Timestamp

מציין את חותמת הזמן המינימלית (לא כולל) שלגביה מתבצע אחזור של Vehicle.current_route_segment. אם המסלול לא השתנה מאז חותמת הזמן הזו, השדה current_route_segment לא מוגדר בתגובה. אם לא מצוין ערך מינימלי, הערך של current_route_segment מאוחזר תמיד.

waypoints_version

Timestamp

מציין את חותמת הזמן המינימלית (לא כולל) שלגביה מתבצע אחזור של נתוני Vehicle.waypoints. אם נקודות הדרך לא השתנו מאז חותמת הזמן הזו, נתוני vehicle.waypoints לא מוגדרים בתגובה. אם לא מציינים את השדה הזה, תמיד מתבצע אחזור של vehicle.waypoints.

LicensePlate

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

שדות
country_code

string

חובה. קוד המדינה או האזור במאגר CLDR. לדוגמה, US לארצות הברית או IN להודו.

last_character

string

הספרה האחרונה של לוחית הרישוי או '-1' כדי לציין שאין ערך מספרי בלוחית הרישוי.

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

ListVehiclesRequest

ListVehicles בקשה להודעה.

שדות
header

RequestHeader

כותרת הבקשה הרגילה של Fleet Engine.

parent

string

חובה. הפורמט הנדרש הוא providers/{provider}. הספק חייב להיות מזהה הפרויקט (לדוגמה, sample-cloud-project) של פרויקט Google Cloud שבו חשבון השירות שמבצע את הקריאה הזו הוא חבר.

page_size

int32

המספר המקסימלי של כלי רכב להחזרה. ערך ברירת המחדל: 100.

page_token

string

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

minimum_capacity

Int32Value

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

trip_types[]

TripType

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

maximum_staleness

Duration

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

vehicle_type_categories[]

Category

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

required_attributes[]

string

מבצעי הקריאה יכולים ליצור פעולות לוגיות מורכבות באמצעות כל שילוב של השדות required_attributes,‏ required_one_of_attributes ו-required_one_of_attribute_sets.

required_attributes היא רשימה. ב-required_one_of_attributes נעשה שימוש בהודעה שמאפשרת רשימה של רשימות. בשילוב, שני השדות מאפשרים ליצור את הביטוי הזה:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

הגבלת התגובה לרכבים עם המאפיינים שצוינו. השדה הזה הוא פעולת התחברות/AND. אפשר להוסיף עד 50 מאפייני required_attributes. זהו המספר המקסימלי של מאפיינים שמותר להוסיף לרכב. כל מחרוזת חוזרת צריכה להיות בפורמט 'key:value'.

required_one_of_attributes[]

string

הגבלת התגובה לכלי רכב עם לפחות אחד מהמאפיינים שצוינו בכל VehicleAttributeList. בכל רשימה, הרכב חייב להתאים לפחות לאחד מהמאפיינים. השדה הזה הוא פעולת או/OR כוללנית בכל VehicleAttributeList ופעולת וג/AND על פני האוסף של VehicleAttributeList. כל מחרוזת חוזרת צריכה להיות בפורמט 'key1:value1|key2:value2|key3:value3'.

required_one_of_attribute_sets[]

string

required_one_of_attribute_sets מספק פונקציונליות נוספת.

בדומה ל-required_one_of_attributes, גם ב-required_one_of_attribute_sets נעשה שימוש בהודעה שמאפשרת רשימה של רשימות, ומאפשרת להשתמש בביטויים כמו זה:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

הגבלת התגובה לכלי רכב שתואמים לכל המאפיינים ב-VehicleAttributeList. בכל רשימה, הרכב חייב להתאים לכל המאפיינים. השדה הזה הוא פעולת התחברות (AND) בכל VehicleAttributeList ופעולת חיבור (OR) מקיפה על פני האוסף של VehicleAttributeList. כל מחרוזת חוזרת צריכה להיות בפורמט 'key1:value1|key2:value2|key3:value3'.

vehicle_state

VehicleState

הגבלת התגובה לרכבים עם מצב הרכב הזה.

on_trip_only

bool

החזרת הרכבים עם הנסיעות הנוכחיות בלבד.

filter

string

זה שינוי אופציונלי. שאילתת סינון שתחול כשמציגים רכבים. דוגמאות לתחביר של המסנן זמינות בכתובת http://aip.dev/160.

השדה הזה נועד להחליף את השדות required_attributes,‏ required_one_of_attributes ו-required_one_of_attributes_sets. אם מציינים כאן ערך שאינו ריק, השדות הבאים חייבים להיות ריקים: required_attributes,‏ required_one_of_attributes ו-required_one_of_attributes_sets.

המסנן הזה פועל כתנאי AND עם אילוצים אחרים, כמו vehicle_state או on_trip_only.

הערה: השאילתות היחידות שנתמכות הן על מאפייני כלי רכב (לדוגמה, attributes.<key> = <value> או attributes.<key1> = <value1> AND attributes.<key2> = <value2>). מספר ההגבלות המקסימלי שמותרים בשאילתת סינון הוא 50.

בנוסף, כל המאפיינים מאוחסנים כמחרוזות, כך שההשוואות היחידות הנתמכות למאפיינים הן השוואות בין מחרוזות. כדי להשוות לערכים מספריים או לערכים בוליאניים, צריך להוסיף לכל הערכים מירכאות מפורשות כדי שיוגדרו כמחרוזות (לדוגמה, attributes.<key> = "10" או attributes.<key> = "true").

viewport

Viewport

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

ListVehiclesResponse

הודעת התגובה ListVehicles.

שדות
vehicles[]

Vehicle

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

next_page_token

string

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

total_size

int64

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

LocationPowerSaveMode

איך מוגדרות תכונות המיקום במכשיר הנייד כשהתכונה 'חיסכון בסוללה' מופעלת במכשיר. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

טיפוסים בני מנייה (enum)
UNKNOWN_LOCATION_POWER_SAVE_MODE Undefined 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 יאט את כל הבקשות לספקים כשהמכשיר לא אינטראקטיבי.

LocationSensor

החיישן או השיטה ששימשו לקביעת המיקום.

טיפוסים בני מנייה (enum)
UNKNOWN_SENSOR החיישן לא צוין או לא ידוע.
GPS GPS או Assisted 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 של הרכב.
FLEET_ENGINE_LOCATION מיקום שמחושב על ידי Fleet Engine על סמך האותות שזמינים לו. פלט בלבד. הערך הזה יידחה אם הוא יקבל בבקשה.
FUSED_LOCATION_PROVIDER ספק המיקום המשולב של Android.
CORE_LOCATION ספק המיקום במערכות ההפעלה של Apple.

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

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

PolylineFormatType

סוג הפורמט של קווים פוליגונליים.

טיפוסים בני מנייה (enum)
UNKNOWN_FORMAT_TYPE הפורמט לא צוין או שהוא לא ידוע.
LAT_LNG_LIST_TYPE רשימה של google.type.LatLng.
ENCODED_POLYLINE_TYPE קו פוליגוני המקודד באמצעות אלגוריתם דחיסת קו פוליגוני. עדיין אין תמיכה בפענוח.

PowerSource

סוג המטען שמשמש לטעינה של הסוללה.

טיפוסים בני מנייה (enum)
UNKNOWN_POWER_SOURCE מקור החשמל לא ידוע.
POWER_SOURCE_AC מקור הכוח הוא מטען AC.
POWER_SOURCE_USB מקור החשמל הוא יציאת USB.
POWER_SOURCE_WIRELESS מקור הכוח הוא אלחוטי.
POWER_SOURCE_UNPLUGGED הסוללה לא מחוברת.

ReportBillableTripRequest

הודעת הבקשה של ReportBillableTrip.

שדות
name

string

חובה. הפורמט הנדרש הוא providers/{provider}/billableTrips/{billable_trip}. הספק חייב להיות מזהה הפרויקט (לדוגמה, sample-cloud-project) של פרויקט Google Cloud שבו חשבון השירות שמבצע את הקריאה הזו הוא חבר.

country_code

string

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

platform

BillingPlatformIdentifier

הפלטפורמה שבה הבקשה הוגשה.

related_ids[]

string

המזהים שקשורים ישירות לנסיעה שמדווחים עליה. בדרך כלל מדובר במזהים (לדוגמה, מזהי סשנים) של פעולות שבוצעו לפני ההזמנה, לפני שמזהה הנסיעה זמין. מספר ה-related_ids מוגבל ל-50.

solution_type

SolutionType

סוג הפתרון של מוצר GMP (למשל, ON_DEMAND_RIDESHARING_AND_DELIVERIES) ששימש לנסיעה שדווחה.

SolutionType

בורר לסוגי פתרונות שונים של נסיעה שדווחה.

טיפוסים בני מנייה (enum)
SOLUTION_TYPE_UNSPECIFIED ערך ברירת המחדל. כדי לשמור על תאימות לאחור, ה-API ישתמש ב-ON_DEMAND_RIDESHARING_AND_DELIVERIES כברירת מחדל, שהוא סוג הפתרון הראשון שנתמך.
ON_DEMAND_RIDESHARING_AND_DELIVERIES הפתרון הוא נסיעה משותפת ומשלוח על פי דרישה.

RequestHeader

RequestHeader מכיל שדות שקיימים בכל הבקשות ל-RPC של Fleet Engine.

שדות
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 שקוראת ל-API.

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

SdkType

סוגי ה-SDK האפשריים.

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

SearchTripsRequest

הודעת הבקשה של SearchTrips.

שדות
header

RequestHeader

כותרת הבקשה הרגילה של Fleet Engine.

parent

string

חובה. הפורמט הנדרש הוא providers/{provider}. הספק חייב להיות מזהה הפרויקט (לדוגמה, sample-cloud-project) של פרויקט Google Cloud שבו חשבון השירות שמבצע את הקריאה הזו הוא חבר.

vehicle_id

string

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

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
active_trips_only

bool

אם הערך מוגדר כ-true, התגובה תכלול נסיעות שמשפיעות על המסלול של הנהג.

page_size

int32

אם לא תגדירו את הערך, השרת יחליט כמה תוצאות להחזיר.

page_token

string

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

minimum_staleness

Duration

אם מצוין, הפונקציה מחזירה את הנסיעות שלא עודכנו אחרי השעה (current - minimum_staleness).

SearchTripsResponse

הודעת התגובה של SearchTrips.

שדות
trips[]

Trip

רשימת הנסיעות של הרכב המבוקש.

next_page_token

string

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

SearchVehiclesRequest

SearchVehicles בקשה להודעה.

שדות
header

RequestHeader

כותרת הבקשה הרגילה של Fleet Engine.

parent

string

חובה. הפורמט הנדרש הוא providers/{provider}. הספק חייב להיות מזהה הפרויקט (לדוגמה, sample-cloud-project) של פרויקט Google Cloud שבו חשבון השירות שמבצע את הקריאה הזו הוא חבר.

pickup_point

TerminalLocation

חובה. נקודת האיסוף שרוצים לחפש בסביבתה.

dropoff_point

TerminalLocation

המיקום המתוכנן של מסירת ההזמנה ללקוח. השדה הזה נדרש אם השדה trip_types מכיל את השדה TripType.SHARED.

pickup_radius_meters

int32

חובה. הגדרת רדיוס החיפוש של הרכב סביב נקודת האיסוף. יוצגו רק רכבים שנמצאים בתוך רדיוס החיפוש. הערך צריך להיות בין 400 ל-10,000 מטרים (כולל).

count

int32

חובה. מציין את המספר המקסימלי של כלי הרכב שיש להחזיר. הערך צריך להיות בין 1 ל-50 (כולל).

minimum_capacity

int32

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

trip_types[]

TripType

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

maximum_staleness

Duration

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

vehicle_types[]

VehicleType

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

required_attributes[]

VehicleAttribute

מבצעי הקריאה יכולים ליצור פעולות לוגיות מורכבות באמצעות כל שילוב של השדות required_attributes,‏ required_one_of_attributes ו-required_one_of_attribute_sets.

required_attributes היא רשימה. ב-required_one_of_attributes נעשה שימוש בהודעה שמאפשרת רשימה של רשימות. בשילוב, שני השדות מאפשרים ליצור את הביטוי הזה:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

הגבלת החיפוש רק לרכבים עם המאפיינים שצוינו. השדה הזה הוא פעולת התחברות/AND. אפשר להוסיף עד 50 מאפייני required_attributes. זהו המספר המקסימלי של מאפיינים שמותר להוסיף לרכב.

required_one_of_attributes[]

VehicleAttributeList

הגבלת החיפוש רק לכלי רכב שיש להם לפחות אחד מהמאפיינים שצוינו בכל VehicleAttributeList. בכל רשימה, הרכב חייב להתאים לפחות לאחד מהמאפיינים. השדה הזה הוא פעולת או/OR כוללנית בכל VehicleAttributeList ופעולת וג/AND על פני האוסף של VehicleAttributeList.

required_one_of_attribute_sets[]

VehicleAttributeList

required_one_of_attribute_sets מספק פונקציונליות נוספת.

בדומה ל-required_one_of_attributes, גם ב-required_one_of_attribute_sets נעשה שימוש בהודעה שמאפשרת רשימה של רשימות, ומאפשרת להשתמש בביטויים כמו זה:

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

הגבלת החיפוש רק לרכבים שיש להם את כל המאפיינים ב-VehicleAttributeList. בכל רשימה, הרכב חייב להתאים לכל המאפיינים. השדה הזה הוא פעולת התחברות (AND) בכל VehicleAttributeList ופעולת חיבור (OR) מקיפה באוסף של VehicleAttributeList.

order_by

VehicleMatchOrder

חובה. מציין את קריטריון הסדר הרצוי של התוצאות.

include_back_to_back

bool

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

ערך ברירת המחדל הוא false.

trip_id

string

הנסיעה שמשויכת ל-SearchVehicleRequest הזה.

current_trips_present

CurrentTripsPresent

האפשרות הזו מציינת אם רכבים עם נסיעות פעילות עומדים בדרישות החיפוש הזה. אם השדה trip_type כולל את השדה SHARED, צריך להגדיר לו ערך שאינו CURRENT_TRIPS_PRESENT_UNSPECIFIED.

filter

string

זה שינוי אופציונלי. שאילתת סינון שחלה במהלך חיפוש כלי רכב. דוגמאות לתחביר של המסנן זמינות בכתובת http://aip.dev/160.

השדה הזה נועד להחליף את השדות required_attributes,‏ required_one_of_attributes ו-required_one_of_attributes_sets. אם מציינים כאן ערך שאינו ריק, השדות הבאים חייבים להיות ריקים: required_attributes,‏ required_one_of_attributes ו-required_one_of_attributes_sets.

המסנן הזה פועל כתנאי AND עם אילוצים אחרים, כמו minimum_capacity או vehicle_types.

הערה: השאילתות היחידות שנתמכות הן על מאפייני כלי רכב (לדוגמה, attributes.<key> = <value> או attributes.<key1> = <value1> AND attributes.<key2> = <value2>). מספר ההגבלות המקסימלי שמותרים בשאילתת סינון הוא 50.

בנוסף, כל המאפיינים מאוחסנים כמחרוזות, כך שההשוואות היחידות הנתמכות למאפיינים הן השוואות בין מחרוזות. כדי להשוות לערכים מספריים או לערכים בוליאניים, צריך להוסיף לכל הערכים מירכאות מפורשות כדי שיוגדרו כמחרוזות (לדוגמה, attributes.<key> = "10" או attributes.<key> = "true").

CurrentTripsPresent

מציין את סוגי ההגבלות על הנסיעות הנוכחיות של הרכב.

טיפוסים בני מנייה (enum)
CURRENT_TRIPS_PRESENT_UNSPECIFIED הזמינות של כלי רכב עם נסיעות קיימת נתונה לשדה include_back_to_back.
NONE רכבים ללא נסיעות יכולים להופיע בתוצאות החיפוש. כשמשתמשים בערך הזה, הערך של include_back_to_back לא יכול להיות true.
ANY תוצאות החיפוש כוללות רכבים עם עד 5 נסיעות נוכחיות ו-10 נקודות דרך. כשמשתמשים בערך הזה, הערך של include_back_to_back לא יכול להיות true.

VehicleMatchOrder

מציין את הסדר של התאמות הרכב בתגובה.

טיפוסים בני מנייה (enum)
UNKNOWN_VEHICLE_MATCH_ORDER ברירת המחדל, משמשת להזמנת התאמות של כלי רכב לא ספציפיים או לא מזוהים.
PICKUP_POINT_ETA בסדר עולה לפי זמן הנסיעה ברכב לנקודת האיסוף.
PICKUP_POINT_DISTANCE מיון בסדר עולה לפי מרחק הנסיעה ברכב לנקודת האיסוף.
DROPOFF_POINT_ETA בסדר עולה לפי זמן הנסיעה של הרכב לנקודת המסירה. אפשר להשתמש בהזמנה הזו רק אם נקודת המסירה צוינה בבקשה.
PICKUP_POINT_STRAIGHT_DISTANCE מיון בסדר עולה לפי המרחק בקו ישר מהמיקום האחרון שדווח על הרכב לנקודת האיסוף.
COST סדר עולה לפי עלות ההתאמה שהוגדרה. עלות ההתאמה מוגדרת כחישוב משוקלל בין המרחק בקו ישר לבין זמן ההגעה המשוער. המשקלים מוגדרים בערכי ברירת מחדל, ואפשר לשנות אותם לפי לקוח. אם צריך לשנות את המשקלים האלה בפרויקט, צריך לפנות לתמיכה של Google.

SearchVehiclesResponse

הודעת התגובה SearchVehicles.

שדות
matches[]

VehicleMatch

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

SpeedReadingInterval

אינדיקטור לצפיפות התנועה בקטע רציף של נתיב. בהינתן נתיב עם הנקודות P_0, ‏ P_1,‏ ... , ‏ P_N (אינדקס שמתחיל בספרה אפס), הפרמטר SpeedReadingInterval מגדיר מרווח זמן ומתאר את התנועה שלו באמצעות הקטגוריות הבאות.

שדות
start_polyline_point_index

int32

אינדקס ההתחלה של מרווח הזמן הזה בנתיב. ב-JSON, כשהאינדקס הוא 0, השדה נראה לא מאוכלס.

end_polyline_point_index

int32

האינדקס הסופי של המרווח הזה בנתיב. ב-JSON, כשהאינדקס הוא 0, השדה נראה לא מאוכלס.

speed

Speed

מהירות התנועה במרווח הזמן הזה.

מהירות

הסיווג של מהירות קו פוליגוני על סמך נתוני תנועה.

טיפוסים בני מנייה (enum)
SPEED_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
NORMAL מהירות רגילה, לא זוהתה האטה.
SLOW זוהתה האטה, אבל לא נוצרה פקק תנועה.
TRAFFIC_JAM זוהה פקק תנועה.

StopLocation

המיקום בפועל שבו התרחשה עצירה (איסוף/מסירה).

שדות
point

LatLng

חובה. מציין את המיקום בפועל.

timestamp

Timestamp

מתי הפסקת הפעילות התרחשה.

stop_time
(deprecated)

Timestamp

קלט בלבד. הוצא משימוש. משתמשים בשדה חותמת הזמן.

TerminalLocation

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

שדות
point

LatLng

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

terminal_point_id
(deprecated)

TerminalPointId

הוצא משימוש: צריך לציין את השדה point במקום זאת.

access_point_id
(deprecated)

string

הוצא משימוש: צריך לציין את השדה point במקום זאת.

trip_id
(deprecated)

string

הוצא משימוש.

terminal_location_type
(deprecated)

WaypointType

הנתונים האלה יהיו ב-Vehicle.waypoint.

TerminalPointId

הוצא משימוש: כבר אין תמיכה ב-TerminalPoints ב-Fleet Engine. במקום זאת, אתם צריכים להשתמש ב-TerminalLocation.point.

שדות
value
(deprecated)

string

הוצא משימוש.

שדה האיחוד Id. הוצא משימוש. הערך של Id יכול להיות רק אחת מהאפשרויות הבאות:
place_id
(deprecated)

string

הוצא משימוש.

generated_id
(deprecated)

string

הוצא משימוש.

TrafficPolylineData

מצב התנועה לאורך המסלול הצפוי של הרכב.

שדות
traffic_rendering

VisualTrafficReportPolylineRendering

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

נסיעה

מטא-נתונים של נסיעה.

שדות
name

string

פלט בלבד. בפורמט 'providers/{provider}/trips/{trip}'

vehicle_id

string

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

trip_status

TripStatus

הסטטוס הנוכחי של הנסיעה.

trip_type

TripType

סוג הנסיעה.

pickup_point

TerminalLocation

המיקום שבו הלקוח מציין שהוא רוצה לאסוף את ההזמנה.

actual_pickup_point

StopLocation

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

actual_pickup_arrival_point

StopLocation

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

pickup_time

Timestamp

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

intermediate_destinations[]

TerminalLocation

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

intermediate_destinations_version

Timestamp

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

intermediate_destination_index

int32

כש-TripStatus הוא ENROUTE_TO_INTERMEDIATE_DESTINATION, מספר בין [0..N-1] שמציין את היעד הביניים הבא שכלי הרכב יעבור דרכו. כשהערך של TripStatus הוא ARRIVED_AT_INTERMEDIATE_DESTINATION, מספר בין [0..N-1] שמציין את היעד הביניים שבו נמצא הרכב. הספק מגדיר את הערך הזה. אם אין intermediate_destinations, המערכת מתעלמת מהשדה הזה.

actual_intermediate_destination_arrival_points[]

StopLocation

קלט בלבד. המיקום והשעה בפועל שבהם הנהג הגיע ליעד ביניים. השדה הזה מיועד לספק כדי לספק משוב על פרטי ההגעה בפועל ליעדים ביניים.

actual_intermediate_destinations[]

StopLocation

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

dropoff_point

TerminalLocation

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

actual_dropoff_point

StopLocation

קלט בלבד. השעה והמיקום בפועל שבהם הלקוח ירד מהרכב. השדה הזה מיועד לספק כדי לספק משוב על פרטי ההורדה בפועל.

dropoff_time

Timestamp

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

remaining_waypoints[]

TripWaypoint

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

vehicle_waypoints[]

TripWaypoint

השדה הזה תומך בסדר ידני של נקודות העצירה בנסיעה. הוא מכיל את כל נקודות העצירה שנותרו ברכב שהוקצה, וגם את נקודות העצירה של האיסוף וההחזרה בנסיעה הזו. אם הנסיעה לא הוקצה לרכב, המערכת של Fleet Engine תתעלם מהשדה הזה. מטעמי פרטיות, השדה הזה מאוכלס על ידי השרת רק בקריאות UpdateTrip ו-CreateTrip, ולא בקריאות GetTrip.

route[]

LatLng

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

current_route_segment

string

פלט בלבד. נתיב מוצפן לנקודת הציון הבאה.

הערה: השדה הזה מיועד לשימוש רק ב-Driver SDK וב-Consumer SDK. עדיין אין תמיכה בפענוח.

current_route_segment_version

Timestamp

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

הערה: השדה הזה מיועד לשימוש רק ב-Driver SDK וב-Consumer SDK.

current_route_segment_traffic

ConsumableTrafficPolyline

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

הערה: השדה הזה מיועד לשימוש רק ב-Driver SDK וב-Consumer SDK.

current_route_segment_traffic_version

Timestamp

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

הערה: השדה הזה מיועד לשימוש רק ב-Driver SDK וב-Consumer SDK.

current_route_segment_end_point

TripWaypoint

פלט בלבד. נקודת הציון שבה מסתיים current_route_segment.

remaining_distance_meters

Int32Value

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

eta_to_first_waypoint

Timestamp

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

remaining_time_to_first_waypoint

Duration

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

remaining_waypoints_version

Timestamp

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

remaining_waypoints_route_version

Timestamp

פלט בלבד. השדה הזה מציין את הפעם האחרונה שבה השדות remaining_waypoints.path_to_waypoint ו-remaining_waypoints.traffic_to_waypoint שונו. אפליקציית הלקוח צריכה לשמור את הערך הזה במטמון ולהעביר אותו ב-GetTripRequest כדי לוודא שהנתיבים והתנועה של remaining_waypoints יחזרו רק אם הם עודכנו.

number_of_passengers

int32

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

last_location

VehicleLocation

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

last_location_snappable

bool

פלט בלבד. התנאי מציין אם אפשר להצמיד את last_location של הרכב ל-current_route_segment. False אם last_location או current_route_segment לא קיימים. הערך הזה מחושב על ידי Fleet Engine. המערכת תתעלם מכל עדכון מהלקוחות.

view

TripView

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

TripStatus

הסטטוס של נסיעה שמציין את ההתקדמות שלה.

טיפוסים בני מנייה (enum)
UNKNOWN_TRIP_STATUS ברירת המחדל, משמשת לסטטוס נסיעה לא צוין או לא מזוהה.
NEW נסיעה חדשה שנוצרה.
ENROUTE_TO_PICKUP הנהג בדרך לנקודת האיסוף.
ARRIVED_AT_PICKUP הנהג הגיע לנקודת האיסוף.
ARRIVED_AT_INTERMEDIATE_DESTINATION הנהג הגיע ליעד ביניים ומחכה לנוסע/ת.
ENROUTE_TO_INTERMEDIATE_DESTINATION הנהג בדרך ליעד ביניים (לא לנקודת ההורדה).
ENROUTE_TO_DROPOFF הנהג או הנהגת העלו את הנוסע או הנוסעת לרכב והם בדרך ליעד הבא.
COMPLETE הנוסע/ת ירד/ה מהרכב והנסיעה הסתיימה.
CANCELED הנסיעה בוטלה לפני האיסוף על ידי הנהג, הנוסע או ספק שיתוף הנסיעה.

TripType

סוג הנסיעה.

טיפוסים בני מנייה (enum)
UNKNOWN_TRIP_TYPE ברירת המחדל, משמשת לסוגים של נסיעות שלא צוינו או לא זוהו.
SHARED יכול להיות שהנסיעה תשתמש ברכב עם נסיעות אחרות.
EXCLUSIVE הנסיעה היא ייעודית לרכב.

TripView

בורר לקבוצות שונות של שדות 'נסיעה' בתגובה מסוג GetTrip. הקשר זמין במאמר AIP-157. סביר להניח שיתווספו עוד תצוגות.

טיפוסים בני מנייה (enum)
TRIP_VIEW_UNSPECIFIED ערך ברירת המחדל. כדי לשמור על תאימות לאחור, תצוגת ה-SDK תהיה ברירת המחדל של ה-API. כדי להבטיח יציבות ותמיכה, מומלץ ללקוחות לבחור TripView שאינו SDK.
SDK כולל שדות שעשויים להיות בלתי מובנים או לא נתמכים באמצעות ספריות שזמינות לציבור.
JOURNEY_SHARING_V1S השדות של הנסיעה מאוכלסים בתרחיש לדוגמה של שיתוף המסלול. התצוגה הזו מיועדת לתקשורת בין שרתים.

TripWaypoint

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

שדות
location

TerminalLocation

המיקום של נקודת הציון הזו.

trip_id

string

הנסיעה שמשויכת לנקודת הציון הזו.

waypoint_type

WaypointType

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

path_to_waypoint[]

LatLng

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

encoded_path_to_waypoint

string

הנתיב המקודד מנקודת הציון הקודמת לנקודת הציון הנוכחית.

הערה: השדה הזה מיועד לשימוש רק ב-Driver SDK וב-Consumer SDK. עדיין אין תמיכה בפענוח.

traffic_to_waypoint

ConsumableTrafficPolyline

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

distance_meters

Int32Value

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

eta

Timestamp

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

duration

Duration

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

UpdateTripRequest

הודעת הבקשה של UpdateTrip.

שדות
header

RequestHeader

כותרת הבקשה הרגילה של Fleet Engine.

name

string

חובה. הפורמט הנדרש הוא providers/{provider}/trips/{trip}. הספק חייב להיות מזהה הפרויקט (לדוגמה, sample-consumer-project) של פרויקט Google Cloud שבו חשבון השירות שמבצע את הקריאה הזו הוא חבר.

trip

Trip

חובה. הנסיעה שמשויכת לעדכון.

השדות הבאים נשמרים על ידי מנוע Fleet. אין לעדכן אותם באמצעות Trip.update.

  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_traffic
  • current_route_segment_traffic_version
  • current_route_segment_version
  • dropoff_time
  • eta_to_next_waypoint
  • intermediate_destinations_version
  • last_location
  • name
  • number_of_passengers
  • pickup_time
  • remaining_distance_meters
  • remaining_time_to_first_waypoint
  • remaining_waypoints
  • remaining_waypoints_version
  • route

כשמעדכנים את Trip.vehicle_id של נסיעה משותפת, צריך לספק את רשימת Trip.vehicle_waypoints כדי לציין את הסדר של נקודות העצירה הנותרות, אחרת הסדר לא יהיה מוגדר.

כשמציינים את הערך Trip.vehicle_waypoints, הרשימה צריכה להכיל את כל נקודות העצירה הנותרות של הנסיעות ברכב, ללא נקודות עצירה נוספות. צריך לסדר את נקודות העצירה האלה כך שבנסיעה מסוימת, נקודת האיסוף תהיה לפני היעדים הביניים, וכל היעדים הביניים יהיו לפני נקודת ההורדה. נקודות הדרך של נסיעה מסוג EXCLUSIVE לא יכולות להיות משובצות בנסיעות אחרות. המערכת משתמשת בשדות trip_id, ‏ waypoint_type ו-location, והיא מתעלמת מכל שאר השדות של TripWaypoint ב-vehicle_waypoints.

כדי למנוע מצב מרוץ בנסיעות עם כמה יעדים, צריך לספק את הערך Trip.intermediate_destinations_version כשמעדכנים את סטטוס הנסיעה ל-ENROUTE_TO_INTERMEDIATE_DESTINATION. הערך של Trip.intermediate_destinations_version שעבר צריך להיות תואם לגרסה של Fleet Engine. אם הוא לא תואם, הבקשה נכשלת.

update_mask

FieldMask

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

UpdateVehicleAttributesRequest

UpdateVehicleAttributes בקשה להודעה.

שדות
header

RequestHeader

כותרת הבקשה הרגילה של Fleet Engine.

name

string

חובה. הפורמט הנדרש הוא providers/{provider}/vehicles/{vehicle}. הספק חייב להיות מזהה הפרויקט (לדוגמה, sample-cloud-project) של פרויקט Google Cloud שבו חשבון השירות שמבצע את הקריאה הזו הוא חבר.

attributes[]

VehicleAttribute

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

UpdateVehicleAttributesResponse

הודעת התגובה UpdateVehicleAttributes.

שדות
attributes[]

VehicleAttribute

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

UpdateVehicleRequest

'UpdateVehicle request message'.

שדות
header

RequestHeader

כותרת הבקשה הרגילה של Fleet Engine.

name

string

חובה. הפורמט הנדרש הוא providers/{provider}/vehicles/{vehicle}. הערך של {provider} צריך להיות מזהה הפרויקט (לדוגמה, sample-cloud-project) ב-Google Cloud שבו חשבון השירות שמבצע את הקריאה הזו הוא חבר.

vehicle

Vehicle

חובה. הערכים של הישות Vehicle שיש להחיל. כשמעדכנים Vehicle, יכול להיות שהשדות הבאים לא יתעדכנו כי הם מנוהלים על ידי השרת.

  • available_capacity
  • current_route_segment_version
  • current_trips
  • name
  • waypoints_version

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

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

update_mask

FieldMask

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

כלי רכב

מטא-נתונים של הרכב.

שדות
name

string

פלט בלבד. השם הייחודי של הרכב. הפורמט הוא providers/{provider}/vehicles/{vehicle}.

vehicle_state

VehicleState

מצב הרכב.

supported_trip_types[]

TripType

סוגי הנסיעות שנתמכים ברכב הזה.

current_trips[]

string

פלט בלבד. רשימה של trip_id לנסיעות שהוקצתה כרגע לרכב הזה.

last_location

VehicleLocation

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

maximum_capacity

int32

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

attributes[]

VehicleAttribute

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

vehicle_type

VehicleType

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

license_plate

LicensePlate

פרטי לוחית הרישוי של הרכב.

route[]
(deprecated)

TerminalLocation

האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-Vehicle.waypoints.

current_route_segment

string

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

הערה: השדה הזה מיועד לשימוש רק ב-Driver SDK. עדיין אין תמיכה בפענוח.

current_route_segment_traffic

TrafficPolylineData

קלט בלבד. מערכת Fleet Engine משתמשת במידע הזה כדי לשפר את שיתוף המסלולים. הערה: השדה הזה מיועד לשימוש רק ב-Driver SDK.

current_route_segment_version

Timestamp

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

current_route_segment_end_point

TripWaypoint

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

remaining_distance_meters

Int32Value

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

eta_to_first_waypoint

Timestamp

זמן ההגעה המשוער (ETA) לרשומה הראשונה בשדה waypoints. הערך לא מצוין אם השדה waypoints ריק או אם השדה Vehicle.current_route_segment ריק.

כשמעדכנים רכב, הערך של remaining_time_seconds מקבל עדיפות על פני הערך של eta_to_first_waypoint באותה בקשה.

remaining_time_seconds

Int32Value

קלט בלבד. משך הנסיעה שנותר ב-current_route_segment. הערך לא מצוין אם השדה waypoints ריק או אם השדה Vehicle.current_route_segment ריק. הערך הזה צריך להיות זהה ל-eta_to_first_waypoint - current_time אם כל הצדדים משתמשים באותו שעון.

כשמעדכנים רכב, הערך של remaining_time_seconds מקבל עדיפות על פני הערך של eta_to_first_waypoint באותה בקשה.

waypoints[]

TripWaypoint

נקודות הדרך הנותרות שהוקצו לרכב הזה.

waypoints_version

Timestamp

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

back_to_back_enabled

bool

מציין אם הנהג/ת מקבל/ת נסיעות ברצף. אם true, SearchVehicles עשוי לכלול את הרכב גם אם הוא מוקצה כרגע לנסיעה. ערך ברירת המחדל הוא false.

navigation_status

NavigationStatus

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

device_settings

DeviceSettings

קלט בלבד. מידע על ההגדרות במכשיר הנייד שבו הנוסע משתמש.

VehicleType

סוג הרכב.

שדות
category

Category

קטגוריית סוג הרכב

קטגוריה

קטגוריות של סוגי כלי רכב

טיפוסים בני מנייה (enum)
UNKNOWN ברירת המחדל, משמשת לקטגוריות רכב לא מצוינות או לא מזוהות.
AUTO רכב.
TAXI כל רכב שמשמש כמונית (בדרך כלל רכב ברישיון או בפיקוח).
TRUCK באופן כללי, רכב עם קיבולת אחסון גדולה.
TWO_WHEELER אופנוע, טוסטוס או כלי רכב דו-גלגלי אחר
BICYCLE תחבורה מונעת על ידי אדם.
PEDESTRIAN אדם שנע, בדרך כלל הולך או רץ, בשבילים להולכי רגל.

VehicleAttribute

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

שדות
key

string

המפתח של המאפיין. מפתחות לא יכולים להכיל את התו פסיק נקודה (:).

value

string

הערך של המאפיין.

שדה האיחוד vehicle_attribute_value. ערך המאפיין יכול להיות מסוג מחרוזת, bool או double. הערך של vehicle_attribute_value יכול להיות רק אחת מהאפשרויות הבאות:
string_value

string

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

הערה: השדה הזה זהה לשדה value, שיוצא משימוש בסופו של דבר. בשיטות ליצירה או לעדכון, אפשר להשתמש בכל אחד מהשדות, אבל מומלץ מאוד להשתמש ב-string_value. אם גם string_value וגם value מוגדרים, הם חייבים להיות זהים, אחרת תופיע שגיאה. שני השדות מאוכלסים בתשובות.

bool_value

bool

ערך מאפיין מסוג בוליאני.

number_value

double

ערך מאפיין מסוג double.

VehicleAttributeList

סוג נתונים של רשימת רשימות למאפייני רכב.

שדות
attributes[]

VehicleAttribute

רשימת המאפיינים שבאוסף הזה.

VehicleLocation

המיקום, המהירות והכיוון של רכב בנקודת זמן מסוימת.

שדות
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

LocationSensor

ספק נתוני המיקום (לדוגמה, GPS).

is_road_snapped

BoolValue

האם location מוצמד לכביש.

is_gps_sensor_enabled

BoolValue

קלט בלבד. מציין אם חיישן ה-GPS מופעל במכשיר הנייד.

time_since_update

Int32Value

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

num_stale_updates
(deprecated)

Int32Value

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

raw_location

LatLng

מיקום הרכב הגולמי (לא עבר עיבוד על ידי road-snapper).

raw_location_time

Timestamp

חותמת הזמן שמשויכת למיקום הגולמי.

raw_location_sensor

LocationSensor

המקור של המיקום הגולמי. ברירת המחדל היא GPS.

raw_location_accuracy

DoubleValue

רמת הדיוק של raw_location כרדיום, במטרים.

supplemental_location

LatLng

מיקום משלים שמסופק על ידי האפליקציה המשולבת.

supplemental_location_time

Timestamp

חותמת הזמן שמשויכת למיקום המשלים.

supplemental_location_sensor

LocationSensor

המקור של המיקום המשלים. ברירת המחדל היא CUSTOMER_SUPPLIED_LOCATION.

supplemental_location_accuracy

DoubleValue

רמת הדיוק של supplemental_location כרדיום, במטרים.

road_snapped
(deprecated)

bool

האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-is_road_snapped.

VehicleMatch

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

שדות
vehicle

Vehicle

חובה. רכב שתואמת לבקשה.

vehicle_pickup_eta

Timestamp

זמן ההגעה המשוער של הרכב לנקודת האיסוף שצוינה בבקשה. ערך ריק מציין כשל בחישוב זמן ההגעה המשוער לרכב. אם הערך של SearchVehiclesRequest.include_back_to_back היה true ויש לרכב הזה נסיעה פעילה, הערך של vehicle_pickup_eta כולל את הזמן הנדרש להשלמת הנסיעה הפעילה הנוכחית.

vehicle_pickup_distance_meters

Int32Value

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

vehicle_pickup_straight_line_distance_meters

Int32Value

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

vehicle_dropoff_eta

Timestamp

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

vehicle_pickup_to_dropoff_distance_meters

Int32Value

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

trip_type

TripType

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

vehicle_trips_waypoints[]

Waypoint

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

vehicle_match_type

VehicleMatchType

סוג ההתאמה של הרכב.

requested_ordered_by

VehicleMatchOrder

הסדר המבוקש למיון ההתאמות של כלי הרכב. שווה ערך ל-ordered_by.

ordered_by

VehicleMatchOrder

הסדר המבוקש למיון ההתאמות של כלי הרכב. שווה ערך ל-requested_ordered_by.

VehicleMatchType

סוג ההתאמה של הרכב.

טיפוסים בני מנייה (enum)
UNKNOWN סוג התאמה לא ידוע של רכב
EXCLUSIVE אין כרגע נסיעה שהוקצה לה הרכב, והוא יכול להמשיך לנקודת האיסוף.
BACK_TO_BACK הרכב מוקצה כרגע לנסיעה, אבל הוא יכול להמשיך לנקודת האיסוף אחרי השלמת הנסיעה המתבצעת. חישובי המרחק וזמן ההגעה המשוער מבוססים על הנסיעה הקיימת.
CARPOOL ברכב יש מספיק מקום לנסיעה משותפת.
CARPOOL_BACK_TO_BACK הרכב ישלים את הנסיעה הפעילה הנוכחית לפני שהוא ימשיך לנקודת האיסוף. חישובי המרחק וזמן ההגעה המשוער מבוססים על הנסיעה הקיימת.

VehicleState

המצב של Vehicle.

טיפוסים בני מנייה (enum)
UNKNOWN_VEHICLE_STATE ברירת המחדל, משמשת למצבי רכב לא ספציפיים או לא מזוהים.
OFFLINE הרכב לא מקבל נסיעות חדשות. הערה: הרכב עשוי להמשיך לפעול במצב הזה בזמן השלמת נסיעה שהוקצה לו.
ONLINE הרכב מקבל נסיעות חדשות.

VisualTrafficReportPolylineRendering

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

שדות
road_stretch[]

RoadStretch

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

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

RoadStretch

מקטע כביש אחד שצריך ליצור לו עיבוד.

שדות
style

Style

חובה. הסגנון שרוצים להחיל.

offset_meters

int32

חובה. צריך להחיל את הסגנון בין [offset_meters, offset_meters + length_meters).

length_meters

int32

חובה. אורך הנתיב שבו רוצים להחיל את הסגנון.

סגנון

סגנון התנועה, שמציין את מהירות התנועה.

טיפוסים בני מנייה (enum)
STYLE_UNSPECIFIED לא נבחר סגנון.
SLOWER_TRAFFIC התנועה מתחילה להאט.
TRAFFIC_JAM יש פקק תנועה.

נקודת ציון

תיאור של נקודות ביניים לאורך מסלול של VehicleMatch ב-SearchVehiclesResponse. הקונספט הזה מיוצג כ-TripWaypoint בכל נקודות הקצה האחרות.

שדות
lat_lng

LatLng

המיקום של נקודת הציון הזו.

eta

Timestamp

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

WaypointType

סוג הנקודה.

טיפוסים בני מנייה (enum)
UNKNOWN_WAYPOINT_TYPE סוג של נקודת ציון לא ידוע או לא צוין.
PICKUP_WAYPOINT_TYPE נקודות דרך לאיסוף נוסעים או פריטים.
DROP_OFF_WAYPOINT_TYPE נקודות דרך להורדת נוסעים או פריטים.
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE ציוני דרך ליעדים ביניים בנסיעה עם כמה יעדים.