blob: 2a46f3824a70992180fa474dce9db18981d29a76 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="streetviewpublish_v1.html">Street View Publish API</a> . <a href="streetviewpublish_v1.photos.html">photos</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#batchDelete">batchDelete(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070079<p class="firstline">Deletes a list of Photos and their metadata. Note that if BatchDeletePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchDeletePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchDeletePhotosResponse.results. See DeletePhoto for specific failures that can occur per photo.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070080<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080081 <code><a href="#batchGet">batchGet(photoIds=None, languageCode=None, view=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there is an authentication error. Even if BatchGetPhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#batchUpdate">batchUpdate(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">Updates the metadata of Photos, such as pose, place association, connections, etc. Changing the pixels of photos is not supported. Note that if BatchUpdatePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchUpdatePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchUpdatePhotosResponse.results. See UpdatePhoto for specific failures that can occur per photo. Only the fields specified in updateMask field are used. If `updateMask` is not present, the update applies to all fields. The number of UpdatePhotoRequest messages in a BatchUpdatePhotosRequest must not exceed 20. *Note:* To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070087 <code><a href="#close">close()</a></code></p>
88<p class="firstline">Close httplib2 connections.</p>
89<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080090 <code><a href="#list">list(languageCode=None, filter=None, view=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<p class="firstline">Lists all the Photos that belong to the user. *Note:* Recently created photos that are still being indexed are not returned in the response.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070097 <code class="details" id="batchDelete">batchDelete(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070098 <pre>Deletes a list of Photos and their metadata. Note that if BatchDeletePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchDeletePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchDeletePhotosResponse.results. See DeletePhoto for specific failures that can occur per photo.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070099
100Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700101 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102 The object takes the form of:
103
104{ # Request to delete multiple Photos.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700105 &quot;photoIds&quot;: [ # Required. IDs of the Photos. HTTP GET requests require the following syntax for the URL query parameter: `photoIds=&amp;photoIds=&amp;...`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700107 ],
108 }
109
110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114
115Returns:
116 An object of the form:
117
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700118 { # Response to batch delete of one or more Photos.
119 &quot;status&quot;: [ # The status for the operation to delete a single Photo in the batch request.
120 { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800121 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
122 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700123 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700125 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700126 },
127 ],
128 },
129 ],
130 }</pre>
131</div>
132
133<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800134 <code class="details" id="batchGet">batchGet(photoIds=None, languageCode=None, view=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700135 <pre>Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there is an authentication error. Even if BatchGetPhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700136
137Args:
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800138 photoIds: string, Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be `photoIds=&amp;photoIds=&amp;...`. (repeated)
139 languageCode: string, The BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user&#x27;s language preference for Google services is used.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700140 view: string, Required. Specifies if a download URL for the photo bytes should be returned in the Photo response.
141 Allowed values
142 BASIC - Server reponses do not include the download URL for the photo bytes. The default value.
143 INCLUDE_DOWNLOAD_URL - Server responses include the download URL for the photo bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700148
149Returns:
150 An object of the form:
151
152 { # Response to batch get of Photos.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700153 &quot;results&quot;: [ # List of results for each individual Photo requested, in the same order as the requests in BatchGetPhotos.
154 { # Response payload for a single Photo in batch operations including BatchGetPhotos and BatchUpdatePhotos.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800155 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status for the operation to get or update a single photo in the batch request.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800156 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
157 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800158 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
159 {
160 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
161 },
162 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800163 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800164 &quot;photo&quot;: { # Photo is used to store 360 photos along with photo metadata. # The Photo resource, if the request was successful.
165 &quot;places&quot;: [ # Places where this photo belongs.
166 { # Place metadata for an entity.
167 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
168 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
169 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in https://developers.google.com/places/place-id.
170 },
171 ],
172 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
173 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
174 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
175 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be &gt;=0 and &lt;360. NaN indicates an unmeasured quantity.
176 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90 and &lt;= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
177 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
178 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
179 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
180 },
181 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
182 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
183 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
184 &quot;latLngPair&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
185 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
186 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
187 },
188 },
189 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
190 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
191 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this photo to another photo.
192 { # A connection is the link from a source photo to a destination photo.
193 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
194 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
195 },
196 },
197 ],
198 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
199 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows the form: &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
200 },
201 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
202 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.
203 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
204 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
205 },
206 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
207 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700208 },
209 ],
210 }</pre>
211</div>
212
213<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700214 <code class="details" id="batchUpdate">batchUpdate(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700215 <pre>Updates the metadata of Photos, such as pose, place association, connections, etc. Changing the pixels of photos is not supported. Note that if BatchUpdatePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchUpdatePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchUpdatePhotosResponse.results. See UpdatePhoto for specific failures that can occur per photo. Only the fields specified in updateMask field are used. If `updateMask` is not present, the update applies to all fields. The number of UpdatePhotoRequest messages in a BatchUpdatePhotosRequest must not exceed 20. *Note:* To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700216
217Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700218 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700219 The object takes the form of:
220
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700221{ # Request to update the metadata of photos. Updating the pixels of photos is not supported.
222 &quot;updatePhotoRequests&quot;: [ # Required. List of UpdatePhotoRequests.
223 { # Request to update the metadata of a Photo. Updating the pixels of a photo is not supported.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700224 &quot;photo&quot;: { # Photo is used to store 360 photos along with photo metadata. # Required. Photo object containing the new metadata.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800225 &quot;places&quot;: [ # Places where this photo belongs.
226 { # Place metadata for an entity.
227 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
228 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
229 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in https://developers.google.com/places/place-id.
230 },
231 ],
232 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
233 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
234 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
235 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be &gt;=0 and &lt;360. NaN indicates an unmeasured quantity.
236 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90 and &lt;= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
237 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
238 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
239 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
240 },
241 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
242 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
243 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
244 &quot;latLngPair&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
245 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
246 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800247 },
248 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800249 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
250 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
251 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this photo to another photo.
252 { # A connection is the link from a source photo to a destination photo.
253 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
254 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
255 },
256 },
257 ],
258 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
259 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows the form: &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
260 },
261 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
262 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.
263 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
264 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
265 },
266 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
267 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800268 &quot;updateMask&quot;: &quot;A String&quot;, # Required. Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` *Note:* When updateMask contains repeated fields, the entire set of repeated values get replaced with the new contents. For example, if updateMask contains `connections` and `UpdatePhotoRequest.photo.connections` is empty, all connections are removed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700269 },
270 ],
271 }
272
273 x__xgafv: string, V1 error format.
274 Allowed values
275 1 - v1 error format
276 2 - v2 error format
277
278Returns:
279 An object of the form:
280
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700281 { # Response to batch update of metadata of one or more Photos.
282 &quot;results&quot;: [ # List of results for each individual Photo updated, in the same order as the request.
283 { # Response payload for a single Photo in batch operations including BatchGetPhotos and BatchUpdatePhotos.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800284 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status for the operation to get or update a single photo in the batch request.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800285 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
286 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800287 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
288 {
289 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
290 },
291 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800292 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800293 &quot;photo&quot;: { # Photo is used to store 360 photos along with photo metadata. # The Photo resource, if the request was successful.
294 &quot;places&quot;: [ # Places where this photo belongs.
295 { # Place metadata for an entity.
296 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
297 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
298 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in https://developers.google.com/places/place-id.
299 },
300 ],
301 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
302 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
303 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
304 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be &gt;=0 and &lt;360. NaN indicates an unmeasured quantity.
305 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90 and &lt;= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
306 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
307 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
308 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
309 },
310 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
311 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
312 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
313 &quot;latLngPair&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
314 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
315 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
316 },
317 },
318 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
319 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
320 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this photo to another photo.
321 { # A connection is the link from a source photo to a destination photo.
322 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
323 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
324 },
325 },
326 ],
327 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
328 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows the form: &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
329 },
330 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
331 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.
332 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
333 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
334 },
335 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
336 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700337 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700338 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700339 }</pre>
340</div>
341
342<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700343 <code class="details" id="close">close()</code>
344 <pre>Close httplib2 connections.</pre>
345</div>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700346
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700347<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800348 <code class="details" id="list">list(languageCode=None, filter=None, view=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700349 <pre>Lists all the Photos that belong to the user. *Note:* Recently created photos that are still being indexed are not returned in the response.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700350
351Args:
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800352 languageCode: string, The BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user&#x27;s language preference for Google services is used.
353 filter: string, Required. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is `placeId`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700354 view: string, Required. Specifies if a download URL for the photos bytes should be returned in the Photos response.
355 Allowed values
356 BASIC - Server reponses do not include the download URL for the photo bytes. The default value.
357 INCLUDE_DOWNLOAD_URL - Server responses include the download URL for the photo bytes.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800358 pageSize: integer, 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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800359 pageToken: string, The nextPageToken value returned from a previous ListPhotos request, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700360 x__xgafv: string, V1 error format.
361 Allowed values
362 1 - v1 error format
363 2 - v2 error format
364
365Returns:
366 An object of the form:
367
368 { # Response to list all photos that belong to a user.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800369 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700370 &quot;photos&quot;: [ # List of photos. The pageSize field in the request determines the number of items returned.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700371 { # Photo is used to store 360 photos along with photo metadata.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800372 &quot;places&quot;: [ # Places where this photo belongs.
373 { # Place metadata for an entity.
374 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
375 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
376 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in https://developers.google.com/places/place-id.
377 },
378 ],
379 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
380 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
381 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
382 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be &gt;=0 and &lt;360. NaN indicates an unmeasured quantity.
383 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90 and &lt;= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
384 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
385 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
386 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
387 },
388 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
389 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
390 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
391 &quot;latLngPair&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
392 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
393 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800394 },
395 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800396 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
397 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
398 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this photo to another photo.
399 { # A connection is the link from a source photo to a destination photo.
400 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
401 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
402 },
403 },
404 ],
405 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
406 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows the form: &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
407 },
408 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
409 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.
410 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
411 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
412 },
413 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
414 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700415 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700416 }</pre>
417</div>
418
419<div class="method">
420 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
421 <pre>Retrieves the next page of results.
422
423Args:
424 previous_request: The request for the previous page. (required)
425 previous_response: The response from the request for the previous page. (required)
426
427Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700428 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700429 page. Returns None if there are no more items in the collection.
430 </pre>
431</div>
432
433</body></html>