Package google.maps.navconnect.v1

インデックス

NavConnect クライアントが乗車を作成して取得するためのサービス。

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

旅行を作成します。モバイル アプリケーションが旅行を開始する前に呼び出す必要があります。返される旅行には auth_token フィールドが設定されます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • navigationconnect.trips.create

詳細については、IAM のドキュメントをご覧ください。

GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

ルートを取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • navigationconnect.trips.get

詳細については、IAM のドキュメントをご覧ください。

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}

route_polyline_format

RoutePolylineFormat

省略可。返すルート ポリラインの形式。設定されていない場合は、SIMPLE ルートのポリラインが返されます。

RoutePolylineFormat

ルートのポリラインの形式を指定します。

列挙型
ROUTE_POLYLINE_FORMAT_UNSPECIFIED ルートのポリライン形式が指定されていません。
SIMPLE ルートのポリラインは、google.type.LatLng で表される点の単純な配列として返されます。
ENCODED ルートのポリラインは、エンコードされた文字列として返されます。https://developers.google.com/maps/documentation/utilities/polylinealgorithm をご覧ください。
S2ENCODED ルートのポリラインは S2Polyline としてエンコードされます。https://s2geometry.io/devguide/basic_types.html をご覧ください。
GEO_JSON ルートのポリラインは GeoJSON LineString として返されます。https://tools.ietf.org/html/rfc7946#section-3.1.4 をご覧ください。

場所

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

フィールド
point

LatLng

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

source_time

Timestamp

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

server_time

Timestamp

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

ルート

ルートのポリライン。

フィールド
traffic_information[]

SpeedReadingInterval

出力専用。速度読み取り間隔として記述されたポリラインの交通情報。

注:

  • 期間は重複していません。
  • 間隔は連続しています。
  • 間隔はポリライン全体をカバーします。
  • 間隔はインデックスの昇順で並べ替えられます。
  • 速度は各間隔で指定されます。

共用体フィールド format。ルートの形式。

入力される形式は route_polyline_format パラメータによって制御されます。設定しない場合、デフォルトは単純なポリラインになります。format は次のいずれかになります。

simple_polyline

SimplePolyline

出力専用。ルートを latlng の単純なリストとして表します。

encoded_polyline

string

出力専用。エンコードされたポリラインとしてのルート。https://developers.google.com/maps/documentation/utilities/polylinealgorithm をご覧ください。

s2_polyline

bytes

出力専用。エンコードされた S2Polyline としてのルート。https://s2geometry.io/devguide/basic_types.html をご覧ください。

geo_json

Struct

出力専用。GeoJSON LineString としてのルート。https://tools.ietf.org/html/rfc7946#section-3.1.4 をご覧ください。

SimplePolyline

ポイントのシンプルなリストを使用してポリラインを表します。

フィールド
points[]

LatLng

出力専用。ポリラインを表す点の順序付きリスト。

SpeedReadingInterval

パスの連続するセグメントの交通密度インジケーター。ポイント P_0、P_1、...、P_N(ゼロベースのインデックス)を含むパスが指定された場合、SpeedReadingInterval は間隔を定義し、Speed カテゴリを使用してそのトラフィックを記述します。

フィールド
speed

Speed

出力専用。この間隔の交通速度。

start_polyline_point_index

int32

出力専用。パス内のこの間隔の開始インデックス。

end_polyline_point_index

int32

出力専用。パス内のこの間隔の終了インデックス。

速度

交通データに基づくポリラインの速度の分類。

列挙型
SPEED_UNSPECIFIED 速度が指定されていません。
NORMAL 通常の速度で、渋滞はありません。
SLOW 渋滞気味です。交通量は少ない~やや多いです。
TRAFFIC_JAM 交通の遅延(渋滞を含む)。

停止

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

フィールド
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

出力専用。乗車ステータス。

execution

TripExecution

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

create_time

Timestamp

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

update_time

Timestamp

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

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

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

TripConfig

旅行の構成。

フィールド
enable_high_frequency_updates

bool

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

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

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 の場合、このフィールドは無視されます。

enable_remaining_route_reporting

bool

省略可。乗車中の残りのルートのレポートを有効にするかどうか。

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

TripExecution

ルートの実行に関するデータ。

フィールド
origin

Location

出力専用。ルートの出発地。通常は、NavConnect ルートの開始時の運送業者の所在地です。

destination

Stop

出力専用。モバイル アプリケーションから報告された旅行の目的地。

location

Location

出力専用。運送業者の直近の位置情報を表す位置情報シグナル。利用可能な場合は、道路にスナップされた位置になります。

remaining_route

Route

出力専用。ルートの残りの部分のポリラインを提供します。

traveled_duration

Duration

出力専用。これまでの移動時間。

remaining_duration

Duration

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

traveled_distance_meters

int32

出力専用。原点からの移動距離(メートル単位)。

remaining_distance_meters

int32

出力専用。目的地までの残り距離(メートル単位)。

stop_added_in_route

bool

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