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，並啟動排程，定期擷取每個路徑的快取資訊。

create

 建立 SelectedRoute，並啟動排程，定期擷取路線的快取資訊。

delete

 刪除指定專案的指定 SelectedRoute。

get

 取得指定名稱的 SelectedRoute。

list

 列出指定專案的所有 SelectedRoute，並提供分頁功能。