Method: photos.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the Photos that belong to the user.
Note: Recently created photos that are still being indexed are not returned in the response.
HTTP request
GET https://streetviewpublish.googleapis.com/v1/photos
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
view |
enum (PhotoView)
Required. Specifies if a download URL for the photos bytes should be returned in the Photos response.
|
pageSize |
integer
Optional. The maximum number of photos 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 photos returned in the response may be less than pageSize if the number of photos that belong to the user is less than pageSize.
|
pageToken |
string
Optional. The nextPageToken value returned from a previous photos.list request, if any.
|
filter |
string
Optional. The filter expression. For example: placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw. The filters supported are: placeId, min_latitude, max_latitude, min_longitude, max_longitude. See https://google.aip.dev/160 for more information.
|
languageCode |
string
Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If languageCode is unspecified, the user's language preference for Google services is used.
|
Request body
The request body must be empty.
Response body
Response to list all photos that belong to a user.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"photos": [
{
object (Photo)
}
],
"nextPageToken": string
} |
| Fields |
photos[] |
object (Photo)
List of photos. The pageSize field in the request determines the number of items returned.
|
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 photos belonging to a user, although recently created, unindexed photos may not be included.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by place ID, latitude, and longitude, and lets you specify the view and page size.\u003c/p\u003e\n"],["\u003cp\u003eResponses include a list of photos and a token for retrieving subsequent pages if available.\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 document details how to retrieve a user's photos using the Street View Publish API. A `GET` request to `https://streetviewpublish.googleapis.com/v1/photos` is used. Key parameters include `view`, `pageSize`, `pageToken`, `filter`, and `languageCode`. The request body is empty. A successful response returns a JSON object containing a list of `photos`, and a `nextPageToken` for pagination. Access requires the `https://www.googleapis.com/auth/streetviewpublish` authorization scope.\n"],null,["# Method: photos.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.ListPhotosResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all the [Photos](/streetview/publish/reference/rest/v1/photo#Photo) that belong to the user.\n\u003e Note: Recently created photos that are still being indexed are not returned in the response.\n\n### HTTP request\n\n`GET https://streetviewpublish.googleapis.com/v1/photos`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `view` | `enum (`[PhotoView](/streetview/publish/reference/rest/v1/PhotoView)`)` Required. Specifies if a download URL for the photos bytes should be returned in the Photos response. |\n| `pageSize` | `integer` Optional. The maximum number of photos 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 photos returned in the response may be less than `pageSize` if the number of photos that belong to the user is less than `pageSize`. |\n| `pageToken` | `string` Optional. The [nextPageToken](/streetview/publish/reference/rest/v1/photos/list#body.ListPhotosResponse.FIELDS.next_page_token) value returned from a previous [photos.list](/streetview/publish/reference/rest/v1/photos/list#google.streetview.publish.v1.StreetViewPublishService.ListPhotos) request, if any. |\n| `filter` | `string` Optional. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The filters supported are: `placeId`, `min_latitude`, `max_latitude`, `min_longitude`, `max_longitude`. See \u003chttps://google.aip.dev/160\u003e for more information. |\n| `languageCode` | `string` Optional. The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see \u003chttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier\u003e. If languageCode is unspecified, the user's language preference for Google services is used. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse to list all photos that belong to a user.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------|\n| ``` { \"photos\": [ { object (/streetview/publish/reference/rest/v1/photo#Photo) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `photos[]` | `object (`[Photo](/streetview/publish/reference/rest/v1/photo#Photo)`)` List of photos. The [pageSize](/streetview/publish/reference/rest/v1/photos/list#body.QUERY_PARAMETERS.page_size) field in the request determines the number of items returned. |\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)."]]
