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,
  "enableRemainingRouteReporting": boolean
}
שדות
enableHighFrequencyUpdates

boolean

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

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

boolean

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

string (FieldMask format)

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

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

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

  • androidAppId
  • iosAppId
  • authToken
  • config

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

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

boolean

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

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

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

TripExecution

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

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

object (Location)

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

object (Stop)

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

object (Location)

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

object (Route)

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

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

מסלול

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

ייצוג ב-JSON 
{
  "trafficInformation": [
    {
      object (SpeedReadingInterval)
    }
  ],

  // Union field format can be only one of the following:
  "simplePolyline": {
    object (SimplePolyline)
  },
  "encodedPolyline": string,
  "s2Polyline": string,
  "geoJson": {
    object
  }
  // End of list of possible types for union field format.
}
שדות
trafficInformation[]

object (SpeedReadingInterval)

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

הערות:

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

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

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

object (SimplePolyline)

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

string

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

string (bytes format)

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

מחרוזת בקידוד Base64.
geoJson

object (Struct format)

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

SimplePolyline

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

ייצוג ב-JSON 
{
  "points": [
    {
      object (LatLng)
    }
  ]
}
שדות
points[]

object (LatLng)

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

SpeedReadingInterval

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

ייצוג ב-JSON 
{
  "speed": enum (Speed),
  "startPolylinePointIndex": integer,
  "endPolylinePointIndex": integer
}
שדות
speed

enum (Speed)

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

integer

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

integer

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

מהירות

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

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

Methods

create

 יצירת נסיעה.

get

 קבלת נסיעה.