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 truy xuất thông tin định kỳ (ví dụ: thời gian) 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,
    ...
  },

  // 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
}
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 tuỳ chọn 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. Độ dài được giới hạn ở 100 ký tự (được tính theo điểm mã Unicode).

createTime

string (Timestamp format)

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

Hãy dùng RFC 3339, trong đó dữ liệu đầ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 khoảng 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. Thuộc tính tuỳ chỉnh cho tuyến đường đã chọn. Việc thêm các trường này cho phép lọc hoặc nhóm các tuyến đường khi truy xuất thông tin về tuyến đường trong quá khứ và theo thời gian thực. Mỗi tuyến đường hỗ trợ tối đa 25 thuộc tính. Mỗi khoá và giá trị phải là một chuỗi không trống và có thể có tối đa 100 ký tự (được tính theo điểm mã Unicode). 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" }.

Chỉ hỗ trợ giá trị DynamicRoute. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
dynamicRoute

object (DynamicRoute)

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

Kết thúc các trường loại trừ lẫn nhau.
validationError

enum (ValidationError)

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

dynamicRouting

boolean

Không bắt buộc. Nếu bạn đặt thành true, thì tuyến đường đã chọn có thể tự động đổi tuyến dựa trên tình hình giao thông theo thời gian thực theo các điểm tham chiếu đã nhập. Nếu bạn đặt thành false, thì tuyến đường đã chọn sẽ là tuyến đường cố định không phụ thuộc vào tình hình giao thông trực tiếp và đi theo tuyến đường không nhận biết được tình hình giao thông được tính toán tại thời điểm tạo. Nếu bị bỏ qua, giá trị này sẽ là false theo mặc định, cho biết đây là tuyến cố định.

DynamicRoute

Đây là một tuyến đường có các điểm tham chiếu (điểm xuất phát, điểm đến và điểm trung gian). Tuyến đường thực tế chắc chắn sẽ đi qua tất cả các điểm tham chiếu. Nếu dynamicRouting được đặt thành false, thì tuyến đường thực tế sẽ không thay đổi bất kể tình trạng giao thông. Nếu không, nếu dynamicRouting được đặt thành true, thì tuyến đường thực tế có thể thay đổi dựa trên tình trạng giao thông.

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í điểm 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à đ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 dừng này một cách chính xác có thể giúp giảm sự khác biệt giữa các tuyến đường thực tế tuỳ từng thời điểm.

LatLng

Một đối tượng đại diện cho một cặp vĩ độ/kinh độ. Giá trị này được biểu thị dưới dạng một cặp số thực có độ chính xác gấp đôi để thể hiện độ vĩ và độ kinh. 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 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 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 trình 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 này chưa được đặt.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION Tuyến đường nằm ngoài phạm vi của dự án.
VALIDATION_ERROR_LOW_ROAD_USAGE Tuyến đường có mức sử dụng đường thấp (rất ít người đi qua).

Phương thức

batchCreate

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

batchDelete

Xoá nhiều tài nguyên SelectedRoute cho dự án được chỉ định.

batchUpdate

Cập nhật nhiều tài nguyên SelectedRoute theo tên được chỉ định.

create

Tạo 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 SelectedRoute theo tên được chỉ định.

list

Liệt kê tất cả tài nguyên SelectedRoute cho dự án được chỉ định có phân trang.

patch

Cập nhật SelectedRoute theo tên của tuyến đường đó.