REST Resource: selection.v1.projects.selectedRoutes

リソース: SelectedRoute

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError),
  "dynamicRouting": boolean
}
フィールド
name

string

ID。SelectedRoute のリソース名。

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

string

省略可。ルートの表示名。これは、お客様が使用できるオプションのフィールドです。一意である必要はありません。長さは 100 文字（Unicode コードポイントでカウント）に制限されています。
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)

省略可。選択したルートのカスタム属性。これらを追加すると、過去とリアルタイムのルート情報を取得するときに、ルートをフィルタリングまたはグループ化できます。ルートごとに最大 25 個の属性がサポートされます。各キーと値は空でない文字列にする必要があります。また、最大 100 文字（Unicode コードポイントでカウント）にすることができます。キーの先頭を goog にすることはできません。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
DynamicRoute のみがサポートされています。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
dynamicRoute

object (DynamicRoute)

SelectedRoute は動的ルートです。
相互に排他的なフィールドの終了。
validationError

enum (ValidationError)

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

boolean

省略可。true に設定すると、選択したルートは、入力されたウェイポイントに従って、ライブ交通状況に基づいて動的にルート変更できます。false に設定すると、選択されたルートは、ライブ トラフィックに依存しない固定ルートになり、作成時に計算されたトラフィックを考慮しないパスに従います。省略した場合、値はデフォルトで false になり、固定ルートであることを示します。

DynamicRoute

これは、ウェイポイント（出発地、目的地、中間地点）を含むルートを表します。実際のルートは、すべてのウェイポイントを通過することが保証されます。dynamicRouting が false に設定されている場合、実際のルートは交通状況に関係なく固定されます。dynamicRouting が true に設定されている場合、実際のルートは交通状況に応じて変更される可能性があります。

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 を更新します。