Method: photoSequences.list

  • Lists all PhotoSequences belonging to a user, ordered by creation timestamp in descending order.

  • Allows filtering by various criteria such as imagery type, processing state, location, filename, and capture time.

  • Results are paginated and can be retrieved in batches using page tokens.

  • Each PhotoSequence can be in one of three states: processing, processed with error, or processed successfully.

  • Requires authorization with the https://www.googleapis.com/auth/streetviewpublish scope.

Lists all the PhotoSequences that belong to the user, in descending photoSequence.create timestamp order.

HTTP request

GET https://streetviewpublish.googleapis.com/v1/photoSequences

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of photo sequences to return. pageSize must be non-negative. If pageSize is zero or is not provided, the default page size of 100 is used. The number of photo sequences returned in the response may be less than pageSize if the number of matches is less than pageSize. This is currently unimplemented but is in process.
pageToken

string

Optional. The nextPageToken value returned from a previous photoSequences.list request, if any.
filter

string

Optional. The filter expression. For example: imageryType=SPHERICAL.

The filters supported are: imageryType, processingState, min_latitude, max_latitude, min_longitude, max_longitude, filename_query, min_capture_time_seconds, `max_capture_time_seconds. See https://google.aip.dev/160 for more information. Filename queries should sent as a Phrase in order to support multiple words and special characters by adding escaped quotes. Ex: filename_query="example of a phrase.mp4"

Request body

The request body must be empty.

Response body

Response to list all photo sequences that belong to a user.

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

JSON representation 
{
  "photoSequences": [
    {
      object (Operation)
    }
  ],
  "nextPageToken": string
}
Fields
photoSequences[]

object (Operation)

List of photo sequences via Operation interface.

The maximum number of items returned is based on the pageSize field in the request.

Each item in the list can have three possible states,

  • Operation.done = false, if the processing of PhotoSequence is not finished yet.
  • Operation.done = true and Operation.error is populated, if there was an error in processing.
  • Operation.done = true and Operation.response contains a PhotoSequence message, In each sequence, only Id is populated.
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/streetviewpublish

For more information, see the OAuth 2.0 Overview.