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

必須。乗車に使用する ID。乗車のリソース名の最終的なコンポーネントになります。

この値は、有効な RFC-4122 UUID である必要があります。

trip

Trip

必須。作成するルート。

GetTripRequest

NavConnectService.GetTrip に対するリクエスト メッセージ。

フィールド
name

string

必須。取得する乗車のリソース名。形式: projects/{project}/trips/{trip_id}

場所

モバイル アプリケーションから報告された位置情報。

フィールド
point

LatLng

出力専用。位置の緯度/経度。

source_time

Timestamp

出力専用。クライアントによって示された、位置情報の取得日時。

server_time

Timestamp

出力専用。サーバーがこの位置情報の更新を受信した時刻。

停止

ルート上の停車地。ここでタスクが実行されます。

フィールド
point

LatLng

必須。停留所の位置(緯度/経度)。

ルート

旅行。

フィールド
name

string

出力専用。ID。乗車のリソース名。形式: projects/{project_number}/trips/{trip_id}。

config

TripConfig

変更不可。乗車に関する構成。

android_app_id

string

入力専用。変更不可。旅行を使用するモバイル アプリケーションの Android アプリケーション ID。android_app_id または ios_app_id の少なくとも 1 つを設定する必要があります。

ios_app_id

string

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

auth_token

AuthToken

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

state

State

出力専用。Trip の状態。

execution

TripExecution

出力専用。ルートの実行に関する最新のデータ。旅行がエラー状態の場合、設定されないことがあります。

create_time

Timestamp

出力専用。乗車が作成されたときのサーバーの時刻。

update_time

Timestamp

出力専用。サーバーが最新の乗車情報の更新を受信した時刻。

考えられるすべての乗車状態。

列挙型
STATE_UNSPECIFIED 乗車状態が指定されていません。
NEW 旅行は作成されましたが、まだ開始されていません。
ENROUTE 運送業者が目的地に向かっています。
ARRIVED 運送業者が目的地に到着しました。
SUSPENDED 旅行が一時停止されました。
FAILED 乗車が正常に完了しませんでした。
CLIENT_ERROR クライアント エラーのため、乗車を完了できませんでした。

TripConfig

旅行の構成。

フィールド
enable_high_frequency_updates

bool

省略可。高頻度の乗車更新を有効にするかどうか。

注: この機能を有効にすると、乗車は Enterprise Tier の使用状況として記録され、Enterprise Tier の料金が適用されます。

enable_pubsub

bool

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

pubsub_field_mask

FieldMask

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

設定しない場合、すべての Trip フィールドが 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

出力専用。経路上に経由地が追加されたかどうかを示します。