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。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位：
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。