Package google.maps.navconnect.v1

אינדקס

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

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

קבלת נסיעה.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform

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}

מיקום

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

שדות
point

LatLng

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

source_time

Timestamp

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

server_time

Timestamp

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

עצירה

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

שדות
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 הנסיעה נכשלה בגלל שגיאה בצד הלקוח.

TripConfig

ההגדרה של הנסיעה.

שדות
enable_high_frequency_updates

bool

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

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

enable_pubsub

bool

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

pubsub_field_mask

FieldMask

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

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

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

  • android_app_id
  • ios_app_id
  • auth_token
  • config

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

TripExecution

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

שדות
origin

Location

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

destination

Stop

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

location

Location

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

traveled_duration

Duration

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

remaining_duration

Duration

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

traveled_distance_meters

int32

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

remaining_distance_meters

int32

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

stop_added_in_route

bool

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