Package google.maps.navconnect.v1

Chỉ mục

Dịch vụ dành cho khách hàng NavConnect để tạo và nhận chuyến đi.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Tạo một chuyến đi. Bạn phải gọi phương thức này trước khi ứng dụng di động có thể bắt đầu chuyến đi. Chuyến đi được trả về sẽ có trường auth_token được đặt.

Phạm vi uỷ quyền

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

  • https://www.googleapis.com/auth/cloud-platform
Quyền IAM

Yêu cầu quyền IAM sau đây đối với tài nguyên parent:

  • navigationconnect.trips.create

Để biết thêm thông tin, hãy xem tài liệu về IAM.
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Lấy một chuyến đi.

Phạm vi uỷ quyền

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

  • https://www.googleapis.com/auth/cloud-platform
Quyền IAM

Yêu cầu quyền IAM sau đây đối với tài nguyên name:

  • navigationconnect.trips.get

Để biết thêm thông tin, hãy xem tài liệu về IAM.

AuthToken

Mã thông báo xác thực.

Trường
token

string

Chỉ có đầu ra. Mã thông báo xác thực cần được chuyển đến ứng dụng di động.
expire_time

Timestamp

Chỉ có đầu ra. Thời gian mã thông báo xác thực sẽ hết hạn.

CreateTripRequest

Thông báo yêu cầu cho NavConnectService.CreateTrip.

Trường
parent

string

Bắt buộc. Tài nguyên mẹ mà chuyến đi này sẽ được tạo trong đó. Định dạng: projects/{project_number}
trip_id

string

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

Giá trị này phải là một UUID RFC-4122 hợp lệ.
trip

Trip

Bắt buộc. Chuyến đi cần tạo.

GetTripRequest

Thông báo yêu cầu cho NavConnectService.GetTrip.

Trường
name

string

Bắt buộc. Tên tài nguyên của chuyến đi cần lấy. Định dạng: projects/{project}/trips/{trip_id}
route_polyline_format

RoutePolylineFormat

Không bắt buộc. Định dạng của đường nhiều đường cho tuyến đường sẽ trả về. Nếu bạn không đặt, hệ thống sẽ trả về đường nét đa tuyến của SIMPLE.

RoutePolylineFormat

Chỉ định định dạng của đường nhiều đường trên tuyến đường.

Enum
ROUTE_POLYLINE_FORMAT_UNSPECIFIED Định dạng đường nhiều đoạn của tuyến đường không được chỉ định.
SIMPLE Đường nhiều đường của tuyến đường được trả về dưới dạng một mảng đơn giản gồm các điểm được biểu thị dưới dạng google.type.LatLng.
ENCODED Đường nhiều đường của tuyến đường được trả về dưới dạng một chuỗi được mã hoá. Hãy xem https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
S2ENCODED Đường nhiều đường của tuyến đường được mã hoá dưới dạng S2Polyline. Hãy xem https://s2geometry.io/devguide/basic_types.html.
GEO_JSON Đường nhiều đường của tuyến đường được trả về dưới dạng GeoJSON LineString. Hãy xem https://tools.ietf.org/html/rfc7946#section-3.1.4.

Thông tin vị trí

Vị trí do ứng dụng di động báo cáo.

Trường
point

LatLng

Chỉ có đầu ra. Vĩ độ/kinh độ của vị trí.
source_time

Timestamp

Chỉ có đầu ra. Thời gian vị trí được lấy nguồn theo chỉ định của ứng dụng.
server_time

Timestamp

Chỉ có đầu ra. Thời gian mà máy chủ nhận được thông báo cập nhật vị trí này.

Tuyến đường

Một hình nhiều đường của tuyến đường.

Trường
traffic_information[]

SpeedReadingInterval

Chỉ có đầu ra. Thông tin giao thông trên đường nhiều đoạn được mô tả là khoảng thời gian đọc tốc độ.

LƯU Ý:

  • Các khoảng thời gian không chồng chéo nhau.
  • Các khoảng thời gian là liên tục.
  • Các khoảng thời gian bao phủ toàn bộ đường nhiều đường.
  • Các khoảng thời gian được sắp xếp theo chỉ mục tăng dần.
  • Tốc độ được chỉ định cho từng khoảng thời gian.

