REST Resource: selection.v1.projects.selectedRoutes

Tài nguyên: SelectedRoute

SelectedRoute đại diện cho một tuyến đường cụ thể mà khách hàng muốn định kỳ truy xuất thông tin (ví dụ: thời lượng) cho các trường hợp sử dụng theo hợp đồng.

Biểu diễn dưới dạng 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)
}
Trường
name

string

Giá trị nhận dạng. Tên tài nguyên của SelectedRoute.

Định dạng: projects/{project}/selectedRoutes/{selectedRoute}
displayName

string

Không bắt buộc. Tên hiển thị của tuyến đường. Đây là trường không bắt buộc mà khách hàng có thể sử dụng. Giá trị này không nhất thiết phải là duy nhất.
createTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian tạo tuyến đường đã chọn lần đầu tiên.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
state

enum (State)

Chỉ có đầu ra. Trạng thái của tuyến đường đã chọn.
routeAttributes

map (key: string, value: string)

Không bắt buộc. Các thuộc tính tuỳ chỉnh của tuyến đường đã chọn. Việc thêm các tham số này cho phép lọc / nhóm các tuyến đường khi truy xuất thông tin về tuyến đường trước đây và theo thời gian thực. Mỗi tuyến đường hỗ trợ tối đa 10 thuộc tính. Mỗi khoá và giá trị phải là một chuỗi có nội dung và có thể chứa tối đa 100 ký tự. Các khoá không được bắt đầu bằng "goog".

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Trường nhóm route_type. Hiện tại, chỉ có DynamicRoute được hỗ trợ. route_type chỉ có thể là một trong những trạng thái sau:
dynamicRoute

object (DynamicRoute)

SelectedRoute là một tuyến đường động.
validationError

enum (ValidationError)

Chỉ có đầu ra. Lỗi xác thực cho tuyến đường đã chọn khi trạng thái là STATE_INVALID.

DynamicRoute

Đây là tuyến đường có các điểm tham chiếu (điểm khởi hành, điểm đến và điểm trung gian). Đảm bảo rằng tuyến đường thực tế sẽ đi qua tất cả các điểm tham chiếu, nhưng tuyến đường này có thể thay đổi theo thời gian do điều kiện giao thông thay đổi.

Biểu diễn dưới dạng JSON 
{
  "origin": {
    object (LatLng)
  },
  "destination": {
    object (LatLng)
  },
  "intermediates": [
    {
      object (LatLng)
    }
  ]
}
Trường
origin

object (LatLng)

Bắt buộc. Vị trí khởi hành của tuyến đường.
destination

object (LatLng)

Bắt buộc. Vị trí kết thúc của tuyến đường.
intermediates[]

object (LatLng)

Không bắt buộc. Một tập hợp các điểm tham chiếu trung gian dọc theo tuyến đường (không bao gồm các điểm cuối). Chúng luôn là các điểm đi qua. Hỗ trợ tối đa 25 điểm tham chiếu trung gian. Việc thêm các điểm này một cách thích hợp có thể giảm sự khác biệt giữa tuyến đường thực tế theo thời gian.

LatLng

Một đối tượng đại diện cho cặp vĩ độ/kinh độ. Thông tin này được biểu thị dưới dạng một cặp số có độ chính xác kép để biểu thị vĩ độ và kinh độ theo độ. Trừ phi có quy định khác, đối tượng này phải tuân thủ tiêu chuẩn WGS84. Giá trị phải nằm trong phạm vi được chuẩn hoá.

Biểu diễn dưới dạng JSON 
{
  "latitude": number,
  "longitude": number
}
Trường
latitude

number

Vĩ độ tính bằng độ. Giá trị này phải nằm trong khoảng [-90.0, +90.0].
longitude

number

Kinh độ tính bằng độ. Giá trị này phải nằm trong khoảng [-180.0, +180.0].

Tiểu bang

Trạng thái của tuyến đường đã chọn.

Enum
STATE_UNSPECIFIED Trạng thái của tuyến đường này chưa được đặt.
STATE_SCHEDULING Tuyến đường đã được tạo và đang được lên lịch.
STATE_RUNNING Tuyến đường đã được tạo và có lịch biểu đang hoạt động.
STATE_DELETING Tuyến đường đã được đánh dấu để xoá.
STATE_VALIDATING Tuyến đường đang trong quá trình xác thực.
STATE_INVALID Tuyến đường không hợp lệ dựa trên một trong các tiêu chí xác thực.

ValidationError

Lỗi xác thực cho tuyến đường đã chọn.

Enum
VALIDATION_ERROR_UNSPECIFIED Lỗi xác thực của tuyến đường này chưa được đặt.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION Tuyến đường nằm ngoài phạm vi quản lý của dự án.
VALIDATION_ERROR_LOW_ROAD_USAGE Tuyến đường có ít người sử dụng (rất ít người đi qua).

Phương thức

batchCreate

 Tạo nhiều SelectedRoutes và bắt đầu một lịch biểu để định kỳ truy xuất thông tin về bộ nhớ đệm cho từng tuyến đường.

create

 Tạo một SelectedRoute và bắt đầu một lịch biểu để định kỳ truy xuất thông tin bộ nhớ đệm cho tuyến đường.

delete

 Xoá SelectedRoute đã chỉ định cho dự án đã chỉ định.

get

 Lấy một SelectedRoute như được chỉ định theo tên của tuyến đường đó.

list

 Liệt kê tất cả SelectedRoutes cho dự án đã chỉ định có phân trang.