REST Resource: projects.trips

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

Một chuyến đi.

Biểu diễn dưới dạng JSON
{
  "name": string,
  "config": {
    object (TripConfig)
  },
  "androidAppId": string,
  "iosAppId": string,
  "authToken": {
    object (AuthToken)
  },
  "state": enum (State),
  "execution": {
    object (TripExecution)
  },
  "createTime": string,
  "updateTime": string
}
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/{tripId}.

config

object (TripConfig)

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

androidAppId

string

Chỉ có đầu vào. 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 hai thuộc tính androidAppId hoặc iosAppId.

iosAppId

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 androidAppId hoặc iosAppId.

authToken

object (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 trips.create trả về.

state

enum (State)

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

execution

object (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.

createTime

string (Timestamp format)

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

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

updateTime

string (Timestamp format)

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

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

TripConfig

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

Biểu diễn dưới dạng JSON
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string
}
Trường
enableHighFrequencyUpdates

boolean

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 giá của Cấp doanh nghiệp.

enablePubsub

boolean

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

pubsubFieldMask

string (FieldMask format)

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ợ:

  • androidAppId
  • iosAppId
  • authToken
  • config

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

Đây là danh sách tên đủ điều kiện của các trường được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"

AuthToken

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

Biểu diễn dưới dạng JSON
{
  "token": string,
  "expireTime": string
}
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.

expireTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian mã thông báo xác thực sẽ hết hạ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".

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.

TripExecution

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

Biểu diễn dưới dạng JSON
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
Trường
origin

object (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

object (Stop)

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

location

object (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ó.

traveledDuration

string (Duration format)

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

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

remainingDuration

string (Duration format)

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

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

traveledDistanceMeters

integer

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

remainingDistanceMeters

integer

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

stopAddedInRoute

boolean

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.

Thông tin vị trí

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

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

object (LatLng)

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

sourceTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian vị trí được lấy nguồn theo chỉ định của khách hàng.

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

serverTime

string (Timestamp format)

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.

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

LatLng

Một đối tượng đại diện cho cặp vĩ độ/kinh độ. Thông tin này được biểu thị dưới dạng một cặp số thực có độ chính xác kép để biểu thị vĩ độ và kinh độ theo độ. 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 được 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].

Dừng

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

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

object (LatLng)

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

Phương thức

create

Tạo một chuyến đi.

get

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