Trường nhóm format. Định dạng tuyến đường.

Định dạng được điền sẵn do tham số route_polyline_format kiểm soát. Nếu không được đặt, thì giá trị mặc định sẽ là một đường nhiều đoạn đơn giản. format chỉ có thể là một trong những trạng thái sau:
simple_polyline

SimplePolyline

Chỉ có đầu ra. Tuyến đường dưới dạng danh sách đơn giản gồm các latlng.
encoded_polyline

string

Chỉ có đầu ra. Tuyến đường dưới dạng một đường nhiều đường được mã hoá. Hãy xem https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
s2_polyline

bytes

Chỉ có đầu ra. Tuyến đường dưới dạng S2Polyline được mã hoá. Hãy xem https://s2geometry.io/devguide/basic_types.html.
geo_json

Struct

Chỉ có đầu ra. Tuyến đường dưới dạng GeoJSON LineString. Hãy xem https://tools.ietf.org/html/rfc7946#section-3.1.4.

SimplePolyline

Biểu thị một đường nhiều đoạn bằng cách sử dụng danh sách đơn giản gồm các điểm.

Trường
points[]

LatLng

Chỉ có đầu ra. Danh sách các điểm theo thứ tự đại diện cho đường nhiều đoạn.

SpeedReadingInterval

Chỉ báo mật độ giao thông trên một đoạn đường liên tục. Cho trước một đường dẫn có các điểm P_0, P_1, ... , P_N (chỉ mục từ 0), SpeedReadingInterval xác định một khoảng thời gian và mô tả lưu lượng truy cập của khoảng thời gian đó bằng cách sử dụng các danh mục Speed.

Trường
speed

Speed

Chỉ có đầu ra. Tốc độ giao thông trong khoảng thời gian này.
start_polyline_point_index

int32

Chỉ có đầu ra. Chỉ mục bắt đầu của khoảng thời gian này trong đường dẫn.
end_polyline_point_index

int32

Chỉ có đầu ra. Chỉ mục kết thúc của khoảng thời gian này trong đường dẫn.

Tốc độ

Phân loại tốc độ của hình nhiều đường dựa trên dữ liệu giao thông.

Enum
SPEED_UNSPECIFIED Tốc độ chưa được chỉ định.
NORMAL Tốc độ bình thường, không có trở ngại giao thông.
SLOW Đã phát hiện tình trạng giảm tốc độ, lưu lượng giao thông từ thấp đến trung bình.
TRAFFIC_JAM Tình trạng tắc nghẽn giao thông, kể cả tình trạng giao thông ùn tắc.

Dừng

Một điểm dừng trong chuyến đi để thực hiện một việc nào đó.

Trường
point

LatLng

Bắt buộc. Vị trí của điểm dừng dưới dạng vĩ độ/kinh độ.

Chuyến đi

Một chuyến đi.

Trường
name

string

Chỉ có đầu ra. Giá trị nhận dạng. Tên tài nguyên của chuyến đi. Định dạng: projects/{project_number}/trips/{trip_id}.
config

TripConfig

Không thể thay đổi. Cấu hình cho chuyến đi.
android_app_id

string

Chỉ nhập. Không thể thay đổi. Mã ứng dụng Android của ứng dụng di động sẽ sử dụng chuyến đi. Bạn phải đặt ít nhất một trong android_app_id hoặc ios_app_id.
ios_app_id

string

Chỉ có đầu vào. Không thể thay đổi. Mã nhận dạng gói iOS của ứng dụng di động sẽ sử dụng chuyến đi. Bạn phải đặt ít nhất một trong hai thuộc tính android_app_id hoặc ios_app_id.
auth_token

AuthToken

Chỉ có đầu ra. Một mã thông báo không công khai cho phép truy cập để bắt đầu một chuyến đi bằng NavConnect trong Google Maps hoặc Waze và cấp cho các ứng dụng này quyền cập nhật chuyến đi. Chỉ được CreateTrip trả về.
state

State

