Package google.maps.roads.selection.v1

インデックス

RoadsSelection

Roads Selection API のサービス定義。

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

複数の SelectedRoute を作成し、各ルートのキャッシュ情報を定期的に取得するスケジュールを開始します。

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

SelectedRoute を作成し、ルートのキャッシュ情報を定期的に取得するスケジュールを開始します。

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

指定されたプロジェクトの指定された SelectedRoute を削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

名前で指定された SelectedRoute を取得します。

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

指定されたプロジェクトのすべての SelectedRoute をページネーションで一覧表示します。

認可スコープ

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

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

BatchCreateSelectedRoutesRequest

複数の SelectedRoute を作成するリクエスト。

フィールド
parent

string

省略可。選択したすべてのルートで共有されるプロジェクト リソース。形式: projects/{project} これが設定されている場合、CreateSelectedRouteRequest メッセージの親フィールドは空であるか、このフィールドと一致する必要があります。
requests[]

CreateSelectedRouteRequest

必須。作成する選択したルートを指定するリクエスト メッセージ。バッチで作成できる選択されたルートは最大 1,000 個です。

BatchCreateSelectedRoutesResponse

複数の SelectedRoute を作成したときのレスポンス。

フィールド
selected_routes[]

SelectedRoute

SelectedRoutes が作成されました。

CreateSelectedRouteRequest

SelectedRoute の作成リクエスト。

フィールド
parent

string

必須。SelectedRoute が作成されるプロジェクト。形式: projects/{project}
selected_route

SelectedRoute

必須。作成する SelectedRoute。
selected_route_id

string

省略可。SelectedRoute に使用する ID。SelectedRoute のリソース名の最終的なコンポーネントになります。

この値は 4 ～ 63 文字で、有効な文字は「a-z」、「A-Z」、「0-9」、「-」です。指定されていない場合や空の場合は、リソースの作成後に UUID が生成されます。

DeleteSelectedRouteRequest

SelectedRoute の削除をリクエストします。

フィールド
name

string

必須。削除する SelectedRoute の名前。形式: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

SelectedRoute を取得するリクエスト。

フィールド
name

string

必須。取得する SelectedRoute の名前。形式: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

SelectedRoute のリストを取得するリクエスト。

フィールド
parent

string

必須。親。すべての SelectedRoute がクエリされるプロジェクトです。形式: projects/{project}/selectedRoutes
page_size

int32

省略可。特定のページで返される結果の数。設定しない場合、デフォルト値は 100 です。値が 0 の場合、値はデフォルトに設定されます。最大値は 5,000 です。5,000 を超える値は 5,000 に設定されます。
page_token

string

省略可。前回の ListSelectedRoutes 呼び出しから受け取ったページトークン。

ListSelectedRoutesResponse

SelectedRoute のリストを返すレスポンス。

フィールド
selected_routes[]

SelectedRoute

リクエストで指定されたプロジェクトに保存されている SelectedRoutes のページ。
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドが空の場合、後続のページはありません。

SelectedRoute

SelectedRoute は、お客様が契約したユースケースの情報を定期的に取得したい特定のルート（所要時間など）を表します。

フィールド
name

string

ID。SelectedRoute のリソース名。

形式: projects/{project}/selectedRoutes/{selected_route}
display_name

string

省略可。ルートの表示名。これは、お客様が使用できる省略可能なフィールドです。一意である必要はありません。
create_time

Timestamp

出力専用。選択したルートが最初に作成された日時。
state

State

出力専用。選択したルートの状態。
route_attributes

map<string, string>

省略可。選択したルートのカスタム属性。追加すると、過去とリアルタイムのルート情報を取得するときにルートのフィルタリングやグループ化が可能になります。ルートごとに最大 10 個の属性がサポートされています。各キーと値は空でない文字列で、最大 100 文字まで使用できます。キーの先頭を「goog」にすることはできません。
共用体フィールド route_type。現在サポートされているのは DynamicRoute のみです。route_type は次のいずれかになります。
dynamic_route

DynamicRoute

SelectedRoute は動的ルートです。
validation_error

ValidationError

出力専用。状態が STATE_INVALID の場合に選択されたルートの検証エラー。

DynamicRoute

これは、経由地（出発地、目的地、中間地点）を含むルートを表します。実際のルートはすべての経由地を通過することが保証されていますが、交通状況の変化により随時変更される可能性があります。

フィールド
origin

LatLng

必須。ルートの出発地。
destination

LatLng

必須。ルートの終点。
intermediates[]

LatLng

省略可。ルート上の途中経由地（終点を除く）のセット。これらは常に通過点です。最大 25 個の中間地点がサポートされています。適切に追加することで、実際のルートのばらつきを軽減できます。

州

選択したルートの状態。

列挙型
STATE_UNSPECIFIED このルートの状態が設定されていません。
STATE_SCHEDULING ルートが作成され、スケジュール設定中です。
STATE_RUNNING ルートが作成され、アクティブなスケジュールが設定されている。
STATE_DELETING ルートが削除対象としてマークされています。
STATE_VALIDATING ルートの検証中です。
STATE_INVALID 検証条件のいずれかに基づいて、ルートが無効です。

ValidationError

選択したルートの検証エラー。

列挙型
VALIDATION_ERROR_UNSPECIFIED このルートの検証エラーが設定されていません。
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION ルートがプロジェクトの管轄外にある。
VALIDATION_ERROR_LOW_ROAD_USAGE 道路の利用頻度が低い（通行する人がほとんどいない）。