Package google.maps.navconnect.v1

Index

Service for NavConnect clients to create and get trips.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Creates a trip. This must be called before the mobile application can start the trip. The returned trip will have the auth_token field set.

Authorization scopes

Requires the following OAuth scope:

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

Requires the following IAM permission on the parent resource:

  • navigationconnect.trips.create

For more information, see the IAM documentation.
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Gets a trip.

Authorization scopes

Requires the following OAuth scope:

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

Requires the following IAM permission on the name resource:

  • navigationconnect.trips.get

For more information, see the IAM documentation.

AuthToken

An authentication token.

Fields
token

string

Output only. The authentication token that should be passed to the mobile application.
expire_time

Timestamp

Output only. Time at which the authentication token will expire.

CreateTripRequest

Request message for NavConnectService.CreateTrip.

Fields
parent

string

Required. The parent resource under which this trip will be created. Format: projects/{project_number}
trip_id

string

Required. The ID to use for the trip, which will become the final component of the trip's resource name.

This value must be a valid RFC-4122 UUID.
trip

Trip

Required. The trip to create.

GetTripRequest

Request message for NavConnectService.GetTrip.

Fields
name

string

Required. The resource name of the trip to get. Format: projects/{project}/trips/{trip_id}
route_polyline_format

RoutePolylineFormat

Optional. The format of the route polyline to return. If not set, SIMPLE route polyline will be returned.

RoutePolylineFormat

Specifies the format of the route polyline.

Enums
ROUTE_POLYLINE_FORMAT_UNSPECIFIED The route polyline format is unspecified.
SIMPLE The route polyline is returned as a simple array of points represented as google.type.LatLng.
ENCODED The route polyline is returned as an encoded string. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
S2ENCODED The route polyline is encoded as a S2Polyline. See https://s2geometry.io/devguide/basic_types.html.
GEO_JSON The route polyline is returned as a GeoJSON LineString. See https://tools.ietf.org/html/rfc7946#section-3.1.4.

Location

A location as reported by the mobile application.

Fields
point

LatLng

Output only. The location lat/lng.
source_time

Timestamp

Output only. The time when the location was sourced as denoted by the client.
server_time

Timestamp

Output only. The time at which the server received this location update.

Route

A route polyline.

Fields
traffic_information[]

SpeedReadingInterval

Output only. Traffic information on the polyline described as speed reading intervals.

NOTES:

  • The intervals are non-overlapping.
  • The intervals are contiguous.
  • The intervals cover the entire polyline.
  • The intervals are sorted by increasing index.
  • Speed is specified for each interval.

Union field format. The route format.

The format populated is controlled by the route_polyline_format parameter. If not set, it defaults to a simple polyline. format can be only one of the following:
simple_polyline

SimplePolyline

Output only. The route as a simple list of latlngs.
encoded_polyline

string

Output only. The route as an encoded polyline. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
s2_polyline

bytes

Output only. The route as an encoded S2Polyline. See https://s2geometry.io/devguide/basic_types.html.
geo_json

Struct

Output only. The route as a GeoJSON LineString. See https://tools.ietf.org/html/rfc7946#section-3.1.4.

SimplePolyline

Represents a polyline using a simple list of points.

Fields
points[]

LatLng

Output only. Ordered list of points representing the polyline.

SpeedReadingInterval

Traffic density indicator on a contiguous segment of a path. Given a path with points P_0, P_1, ... , P_N (zero-based index), the SpeedReadingInterval defines an interval and describes its traffic using the Speed categories.

Fields
speed

Speed

Output only. Traffic speed in this interval.
start_polyline_point_index

int32

Output only. The starting index of this interval in the path.
end_polyline_point_index

int32

Output only. The ending index of this interval in the path.

Speed

The classification of polyline speed based on traffic data.

Enums
SPEED_UNSPECIFIED The speed is unspecified.
NORMAL Normal speed, no traffic delays.
SLOW Slowdown detected, light to medium amount of traffic.
TRAFFIC_JAM Traffic delays, including standstill traffic.

Stop

A stop in the trip where some task is to be performed.

Fields
point

LatLng

Required. The location of the stop as a lat/lng.

Trip

A trip.

Fields
name

string

Output only. Identifier. The resource name of the trip. Format: projects/{project_number}/trips/{trip_id}.
config

TripConfig

Immutable. The configuration for the trip.
android_app_id

string

Input only. Immutable. The Android application ID of the mobile application that will use the trip. At least one of android_app_id or ios_app_id must be set.
ios_app_id

string

Input only. Immutable. The iOS bundle ID of the mobile application that will use the trip. At least one of android_app_id or ios_app_id must be set.
auth_token

AuthToken

Output only. An opaque token that authorizes access to begin a NavConnect trip in Google Maps or Waze and grants these applications access to update the trip. Only returned by CreateTrip.
state

State

Output only. The Trip state.
execution

TripExecution

Output only. The latest data about the execution of the trip. This may not be set if the trip is in an error state.
create_time

Timestamp

Output only. Time according to the server when the trip was created.
update_time

Timestamp

Output only. Time at which the server received the latest trip update.

State

All possible trip states.

Enums
STATE_UNSPECIFIED The trip state is unspecified.
NEW The trip was created but has not yet started.
ENROUTE The transporter is enroute to the destination.
ARRIVED The transporter arrived at the destination.
SUSPENDED The trip was suspended.
FAILED The trip failed to complete successfully.
CLIENT_ERROR The trip failed due to a client error.
CANCELED The trip was explicitly canceled by the developer.

TripConfig

Configuration for the trip.

Fields
enable_high_frequency_updates

bool

Optional. Whether to enable high-frequency trip updates.

NOTE: Enabling this feature logs the trip under Enterprise Tier usage, and is subject to Enterprise Tier rates.
enable_pubsub

bool

Optional. Whether to enable pubsub notifications for the trip.
pubsub_field_mask

FieldMask

Optional. If set, only the specified subset of the Trip fields will be included in the pubsub notifications.

If not set, all Trip fields will be included in the pubsub notifications (default behavior).

The following fields are not supported:

  • android_app_id
  • ios_app_id
  • auth_token
  • config

NOTE: This field is ignored if enable_pubsub is false.
enable_remaining_route_reporting

bool

Optional. Whether to enable remaining route reporting for the trip.

NOTE: Enabling this feature logs the trip under Enterprise Tier usage, and is subject to Enterprise Tier rates.

TripExecution

Data about the execution of the trip.

Fields
origin

Location

Output only. Origin of the trip which is generally the transporter's location at start of the NavConnect trip.
destination

Stop

Output only. The destination of the trip as reported by the mobile application.
location

Location

Output only. The location signal representing the last known location of the transporter. This will be the road snapped location if available.
remaining_route

Route

Output only. Provides the polyline for the remaining portion of the route.
traveled_duration

Duration

Output only. Time traveled thus far.
remaining_duration

Duration

Output only. Time left on this trip as estimated by Google.
traveled_distance_meters

int32

Output only. Distance traveled from the origin in meters.
remaining_distance_meters

int32

Output only. Distance remaining to the destination in meters.
stop_added_in_route

bool

Output only. Indicates whether a stop was added along the route.