Chỉ có đầu ra. Trạng thái của Chuyến đi.
execution

TripExecution

Chỉ có đầu ra. Dữ liệu mới nhất về việc thực hiện chuyến đi. Bạn không thể đặt giá trị này nếu chuyến đi đang ở trạng thái lỗi.
create_time

Timestamp

Chỉ có đầu ra. Thời gian theo máy chủ khi chuyến đi được tạo.
update_time

Timestamp

Chỉ có đầu ra. Thời gian mà máy chủ nhận được thông tin cập nhật mới nhất về chuyến đi.

Tiểu bang

Tất cả các trạng thái có thể có của chuyến đi.

Enum
STATE_UNSPECIFIED Trạng thái chuyến đi chưa được chỉ định.
NEW Chuyến đi đã được tạo nhưng chưa bắt đầu.
ENROUTE Xe vận chuyển đang trên đường đến điểm đến.
ARRIVED Xe vận chuyển đã đến nơi.
SUSPENDED Chuyến đi bị tạm ngưng.
FAILED Chuyến đi không hoàn tất thành công.
CLIENT_ERROR Chuyến đi không thành công do lỗi phía máy khách.
CANCELED Nhà phát triển đã huỷ chuyến đi một cách rõ ràng.

TripConfig

Cấu hình cho chuyến đi.

Trường
enable_high_frequency_updates

bool

Không bắt buộc. Chọn có bật tính năng cập nhật thông tin chuyến đi ở tần suất cao hay không.

LƯU Ý: Khi bạn bật tính năng này, chuyến đi sẽ được ghi lại trong mức sử dụng Cấp doanh nghiệp và phải chịu mức phí của Cấp doanh nghiệp.
enable_pubsub

bool

Không bắt buộc. Có bật thông báo pubsub cho chuyến đi hay không.
pubsub_field_mask

FieldMask

Không bắt buộc. Nếu được đặt, chỉ tập hợp con được chỉ định của các trường Chuyến đi sẽ được đưa vào thông báo pubsub.

Nếu bạn không đặt, tất cả các trường Trip sẽ được đưa vào thông báo pubsub (hành vi mặc định).

Các trường sau không được hỗ trợ:

  • android_app_id
  • ios_app_id
  • auth_token
  • config

LƯU Ý: Trường này sẽ bị bỏ qua nếu enable_pubsub có giá trị là false.
enable_remaining_route_reporting

bool

Không bắt buộc. Chọn có bật tính năng báo cáo tuyến đường còn lại cho chuyến đi hay không.

LƯU Ý: Khi bạn bật tính năng này, chuyến đi sẽ được ghi lại trong mức sử dụng Cấp doanh nghiệp và phải chịu mức phí của Cấp doanh nghiệp.

TripExecution

Dữ liệu về việc thực hiện chuyến đi.

Trường
origin

Location

Chỉ có đầu ra. Điểm xuất phát của chuyến đi, thường là vị trí của người vận chuyển khi bắt đầu chuyến đi NavConnect.
destination

Stop

Chỉ có đầu ra. Điểm đến của chuyến đi do ứng dụng di động báo cáo.
location

Location

Chỉ có đầu ra. Tín hiệu vị trí biểu thị vị trí đã biết gần đây nhất của người vận chuyển. Đây sẽ là vị trí được gắn vào đường nếu có.
remaining_route

Route

Chỉ có đầu ra. Cung cấp hình nhiều đường cho phần còn lại của tuyến đường.
traveled_duration

Duration

Chỉ có đầu ra. Thời gian đã đi được cho đến nay.
remaining_duration

Duration

Chỉ có đầu ra. Thời gian còn lại của chuyến đi theo ước tính của Google.
traveled_distance_meters

int32

Chỉ có đầu ra. Khoảng cách đã đi từ điểm khởi hành (tính bằng mét).
remaining_distance_meters

int32

Chỉ có đầu ra. Khoảng cách còn lại đến điểm đến tính bằng mét.
stop_added_in_route

bool

Chỉ có đầu ra. Cho biết bạn có thêm một điểm dừng dọc theo tuyến đường hay không.