Package google.maps.roads.selection.v1

Chỉ mục

RoadsSelection

Định nghĩa dịch vụ cho Roads Selection API.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

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.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

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.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

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

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

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

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

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

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform

BatchCreateSelectedRoutesRequest

Yêu cầu tạo nhiều SelectedRoute.

Trường
parent

string

Không bắt buộc. Tài nguyên dự án được chia sẻ bởi tất cả các tuyến đường đã chọn. Định dạng: projects/{project} Nếu bạn đặt trường này, thì trường gốc trong thông báo CreateSelectedRouteRequest phải trống hoặc khớp với trường này.
requests[]

CreateSelectedRouteRequest

Bắt buộc. Thông báo yêu cầu chỉ định tuyến đường đã chọn để tạo. Bạn có thể tạo tối đa 1.000 tuyến đường đã chọn trong một lô.

BatchCreateSelectedRoutesResponse

Phản hồi từ việc tạo nhiều SelectedRoute.

Trường
selected_routes[]

SelectedRoute

Đã tạo SelectedRoutes.

CreateSelectedRouteRequest

Yêu cầu tạo SelectedRoute.

Trường
parent

string

Bắt buộc. Dự án mà SelectedRoute sẽ được tạo. Định dạng: projects/{project}
selected_route

SelectedRoute

Bắt buộc. SelectedRoute để tạo.
selected_route_id

string

Không bắt buộc. Mã nhận dạng cần dùng cho SelectedRoute, mã này sẽ trở thành thành phần cuối cùng của tên tài nguyên SelectedRoute.

Giá trị này phải có từ 4 đến 63 ký tự và các ký tự hợp lệ là: "a-z", "A-Z", "0-9" hoặc "-". Nếu bạn không cung cấp hoặc để trống, thì một UUID sẽ được tạo sau khi tạo tài nguyên.

DeleteSelectedRouteRequest

Yêu cầu xoá SelectedRoute.

Trường
name

string

Bắt buộc. Tên của SelectedRoute cần xoá. Định dạng: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

Yêu cầu lấy SelectedRoute.

Trường
name

string

Bắt buộc. Tên của SelectedRoute cần truy xuất. Định dạng: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

Yêu cầu liệt kê SelectedRoute.

Trường
parent

string

Bắt buộc. Phần tử mẹ là dự án mà tất cả SelectedRoute sẽ được truy vấn. Định dạng: projects/{project}/selectedRoutes
page_size

int32

Không bắt buộc. Số lượng kết quả sẽ được trả về cho một trang nhất định. Nếu bạn không đặt giá trị này, giá trị mặc định sẽ là 100. Khi bạn đưa ra giá trị 0, giá trị này sẽ được đặt thành giá trị mặc định. Giá trị tối đa là 5000, mọi giá trị lớn hơn 5000 sẽ được đặt thành 5000.
page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ một lệnh gọi ListSelectedRoutes trước đó.

ListSelectedRoutesResponse

Phản hồi liệt kê các SelectedRoute.

Trường
selected_routes[]

SelectedRoute

Một trang SelectedRoutes được lưu trữ trong dự án được chỉ định trong yêu cầu.
next_page_token

string

Mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu trường này trống, tức là không có trang tiếp theo.

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.

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/{selected_route}
display_name

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.
create_time

Timestamp

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

State

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

map<string, 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".
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:
dynamic_route

DynamicRoute

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

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.

Trường
origin

LatLng

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

LatLng

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

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.

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).