Package google.maps.navconnect.v1

אינדקס

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

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • navigationconnect.trips.create

מידע נוסף מופיע במאמרי העזרה בנושא IAM.
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

קבלת נסיעה.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • navigationconnect.trips.get

מידע נוסף מופיע במאמרי העזרה בנושא IAM.

AuthToken

טוקן אימות.

שדות
token

string

פלט בלבד. אסימון האימות שצריך להעביר לאפליקציה לנייד.
expire_time

Timestamp

פלט בלבד. השעה שבה יפוג התוקף של טוקן האימות.

CreateTripRequest

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

שדות
parent

string

חובה. משאב האב שמתחתיו תיצור הנסיעה הזו. פורמט: projects/{project_number}
trip_id

string

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

הערך הזה חייב להיות מזהה ייחודי אוניברסלי (UUID) תקין לפי RFC-4122.
trip

Trip

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

GetTripRequest

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

שדות
name

string

חובה. שם המשאב של הטיול שרוצים לאחזר. פורמט: projects/{project}/trips/{trip_id}
route_polyline_format

RoutePolylineFormat

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

RoutePolylineFormat

מציין את הפורמט של קו פוליגוני של המסלול.

טיפוסים בני מנייה (enum)
ROUTE_POLYLINE_FORMAT_UNSPECIFIED הפורמט של קו המסלול לא צוין.
SIMPLE הקו הפוליגוני של המסלול מוחזר כמערך פשוט של נקודות שמיוצגות כ-google.type.LatLng.
ENCODED קו הפוליגון של המסלול מוחזר כמחרוזת מקודדת. מידע נוסף זמין בכתובת https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
S2ENCODED הקו הפוליגוני של המסלול מקודד כ-S2Polyline. מידע נוסף זמין בכתובת https://s2geometry.io/devguide/basic_types.html.
GEO_JSON קו הפוליגון של המסלול מוחזר כ-LineString של GeoJSON. מידע נוסף זמין בכתובת https://tools.ietf.org/html/rfc7946#section-3.1.4.

מיקום

מיקום כפי שמדווח על ידי האפליקציה לנייד.

שדות
point

LatLng

פלט בלבד. קווי הרוחב והאורך של המיקום.
source_time

Timestamp

פלט בלבד. השעה שבה המיקום נלקח מהלקוח.
server_time

Timestamp

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

מסלול

קו פוליגוני של מסלול.

שדות
traffic_information[]

SpeedReadingInterval

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

הערות:

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

שדה האיחוד format. פורמט המסלול.

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

SimplePolyline

פלט בלבד. המסלול כרשימה פשוטה של קואורדינטות latitude ו-longitude.
encoded_polyline

string

פלט בלבד. המסלול כקו פוליגוני מקודד. מידע נוסף זמין בכתובת https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
s2_polyline

bytes

פלט בלבד. המסלול כ-S2Polyline מקודד. מידע נוסף זמין בכתובת https://s2geometry.io/devguide/basic_types.html.
geo_json

Struct

פלט בלבד. המסלול כ-LineString בפורמט GeoJSON. מידע נוסף זמין בכתובת https://tools.ietf.org/html/rfc7946#section-3.1.4.

SimplePolyline

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

שדות
points[]

LatLng

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

SpeedReadingInterval

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

שדות
speed

Speed

פלט בלבד. מהירות התנועה במרווח הזה.
start_polyline_point_index

int32

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

int32

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

מהירות

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

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

עצירה

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

שדות
point

LatLng

חובה. המיקום של התחנה כקו רוחב/אורך.

נסיעה

נסיעה.

שדות
name

string

פלט בלבד. מזהה. שם המשאב של הנסיעה. פורמט: projects/{project_number}/trips/{trip_id}.
config

TripConfig

בלתי משתנה. ההגדרה של הנסיעה.
android_app_id

string

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

string

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

AuthToken

פלט בלבד. טוקן אטום שמאשר גישה להתחלת נסיעה ב-NavConnect במפות Google או ב-Waze, ומעניק לאפליקציות האלה גישה לעדכון הנסיעה. הוחזר רק על ידי CreateTrip.
state

State

פלט בלבד. מצב הנסיעה.
execution

TripExecution

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

Timestamp

פלט בלבד. השעה לפי השרת שבה הנסיעה נוצרה.
update_time

Timestamp

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

מדינה (State)

כל הסטטוסים האפשריים של הנסיעה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב הנסיעה לא צוין.
NEW הנסיעה נוצרה אבל עדיין לא התחילה.
ENROUTE המשאית בדרך ליעד.
ARRIVED הכלי להעברת נתונים הגיע ליעד.
SUSPENDED הנסיעה הושעתה.
FAILED הנסיעה לא הושלמה בהצלחה.
CLIENT_ERROR הנסיעה נכשלה בגלל שגיאה בצד הלקוח.
CANCELED הנסיעה בוטלה באופן מפורש על ידי המפתח.

TripConfig

הגדרות הנסיעה.

שדות
enable_high_frequency_updates

bool

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

הערה: הפעלת התכונה הזו מתעדת את הנסיעה בשימוש ברמת Enterprise, והיא כפופה לתעריפים של רמת Enterprise.
enable_pubsub

bool

אופציונלי. האם להפעיל התראות pubsub לגבי הנסיעה.
pubsub_field_mask

FieldMask

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

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

אין תמיכה בשדות הבאים:

  • android_app_id
  • ios_app_id
  • auth_token
  • config

הערה: המערכת מתעלמת מהשדה הזה אם הערך של enable_pubsub הוא false.
enable_remaining_route_reporting

bool

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

הערה: אם מפעילים את התכונה הזו, הנסיעה מתועדת בשימוש ברמת Enterprise, והיא כפופה לתעריפים של רמת Enterprise.

TripExecution

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

שדות
origin

Location

פלט בלבד. מקור הנסיעה, בדרך כלל המיקום של המוביל בתחילת הנסיעה ב-NavConnect.
destination

Stop

פלט בלבד. היעד של הנסיעה כפי שמדווח באפליקציה לנייד.
location

Location

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

Route

פלט בלבד. הפונקציה מחזירה את הקו הפוליגוני של החלק הנותר של המסלול.
traveled_duration

Duration

פלט בלבד. הזמן שחלף מתחילת הנסיעה.
remaining_duration

Duration

פלט בלבד. הזמן שנותר בנסיעה הזו, לפי ההערכה של Google.
traveled_distance_meters

int32

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

int32

פלט בלבד. המרחק שנותר עד ליעד במטרים.
stop_added_in_route

bool

פלט בלבד. מציין אם נוספה עצירה לאורך המסלול.