On-demand Rides and Deliveries Solution is currently available only to select partners. Contact sales to learn more.

Method: archive.providers.vehicles.list

Stay organized with collections Save and categorize content based on your preferences.

Lists all vehicles within a given area and a given time window. Only their last location within the time window will be returned.

HTTP request

GET https://fleetengine.googleapis.com/v1/archive/{parent=providers/*}/vehicles

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Must be in the format providers/{provider}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

Query parameters

Parameters
header

object (RequestHeader)

Optional. The standard Fleet Engine request header.
dataset

string

Optional. Name of the Cloud Logging sink dataset.
timeWindow

object (TimeWindow)

Required. The time window for which to list vehicles. Only vehicles that had at least one update performed during the time window will be returned.
viewport

object (Viewport)

Required. The viewport for which to list vehicles. Only vehicles that had at least one update performed within the viewport will be returned.
pageSize

integer

Optional. The maximum number of vehicles to return. The service may return fewer than this value. If unspecified, the server will decide the number of results to return.
pageToken

string

Optional. A page token, received from a previous vehicles.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to vehicles.list must match the call that provided the page token.
filter

string

Optional. A filter query to apply when listing vehicles. See http://aip.dev/160 for examples of the filter syntax. If you don't specify a value, or if you specify an empty string for the filter, then all vehicles will be returned.
updateMask

string (FieldMask format)

Optional. A field mask that indicates which updates to Vehicle fields to list. Note that this may result in multiple instances for the same Vehicle to be included in the response, one for each time a field from the mask was changed in the instance. If a mask is not specified then only the latest instance of a Vehicle will be included in the response.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
maximumBytesBilled

string (Int64Value format)

Optional. This parameter is used to limit BigQuery costs. Limits the bytes billed for this request. Requests with bytes billed above this limit will fail (without incurring a charge). If the parameter is not specified, the system uses the default project limit set by BigQuery. This is either unlimited, or whatever you have specified as your project default with BigQuery. See BigQuery documentation for details.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

vehicles.list response message. Next id: 3

JSON representation 
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string
}
Fields
vehicles[]

object (Vehicle)

The list of vehicles for the requested time window and area. The vehicle entities represent the latest state within the time window.
nextPageToken

string

Pass this token in the ListVehiclesRequest to continue to list results. If all results have been returned, this field is an empty string or not present in the response.