REST Resource: projects.trips

リソース: Trip

旅行。

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 の少なくとも 1 つを設定する必要があります。
iosAppId

string

入力専用。変更不可。乗車に使用するモバイル アプリケーションの iOS バンドル ID。androidAppId または iosAppId の少なくとも 1 つを設定する必要があります。
authToken

object (AuthToken)

出力専用。Google マップまたは Waze で NavConnect のルートを開始するアクセスを承認し、これらのアプリにルートを更新するアクセス権を付与する不透明なトークン。trips.create によってのみ返されます。
state

enum (State)

出力専用。Trip の状態。
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 Tier の使用状況として記録され、Enterprise Tier の料金が適用されます。
enablePubsub

boolean

省略可。乗車に関する Pub/Sub 通知を有効にするかどうか。
pubsubFieldMask

string (FieldMask format)

省略可。設定されている場合、指定された Trip フィールドのサブセットのみが pubsub 通知に含まれます。

設定しない場合、すべての Trip フィールドが 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_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 で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
remainingDuration

string (Duration format)

出力専用。Google が推定したこの経路の残り時間。

s で終わる小数 9 桁までの秒単位の期間。例: "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)

必須。停留所の位置（緯度/経度）。

メソッド

create

 ルートを作成します。

get

 ルートを取得します。