REST Resource: selection.v1.projects.selectedRoutes

リソース: SelectedRoute

SelectedRoute は、契約済みのユースケースで定期的に情報（所要時間など）を取得するルートを表します。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "state": enum (State),
  "routeAttributes": {
    string: string,
    ...
  },

  // Union field route_type can be only one of the following:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of list of possible types for union field route_type.
  "validationError": enum (ValidationError)
}
フィールド
name

string

ID。SelectedRoute のリソース名。

形式: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

省略可。ルートの表示名。これは、お客様が使用できる省略可能なフィールドです。一意である必要はありません。
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"。
state

enum (State)

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

map (key: string, value: string)

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

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
共用体フィールド route_type。現時点でサポートされているのは DynamicRoute のみです。route_type は次のいずれかになります。
dynamicRoute

object (DynamicRoute)

SelectedRoute は動的ルートです。
validationError

enum (ValidationError)

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

DynamicRoute

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

JSON 表現 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
フィールド
origin

object (LatLng)

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

object (LatLng)

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

object (LatLng)

省略可。ルート上の中間ウェイポイントのセット（終点を除く）。これらは常に通過点です。最大 25 個の中間ウェイポイントがサポートされています。適切に追加することで、実際のルートの変動を随時抑えることができます。

LatLng

緯度と経度のペアを表すオブジェクト。これは緯度を表す倍精度値と経度を表す倍精度値のペアで表現されます。特に明記されていない場合、このオブジェクトは WGS84 規格に準拠する必要があります。値は正規化範囲内で指定する必要があります。

JSON 表現 
{
  "latitude": number,
  "longitude": number
}
フィールド
latitude

number

緯度（度単位）。範囲 [-90.0, +90.0] 内になければなりません。
longitude

number

経度（度単位）。範囲 [-180.0, +180.0] 内になければなりません。

州名

選択したルートの状態。

列挙型
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 ルートの道路使用率が低い（通過する人が非常に少ない）。

メソッド

batchCreate

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

batchDelete

 指定したプロジェクトの複数の SelectedRoute リソースを削除します。

batchUpdate

 名前で指定された複数の SelectedRoute リソースを更新します。

create

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

delete

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

get

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

list

 指定したプロジェクトのすべての SelectedRoute リソースをページ分割して一覧表示します。

patch

 名前で指定された SelectedRoute を更新します。