REST Resource: providers.trips

Tài nguyên: Chuyến đi

Siêu dữ liệu về chuyến đi.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "vehicleId": string,
  "tripStatus": enum (TripStatus),
  "tripType": enum (TripType),
  "pickupPoint": {
    object (TerminalLocation)
  },
  "actualPickupPoint": {
    object (StopLocation)
  },
  "actualPickupArrivalPoint": {
    object (StopLocation)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocation)
    }
  ],
  "intermediateDestinationsVersion": string,
  "intermediateDestinationIndex": integer,
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocation)
    }
  ],
  "actualIntermediateDestinations": [
    {
      object (StopLocation)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "actualDropoffPoint": {
    object (StopLocation)
  },
  "dropoffTime": string,
  "remainingWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "vehicleWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "route": [
    {
      object (LatLng)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolyline)
  },
  "currentRouteSegmentTrafficVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "remainingWaypointsVersion": string,
  "remainingWaypointsRouteVersion": string,
  "numberOfPassengers": integer,
  "lastLocation": {
    object (VehicleLocation)
  },
  "lastLocationSnappable": boolean,
  "view": enum (TripView)
}
Trường
name

string

Chỉ có đầu ra. Theo định dạng "providers/{provider}/trips/{trip}"
vehicleId

string

Mã của xe thực hiện chuyến đi này.
tripStatus

enum (TripStatus)

Trạng thái hiện tại của chuyến đi.
tripType

enum (TripType)

Loại chuyến đi.
pickupPoint

object (TerminalLocation)

Vị trí mà khách hàng cho biết họ sẽ được đón.
actualPickupPoint

object (StopLocation)

Chỉ nhập. Vị trí thực tế khi khách hàng được đón và nơi khách hàng được đón. Trường này dành cho nhà cung cấp để cung cấp ý kiến phản hồi về thông tin thực tế về điểm đến lấy hàng.
actualPickupArrivalPoint

object (StopLocation)

Chỉ nhập. Thời gian và vị trí thực tế mà tài xế đến điểm đón. Trường này dành cho nhà cung cấp để cung cấp ý kiến phản hồi về thông tin đến thực tế tại điểm đón.
pickupTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian ước tính trong tương lai khi(các) người đi xe sẽ được đón hoặc thời gian thực tế khi họ được đón.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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".
intermediateDestinations[]

object (TerminalLocation)

Điểm dừng trung gian theo yêu cầu của chuyến đi (ngoài điểm đón và điểm trả khách). Ban đầu, tính năng này sẽ không được hỗ trợ cho các chuyến đi được chia sẻ.
intermediateDestinationsVersion

string (Timestamp format)

Cho biết lần sửa đổi gần nhất của intermediateDestinations. Máy chủ của bạn phải lưu giá trị này vào bộ nhớ đệm và truyền giá trị đó trong UpdateTripRequest khi cập nhật intermediateDestinationIndex để đảm bảo intermediateDestinations không bị thay đổi.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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".
intermediateDestinationIndex

integer

Khi TripStatus là ENROUTE_TO_INTERMEDIATE_DESTINATION, một số trong khoảng [0..N-1] cho biết đích đến trung gian tiếp theo mà xe sẽ đi qua. Khi TripStatus là ARRIVED_AT_INTERMEDIATE_DESTINATION, một số trong khoảng [0..N-1] cho biết xe đang ở đích đến trung gian nào. Nhà cung cấp đặt giá trị này. Nếu không có intermediateDestinations, trường này sẽ bị bỏ qua.
actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

Chỉ nhập. Thời gian và vị trí thực tế mà tài xế đến một điểm đến trung gian. Trường này dành cho nhà cung cấp để cung cấp ý kiến phản hồi về thông tin đến thực tế tại các điểm đến trung gian.
actualIntermediateDestinations[]

object (StopLocation)

Chỉ nhập. Thời gian và vị trí thực tế khi khách hàng được đón tại một điểm đến trung gian. Trường này dành cho nhà cung cấp để cung cấp ý kiến phản hồi về thông tin thực tế về điểm đón tại các điểm đến trung gian.
dropoffPoint

object (TerminalLocation)

Vị trí mà khách hàng cho biết họ sẽ được thả xuống.
actualDropoffPoint

object (StopLocation)

Chỉ nhập. Thời gian và vị trí thực tế khi khách hàng được đưa đến nơi. Trường này dành cho nhà cung cấp để cung cấp ý kiến phản hồi về thông tin thực tế về điểm đến.
dropoffTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian ước tính trong tương lai khi(các) người đi xe sẽ được thả tại điểm đến cuối cùng hoặc thời gian thực tế khi họ được thả.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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".
remainingWaypoints[]

object (TripWaypoint)

Chỉ có đầu ra. Đường dẫn đầy đủ từ vị trí hiện tại đến điểm trả khách, bao gồm cả điểm trả khách. Đường dẫn này có thể bao gồm các điểm trung gian của các chuyến đi khác.
vehicleWaypoints[]

object (TripWaypoint)

Trường này hỗ trợ việc sắp xếp các điểm trung gian theo cách thủ công cho chuyến đi. Tệp này chứa tất cả các điểm trung gian còn lại cho xe được chỉ định, cũng như điểm đón và điểm trả khách cho chuyến đi này. Nếu chuyến đi chưa được chỉ định cho một xe, thì Công cụ quản lý đội xe sẽ bỏ qua trường này. Vì lý do bảo mật, máy chủ chỉ điền trường này vào các lệnh gọi trips.update và trips.create, KHÔNG điền vào các lệnh gọi trips.get.
route[]

object (LatLng)

Chỉ có đầu ra. Tuyến đường dự kiến cho chuyến đi này đến mục đầu tiên trong remainingWaypoints. Xin lưu ý rằng điểm trung gian đầu tiên có thể thuộc về một chuyến đi khác.
currentRouteSegment

string

Chỉ có đầu ra. Đường dẫn được mã hoá đến điểm trung gian tiếp theo.

Lưu ý: Trường này chỉ dành cho Trình điều khiển SDK và Trình dùng SDK. Chưa hỗ trợ giải mã.
currentRouteSegmentVersion

string (Timestamp format)

Chỉ có đầu ra. Cho biết lần gần nhất tuyến đường được sửa đổi.

Lưu ý: Trường này chỉ dành cho Trình điều khiển SDK và Trình dùng SDK.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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".
currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

Chỉ có đầu ra. Cho biết tình trạng giao thông dọc theo currentRouteSegment khi có.

Lưu ý: Trường này chỉ dành cho Trình điều khiển SDK và Trình dùng SDK.
currentRouteSegmentTrafficVersion

string (Timestamp format)

Chỉ có đầu ra. Cho biết lần sửa đổi gần nhất của currentRouteSegmentTraffic.

Lưu ý: Trường này chỉ dành cho Trình điều khiển SDK và Trình dùng SDK.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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".
currentRouteSegmentEndPoint

object (TripWaypoint)

Chỉ có đầu ra. Điểm trung gian nơi currentRouteSegment kết thúc.
remainingDistanceMeters

integer

Chỉ có đầu ra. Quãng đường còn lại để lái xe trong trường currentRouteSegment. Giá trị này không được chỉ định nếu chuyến đi không được chỉ định cho một xe, hoặc chuyến đi đã hoàn tất hoặc bị huỷ.
etaToFirstWaypoint

string (Timestamp format)

Chỉ có đầu ra. Thời gian đến điểm trung gian tiếp theo (mục đầu tiên trong trường remainingWaypoints). Giá trị này không được chỉ định nếu chuyến đi không được chỉ định cho một xe hoặc chuyến đi không hoạt động (đã hoàn tất hoặc bị huỷ).

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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".
remainingTimeToFirstWaypoint

string (Duration format)

Chỉ có đầu ra. Khoảng thời gian từ khi dữ liệu Chuyến đi được trả về đến thời gian trong Trip.eta_to_first_waypoint. Giá trị này không được chỉ định nếu chuyến đi không được chỉ định cho một xe hoặc chuyến đi không hoạt động (đã hoàn tất hoặc bị huỷ).

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".
remainingWaypointsVersion

string (Timestamp format)

Chỉ có đầu ra. Cho biết lần gần đây nhất remainingWaypoints được thay đổi (thêm, xoá hoặc thay đổi một điểm trung gian).

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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".
remainingWaypointsRouteVersion

string (Timestamp format)

Chỉ có đầu ra. Cho biết lần gần nhất remainingWaypoints.path_to_waypoint và remainingWaypoints.traffic_to_waypoint được sửa đổi. Ứng dụng khách của bạn phải lưu giá trị này vào bộ nhớ đệm và truyền giá trị đó trong GetTripRequest để đảm bảo rằng các đường dẫn và lưu lượng truy cập cho remainingWaypoints chỉ được trả về nếu được cập nhật.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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".
numberOfPassengers

integer

Không thể thay đổi. Cho biết số lượng hành khách trên chuyến đi này và không bao gồm người lái xe. Xe phải có chỗ trống để được trả về trong phản hồi vehicles.search.
lastLocation

object (VehicleLocation)

Chỉ có đầu ra. Cho biết vị trí được báo cáo gần đây nhất của xe dọc theo tuyến đường.
lastLocationSnappable

boolean

Chỉ có đầu ra. Cho biết liệu có thể chụp nhanh lastLocation của xe vào currentRouteSegment hay không. Sai nếu lastLocation hoặc currentRouteSegment không tồn tại. Giá trị này được tính bằng Công cụ quản lý đội xe. Mọi nội dung cập nhật từ ứng dụng khách sẽ bị bỏ qua.
view

enum (TripView)

Tập hợp con các trường Chuyến đi được điền sẵn và cách diễn giải các trường đó.

TripStatus

Trạng thái của một chuyến đi cho biết tiến trình của chuyến đi đó.

Enum
UNKNOWN_TRIP_STATUS Mặc định, dùng cho trạng thái chuyến đi không xác định hoặc không được nhận dạng.
NEW Chuyến đi mới tạo.
ENROUTE_TO_PICKUP Tài xế đang trên đường đến điểm đến.
ARRIVED_AT_PICKUP Người lái xe đã đến điểm đón.
ARRIVED_AT_INTERMEDIATE_DESTINATION Người lái xe đã đến một điểm đến trung gian và đang chờ người đi xe.
ENROUTE_TO_INTERMEDIATE_DESTINATION Người lái xe đang trên đường đến một điểm đến trung gian (không phải điểm trả khách).
ENROUTE_TO_DROPOFF Tài xế đã đón người đi và đang trên đường đến điểm đến tiếp theo.
COMPLETE Người đi xe đã được đưa đến nơi và chuyến đi đã hoàn tất.
CANCELED Người lái xe, người đi xe hoặc nhà cung cấp dịch vụ đi chung xe đã huỷ chuyến đi trước khi đón khách.

StopLocation

Vị trí thực tế nơi diễn ra điểm dừng (lấy/trả khách).

Biểu diễn dưới dạng JSON 
{
  "point": {
    object (LatLng)
  },
  "timestamp": string,
  "stopTime": string
}
Trường
point

object (LatLng)

Bắt buộc. Cho biết vị trí thực tế.
timestamp

string (Timestamp format)

Cho biết thời điểm dừng.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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".
stopTime
(deprecated)

string (Timestamp format)

Chỉ nhập. Không dùng nữa. Sử dụng trường dấu thời gian.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời 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".

TripView

Bộ chọn cho nhiều nhóm trường Chuyến đi trong phản hồi trips.get. Hãy xem AIP-157 để biết thông tin chi tiết. Có thể sẽ có thêm các chế độ xem khác.

Enum
TRIP_VIEW_UNSPECIFIED Giá trị mặc định. Để tương thích ngược, API sẽ mặc định là chế độ xem SDK. Để đảm bảo tính ổn định và khả năng hỗ trợ, khách hàng nên chọn TripView khác với SDK.
SDK Bao gồm các trường có thể không thể diễn giải hoặc hỗ trợ bằng cách sử dụng các thư viện có sẵn công khai.
JOURNEY_SHARING_V1S Các trường Chuyến đi được điền sẵn cho trường hợp sử dụng Chia sẻ hành trình. Chế độ xem này dành cho hoạt động giao tiếp giữa máy chủ với máy chủ.

Phương thức

create

 Tạo một chuyến đi trong Công cụ quản lý đội xe và trả về chuyến đi mới.

delete

 Xoá một Chuyến đi.

get

 Nhận thông tin về một chuyến đi.
Nhận tất cả các chuyến đi cho một xe cụ thể.

update

 Cập nhật dữ liệu chuyến đi.