Method: photoSequences.list
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eLists all PhotoSequences belonging to a user, ordered by creation timestamp in descending order.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by various criteria such as imagery type, processing state, location, filename, and capture time.\u003c/p\u003e\n"],["\u003cp\u003eResults are paginated and can be retrieved in batches using page tokens.\u003c/p\u003e\n"],["\u003cp\u003eEach PhotoSequence can be in one of three states: processing, processed with error, or processed successfully.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/streetviewpublish\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This describes how to list a user's photo sequences. Use a `GET` request to `https://streetviewpublish.googleapis.com/v1/photoSequences`. Optional query parameters include `pageSize` (default 100), `pageToken` for pagination, and `filter` to refine results. The request body is empty. The response body contains a list of `photoSequences`, each with processing status, and a `nextPageToken` for pagination. The request requires the `https://www.googleapis.com/auth/streetviewpublish` OAuth scope.\n"],null,["# Method: photoSequences.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListPhotoSequencesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all the [PhotoSequences](/streetview/publish/reference/rest/v1/photoSequence/create#PhotoSequence) that belong to the user, in descending photoSequence.create timestamp order.\n\n### HTTP request\n\n`GET https://streetviewpublish.googleapis.com/v1/photoSequences`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `pageToken` | `string` Optional. The [nextPageToken](/streetview/publish/reference/rest/v1/photos/list#body.ListPhotosResponse.FIELDS.next_page_token) value returned from a previous [photoSequences.list](/streetview/publish/reference/rest/v1/photoSequences/list#google.streetview.publish.v1.StreetViewPublishService.ListPhotoSequences) request, if any. |\n| `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 \u003chttps://google.aip.dev/160\u003e 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\" |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse to list all photo sequences that belong to a user.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"photoSequences\": [ { object (/streetview/publish/reference/rest/v1/Operation) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `photoSequences[]` | `object (`[Operation](/streetview/publish/reference/rest/v1/Operation)`)` List of photo sequences via [Operation](/streetview/publish/reference/rest/v1/Operation) interface. The maximum number of items returned is based on the [pageSize](/streetview/publish/reference/rest/v1/photoSequences/list#body.QUERY_PARAMETERS.page_size) field in the request. Each item in the list can have three possible states, - `Operation.done` = false, if the processing of [PhotoSequence](/streetview/publish/reference/rest/v1/photoSequence/create#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](/streetview/publish/reference/rest/v1/photoSequence/create#PhotoSequence) message, In each sequence, only [Id](/streetview/publish/reference/rest/v1/photoSequence/create#PhotoSequence.FIELDS.id) is populated. |\n| `nextPageToken` | `string` Token to retrieve the next page of results, or empty if there are no more results in the list. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/streetviewpublish`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
