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

僅供輸出。ID。行程的資源名稱。格式：projects/{project_number}/trips/{tripId}。
config

object (TripConfig)

不可變動。行程設定。
androidAppId

string

僅供輸入。不可變動。使用行程的行動應用程式 Android 應用程式 ID。至少須設定 androidAppId 或 iosAppId 其中一項。
iosAppId

string

僅供輸入。不可變動。使用行程的行動應用程式 iOS 軟體包 ID。至少須設定 androidAppId 或 iosAppId 其中一項。
authToken

object (AuthToken)

僅供輸出。不透明權杖，可授權開始在 Google 地圖或 Waze 中進行 NavConnect 行程，並授予這些應用程式更新行程的權限。僅由 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

(選用步驟) 是否為行程啟用 Pub/Sub 通知。
pubsubFieldMask

string (FieldMask format)

(選用步驟) 如果設定此欄位，只有指定子集的行程欄位會納入 pubsub 通知。

如未設定，所有行程欄位都會納入 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_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)

僅供輸出。目前為止的移動時間。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
remainingDuration

string (Duration format)

僅供輸出。Google 預估這趟行程的剩餘時間。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「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)

僅供輸出。折線上的車流量資訊，以速度讀取間隔表示。

NOTES:

  • 間隔不得重疊。
  • 間隔是連續的。
  • 間隔會涵蓋整條折線。
  • 間隔會依遞增的索引排序。
  • 每個間隔都會指定速度。

聯集欄位 format。路線格式。

填入的格式由 route_polyline_format 參數控制。如未設定，則預設為簡單的折線。format 只能是下列其中一項：
simplePolyline

object (SimplePolyline)

僅供輸出。以簡單的緯度和經度清單表示的路徑。
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)

僅供輸出。以 GeoJSON LineString 格式表示的路徑。請參閱 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

僅供輸出。路徑中這個間隔的結束索引。

速度

根據交通資訊分類折線速度。

列舉
SPEED_UNSPECIFIED 未指定速度。
NORMAL 車速正常，車流暢通。
SLOW 偵測到車速變慢，車流較少或中等。
TRAFFIC_JAM 車流堵塞，包括車輛完全無法移動。

方法

create

 建立行程。

get

 取得行程。