- Yêu cầu HTTP
- Nội dung yêu cầu
- Nội dung phản hồi
- Đường dẫn
- Phân đoạn
- AnnotationOptions (Tuỳ chọn chú thích)
- AnnotatedPath
- AnnotatedSegment
- SegmentSpanAttribute
- SegmentSpan
- LevelOfService
Trả về đường dẫn dựa trên phân đoạn đầu vào bằng chú giải cho các thuộc tính động dọc theo đường dẫn.
Yêu cầu HTTP
POST https://routes.googleapis.com/annotations/v2:annotatePaths
URL sử dụng cú pháp Chuyển mã gRPC.
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{ "paths": [ { object ( |
Trường | |
---|---|
paths[] |
Bắt buộc. Các tuyến đã yêu cầu sẽ được điền bằng dữ liệu thuộc tính động. Tất cả đường dẫn phải có cùng đoạn bắt đầu, tức là đoạn mà xe đang chạy. Giả định xe đang ở điểm bắt đầu của đoạn đường đầu tiên. Nếu đường dẫn không bắt đầu tại cùng một phân đoạn, hệ thống sẽ trả về lỗi. |
annotationOptions |
Bắt buộc. Các thuộc tính dữ liệu động đã yêu cầu phải được thêm vào đường dẫn đầu vào. Nếu trống, yêu cầu sẽ không được chú thích. |
Nội dung phản hồi
AnnotationPathsResponse chứa các đường dẫn đầu vào có thêm dữ liệu bổ sung cho tất cả các chú thích được yêu cầu.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{
"annotatedPaths": [
{
object ( |
Trường | |
---|---|
annotatedPaths[] |
Đường dẫn từ dữ liệu đầu vào được chú giải bằng các thuộc tính được yêu cầu. |
Đường dẫn
Đường dẫn nơi các thuộc tính động đang được yêu cầu.
Đường dẫn phải có các đoạn kết nối với nhau và có thể lái xe được. Giả định các đoạn của một đường dẫn là đi theo một tuyến logic và nếu không tìm thấy một tuyến đường trên các đoạn đường đầu vào thì lỗi sẽ được trả về. Ví dụ: Nếu các đoạn trong một đường dẫn không có điểm cuối kết nối hoặc một đường dẫn trống, thì sẽ xảy ra lỗi.
Một lối đi hiện bị giới hạn chiều dài trong 15 km. Đường đi được tính từ điểm bắt đầu của đoạn đường đầu tiên, vị trí giả định của xe. Hệ thống sẽ trả về lỗi nếu một đoạn trong đường dẫn bắt đầu xa hơn 15 km tính từ điểm đầu của đoạn đầu tiên. Có thể chấp nhận đoạn cuối cùng bắt đầu trước 15 km và kết thúc sau 15 km. Hệ thống sẽ không trả về một phần phản hồi nào.
Một đường dẫn có thể chứa cùng các đoạn như một đường dẫn khác, nhưng các chú thích phân đoạn có thể chứa các phản hồi khác nhau dựa trên sự khác biệt ở các phần khác của đường dẫn.
Biểu diễn dưới dạng JSON |
---|
{
"segments": [
{
object ( |
Trường | |
---|---|
segments[] |
Bắt buộc. Danh sách các đoạn được sắp xếp theo thứ tự tạo thành đường dẫn. |
Phân khúc
Phân đoạn thuộc về một đường dẫn.
Biểu diễn dưới dạng JSON |
---|
{ "polyline": { object ( |
Trường | |
---|---|
polyline |
Bắt buộc. Hình nhiều đường của đoạn đường có thể dùng để xác định đoạn đường nếu không tìm thấy mã nhận dạng và cũng để phân biệt hai đoạn đường nếu chúng có cùng mã nhận dạng. Hình nhiều đường được mã hoá bằng Định dạng thuật toán nhiều đường được mã hoá tiêu chuẩn của Nền tảng Google Maps. |
Trường hợp id . Dùng để xác định phân khúc này trong một không gian mã. Bắt buộc. id chỉ có thể là một trong những trạng thái sau: |
|
placeId |
Mã địa điểm cho đoạn đường này. Được sử dụng trên các API. |
AnnotationOptions
Các chú giải đã yêu cầu cho các đường dẫn đầu vào.
Biểu diễn dưới dạng JSON |
---|
{ "includeLevelOfService": boolean } |
Trường | |
---|---|
includeLevelOfService |
Không bắt buộc. Khi bạn đặt chính sách này thành true, thì các phân đoạn trong phản hồi sẽ được chú thích bằng các giá trị lưu lượng truy cập dự đoán. "Cấp dịch vụ" là thuật ngữ thường dùng để mô tả cách phân loại luồng lưu lượng truy cập, nhưng định nghĩa cấp dịch vụ trong API này chỉ thuộc về API này. |
AnnotatedPath
Bản sao của đường dẫn đầu vào được trả về cùng với các thuộc tính dự đoán.
Biểu diễn dưới dạng JSON |
---|
{
"annotatedSegments": [
{
object ( |
Trường | |
---|---|
annotatedSegments[] |
Danh sách các đoạn đường có thứ tự tạo thành đường dẫn chính, được chú thích bằng các thuộc tính bắt buộc. |
AnnotatedSegment
Một đoạn tạo thành một đường dẫn, được chú thích bằng các thuộc tính dữ liệu động.
Biểu diễn dưới dạng JSON |
---|
{ "segment": { object ( |
Trường | |
---|---|
segment |
Chi tiết phân khúc được dùng để phân biệt nó với các phân khúc khác. |
segmentSpanAttributes[] |
Thuộc tính được chỉ định cho phân đoạn. Các thuộc tính này có thể khác nhau tuỳ theo đường dẫn trong đoạn đó. span có thể bao phủ toàn bộ đoạn. Các span thuộc tính sẽ theo thứ tự chuyển tiếp từ vị trí của xe đến cuối đường đi. |
SegmentSpanAttribute
segmentationSpanAttribute chứa các chú giải do API trả về.
Biểu diễn dưới dạng JSON |
---|
{ "segmentSpan": { object ( |
Trường | |
---|---|
segmentSpan |
Mô tả vị trí áp dụng chú thích trên đoạn. |
levelOfService |
Mức lưu lượng truy cập dự đoán cho đoạn đường, được xác định bằng tốc độ lưu thông dự kiến trên đoạn đường này khi xe đến đầu đoạn. |
SegmentSpan
Dùng để phân cách một phần phụ của phân đoạn. Nếu một khoảng bao phủ toàn bộ phân đoạn, startMeters sẽ là 0 và endMeters sẽ là chiều dài phân đoạn.
Biểu diễn dưới dạng JSON |
---|
{ "startMeters": integer, "endMeters": integer } |
Trường | |
---|---|
startMeters |
Trong đó điểm bắt đầu của dải là điểm bắt đầu của hình nhiều đường của đoạn. |
endMeters |
Trong trường hợp điểm kết thúc của đoạn là điểm bắt đầu của hình nhiều đường của đoạn. |
LevelOfService
Các giá trị nhóm lưu lượng truy cập được dự đoán sẽ được dùng cho chức năng của ADAS và ánh xạ đến mức lưu lượng truy cập chung. Các giá trị mà API này trả về là độc lập và không nên được dùng để tương ứng với các API khác.
Enum | |
---|---|
LEVEL_OF_SERVICE_UNSPECIFIED |
Giá trị mặc định. Giá trị này có nghĩa là không có giá trị lưu lượng truy cập dự đoán nào. |
LEVEL_OF_SERVICE_STOPPED |
Tình trạng giao thông bị dừng. |
LEVEL_OF_SERVICE_STOP_AND_GO |
Dừng xe và đi. |
LEVEL_OF_SERVICE_SLOW |
Dự đoán sẽ giảm tốc độ, nhưng không có dự đoán tắc đường. |
LEVEL_OF_SERVICE_NORMAL |
Tốc độ bình thường, không dự đoán là sẽ bị giảm tốc độ. |