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 request:
  "dynamicRoute": {
    object (DynamicRoute)
  }
  // End of mutually exclusive fields.
  "validationError": enum (ValidationError)
}
欄位
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。以下列出互斥的欄位。要求中最多只能設定一個欄位：
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。