REST Resource: projects.trips

משאב: נסיעה

נסיעה.

ייצוג JSON 
{
  "name": string,
  "config": {
    object (TripConfig)
  },
  "androidAppId": string,
  "iosAppId": string,
  "authToken": {
    object (AuthToken)
  },
  "state": enum (State),
  "execution": {
    object (TripExecution)
  },
  "createTime": string,
  "updateTime": string
}
שדות
name

string

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

object (TripConfig)

אי אפשר לשנות. ההגדרה של הנסיעה.
androidAppId

string

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

string

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

object (AuthToken)

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

enum (State)

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

object (TripExecution)

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

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

TripConfig

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

ייצוג JSON 
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string
}
שדות
enableHighFrequencyUpdates

boolean

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

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

boolean

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

string (FieldMask format)

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

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

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

  • androidAppId
  • iosAppId
  • authToken
  • config

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

זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: "user.displayName,photo"

AuthToken

טוקן אימות.

ייצוג JSON 
{
  "token": string,
  "expireTime": string
}
שדות
token

string

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

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

מדינה (State)

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

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

TripExecution

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

ייצוג JSON 
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
שדות
origin

object (Location)

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

object (Stop)

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

object (Location)

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

string (Duration format)

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

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".
remainingDuration

string (Duration format)

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

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".
traveledDistanceMeters

integer

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

integer

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

boolean

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

מיקום

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

ייצוג JSON 
{
  "point": {
    object (LatLng)
  },
  "sourceTime": string,
  "serverTime": string
}
שדות
point

object (LatLng)

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

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
serverTime

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

LatLng

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

ייצוג JSON 
{
  "latitude": number,
  "longitude": number
}
שדות
latitude

number

קו הרוחב במעלות. הערך חייב להיות בטווח [‎-90.0, ‎+90.0].
longitude

number

קו האורך במעלות. הערך חייב להיות בטווח [‎-180.0, ‎+180.0].

עצירה

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

ייצוג JSON 
{
  "point": {
    object (LatLng)
  }
}
שדות
point

object (LatLng)

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

Methods

create

 יצירת נסיעה.

get

 קבלת נסיעה.