blob: 9288f1dde2b4fde1cf5acc93006dc9913f3b2029 [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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Deletes a list of Photos and their</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070081 <code><a href="#batchGet">batchGet(languageCode=None, photoIds=None, view=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Gets the metadata of the specified</p>
83<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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Updates the metadata of Photos, such</p>
86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070087 <code><a href="#list">list(pageToken=None, filter=None, languageCode=None, view=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Lists all the Photos that belong to</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070094 <code class="details" id="batchDelete">batchDelete(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070095 <pre>Deletes a list of Photos and their
96metadata.
97
98Note that if
99BatchDeletePhotos
100fails, either critical fields are missing or there is an authentication
101error. Even if
102BatchDeletePhotos
103succeeds, individual photos in the batch may have failures.
104These failures are specified in each
105PhotoResponse.status
106in
107BatchDeletePhotosResponse.results.
108See
109DeletePhoto
110for specific failures that can occur per photo.
111
112Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700113 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700114 The object takes the form of:
115
116{ # Request to delete multiple Photos.
Bu Sun Kim65020912020-05-20 12:08:20 -0700117 &quot;photoIds&quot;: [ # Required. IDs of the Photos. HTTP
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700118 # GET requests require the following syntax for the URL query parameter:
Dan O'Mearadd494642020-05-01 07:42:23 -0700119 # `photoIds=&lt;id1&gt;&amp;photoIds=&lt;id2&gt;&amp;...`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700120 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700121 ],
122 }
123
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129Returns:
130 An object of the form:
131
132 { # Response to batch delete of one or more
133 # Photos.
Bu Sun Kim65020912020-05-20 12:08:20 -0700134 &quot;status&quot;: [ # The status for the operation to delete a single
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700135 # Photo in the batch request.
136 { # The `Status` type defines a logical error model that is suitable for
137 # different programming environments, including REST APIs and RPC APIs. It is
138 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
139 # three pieces of data: error code, error message, and error details.
140 #
141 # You can find out more about this error model and how to work with it in the
142 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700143 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700144 # message types for APIs to use.
145 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700146 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700147 },
148 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700149 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
150 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
151 # user-facing error message should be localized and sent in the
152 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700153 },
154 ],
155 }</pre>
156</div>
157
158<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700159 <code class="details" id="batchGet">batchGet(languageCode=None, photoIds=None, view=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700160 <pre>Gets the metadata of the specified
161Photo batch.
162
163Note that if
164BatchGetPhotos
165fails, either critical fields are missing or there is an authentication
166error. Even if
167BatchGetPhotos
168succeeds, individual photos in the batch may have failures.
169These failures are specified in each
170PhotoResponse.status
171in
172BatchGetPhotosResponse.results.
173See
174GetPhoto
175for specific failures that can occur per photo.
176
177Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700178 languageCode: string, The BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700179information, see
180http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
Bu Sun Kim65020912020-05-20 12:08:20 -0700181If language_code is unspecified, the user&#x27;s language preference for Google
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700182services is used.
183 photoIds: string, Required. IDs of the Photos. For HTTP
184GET requests, the URL query parameter should be
Dan O'Mearadd494642020-05-01 07:42:23 -0700185`photoIds=&lt;id1&gt;&amp;photoIds=&lt;id2&gt;&amp;...`. (repeated)
Bu Sun Kim65020912020-05-20 12:08:20 -0700186 view: string, Required. Specifies if a download URL for the photo bytes should be returned in the
187Photo response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700188 x__xgafv: string, V1 error format.
189 Allowed values
190 1 - v1 error format
191 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700192
193Returns:
194 An object of the form:
195
196 { # Response to batch get of Photos.
Bu Sun Kim65020912020-05-20 12:08:20 -0700197 &quot;results&quot;: [ # List of results for each individual
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700198 # Photo requested, in the same order as
199 # the requests in
200 # BatchGetPhotos.
201 { # Response payload for a single
202 # Photo
203 # in batch operations including
204 # BatchGetPhotos
205 # and
206 # BatchUpdatePhotos.
Bu Sun Kim65020912020-05-20 12:08:20 -0700207 &quot;photo&quot;: { # Photo is used to store 360 photos along with photo metadata. # The Photo resource, if the request
208 # was successful.
209 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
210 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
211 # photo to another photo.
212 { # A connection is the link from a source photo to a destination photo.
213 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
214 # another photo.
215 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
216 },
217 },
218 ],
219 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
220 # when
221 # GetPhotoRequest.view
222 # is set to
223 # PhotoView.INCLUDE_DOWNLOAD_URL.
224 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
225 # rejected. Not currently populated.
226 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
227 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
228 # photo bytes are uploaded to.
229 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
230 # the form:
231 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
232 },
233 &quot;places&quot;: [ # Places where this photo belongs.
234 { # Place metadata for an entity.
235 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
236 # https://developers.google.com/places/place-id.
237 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
238 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
239 # be the language_code specified in the request, but may be a fallback.
240 },
241 ],
242 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
243 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
244 # means level with the horizon.
245 # NaN indicates an unmeasured quantity.
246 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
247 # NaN indicates an unmeasured quantity.
248 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
249 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
250 # means looking directly up.
251 # NaN indicates an unmeasured quantity.
252 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
253 # confidence (one standard deviation). For example, on Android, this value is
254 # available from this method:
255 # https://developer.android.com/reference/android/location/Location#getAccuracy().
256 # Other platforms have different methods of obtaining similar accuracy
257 # estimations.
258 &quot;latLngPair&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
259 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
260 # When creating a Photo, if the
261 # latitude and longitude pair are not provided, the geolocation from the
262 # exif header is used. A latitude and longitude pair not provided in the
263 # photo or exif header causes the photo process to fail.
264 # of doubles representing degrees latitude and degrees longitude. Unless
265 # specified otherwise, this must conform to the
266 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
267 # standard&lt;/a&gt;. Values must be within normalized ranges.
268 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
269 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
270 },
271 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
272 # from North. Value must be &gt;=0 and &lt;360.
273 # NaN indicates an unmeasured quantity.
274 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
275 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
276 # the first level above ground level, -1 indicates the first level under
277 # ground level. Non-integer values are OK.
278 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
279 # Consider how the elevator buttons would be labeled for this level if there
280 # was an elevator.
281 },
282 },
283 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
284 # When the photo has no exif timestamp, this is used to set a timestamp in
285 # the photo metadata.
286 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
287 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
288 # Identifier for the photo, which is unique among all photos in
289 # Google.
290 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
291 },
292 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
293 },
294 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # The status for the operation to get or update a single photo in the batch
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700295 # request.
296 # different programming environments, including REST APIs and RPC APIs. It is
297 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
298 # three pieces of data: error code, error message, and error details.
299 #
300 # You can find out more about this error model and how to work with it in the
301 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700302 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700303 # message types for APIs to use.
304 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700305 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700306 },
307 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700308 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
309 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
310 # user-facing error message should be localized and sent in the
311 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700312 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700313 },
314 ],
315 }</pre>
316</div>
317
318<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700319 <code class="details" id="batchUpdate">batchUpdate(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700320 <pre>Updates the metadata of Photos, such
321as pose, place association, connections, etc. Changing the pixels of photos
322is not supported.
323
324Note that if
325BatchUpdatePhotos
326fails, either critical fields are missing or there is an authentication
327error. Even if
328BatchUpdatePhotos
329succeeds, individual photos in the batch may have failures.
330These failures are specified in each
331PhotoResponse.status
332in
333BatchUpdatePhotosResponse.results.
334See
335UpdatePhoto
336for specific failures that can occur per photo.
337
338Only the fields specified in
339updateMask
340field are used. If `updateMask` is not present, the update applies to all
341fields.
342
343The number of
344UpdatePhotoRequest
345messages in a
346BatchUpdatePhotosRequest
347must not exceed 20.
348
Bu Sun Kim65020912020-05-20 12:08:20 -0700349&lt;aside class=&quot;note&quot;&gt;&lt;b&gt;Note:&lt;/b&gt; To update
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700350Pose.altitude,
351Pose.latLngPair has to be
Dan O'Mearadd494642020-05-01 07:42:23 -0700352filled as well. Otherwise, the request will fail.&lt;/aside&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700353
354Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700355 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700356 The object takes the form of:
357
358{ # Request to update the metadata of photos.
359 # Updating the pixels of photos is not supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700360 &quot;updatePhotoRequests&quot;: [ # Required. List of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700361 # UpdatePhotoRequests.
362 { # Request to update the metadata of a
363 # Photo. Updating the pixels of a photo
364 # is not supported.
Bu Sun Kim65020912020-05-20 12:08:20 -0700365 &quot;photo&quot;: { # Photo is used to store 360 photos along with photo metadata. # Required. Photo object containing the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700366 # new metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700367 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
368 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
369 # photo to another photo.
370 { # A connection is the link from a source photo to a destination photo.
371 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
372 # another photo.
373 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
374 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700375 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700376 ],
377 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
378 # when
379 # GetPhotoRequest.view
380 # is set to
381 # PhotoView.INCLUDE_DOWNLOAD_URL.
382 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
383 # rejected. Not currently populated.
384 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
385 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
386 # photo bytes are uploaded to.
387 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
388 # the form:
389 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700390 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700391 &quot;places&quot;: [ # Places where this photo belongs.
392 { # Place metadata for an entity.
393 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
394 # https://developers.google.com/places/place-id.
395 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
396 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
397 # be the language_code specified in the request, but may be a fallback.
398 },
399 ],
400 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
401 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
402 # means level with the horizon.
403 # NaN indicates an unmeasured quantity.
404 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
405 # NaN indicates an unmeasured quantity.
406 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
407 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
408 # means looking directly up.
409 # NaN indicates an unmeasured quantity.
410 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
411 # confidence (one standard deviation). For example, on Android, this value is
412 # available from this method:
413 # https://developer.android.com/reference/android/location/Location#getAccuracy().
414 # Other platforms have different methods of obtaining similar accuracy
415 # estimations.
416 &quot;latLngPair&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
417 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
418 # When creating a Photo, if the
419 # latitude and longitude pair are not provided, the geolocation from the
420 # exif header is used. A latitude and longitude pair not provided in the
421 # photo or exif header causes the photo process to fail.
422 # of doubles representing degrees latitude and degrees longitude. Unless
423 # specified otherwise, this must conform to the
424 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
425 # standard&lt;/a&gt;. Values must be within normalized ranges.
426 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
427 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
428 },
429 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
430 # from North. Value must be &gt;=0 and &lt;360.
431 # NaN indicates an unmeasured quantity.
432 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
433 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
434 # the first level above ground level, -1 indicates the first level under
435 # ground level. Non-integer values are OK.
436 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
437 # Consider how the elevator buttons would be labeled for this level if there
438 # was an elevator.
439 },
440 },
441 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
442 # When the photo has no exif timestamp, this is used to set a timestamp in
443 # the photo metadata.
444 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
445 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
446 # Identifier for the photo, which is unique among all photos in
447 # Google.
448 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
449 },
450 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
451 },
452 &quot;updateMask&quot;: &quot;A String&quot;, # Required. Mask that identifies fields on the photo metadata to update.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700453 # If not present, the old Photo
454 # metadata is entirely replaced with the
455 # new Photo metadata in this request.
456 # The update fails if invalid fields are specified. Multiple fields can be
457 # specified in a comma-delimited list.
458 #
459 # The following fields are valid:
460 #
461 # * `pose.heading`
462 # * `pose.latLngPair`
463 # * `pose.pitch`
464 # * `pose.roll`
465 # * `pose.level`
466 # * `pose.altitude`
467 # * `connections`
468 # * `places`
469 #
470 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700471 # &lt;aside class=&quot;note&quot;&gt;&lt;b&gt;Note:&lt;/b&gt; When
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700472 # updateMask
473 # contains repeated fields, the entire set of repeated values get replaced
474 # with the new contents. For example, if
475 # updateMask
476 # contains `connections` and `UpdatePhotoRequest.photo.connections` is empty,
Dan O'Mearadd494642020-05-01 07:42:23 -0700477 # all connections are removed.&lt;/aside&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700478 },
479 ],
480 }
481
482 x__xgafv: string, V1 error format.
483 Allowed values
484 1 - v1 error format
485 2 - v2 error format
486
487Returns:
488 An object of the form:
489
490 { # Response to batch update of metadata of one or more
491 # Photos.
Bu Sun Kim65020912020-05-20 12:08:20 -0700492 &quot;results&quot;: [ # List of results for each individual
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700493 # Photo updated, in the same order as
494 # the request.
495 { # Response payload for a single
496 # Photo
497 # in batch operations including
498 # BatchGetPhotos
499 # and
500 # BatchUpdatePhotos.
Bu Sun Kim65020912020-05-20 12:08:20 -0700501 &quot;photo&quot;: { # Photo is used to store 360 photos along with photo metadata. # The Photo resource, if the request
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700502 # was successful.
Bu Sun Kim65020912020-05-20 12:08:20 -0700503 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
504 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700505 # photo to another photo.
506 { # A connection is the link from a source photo to a destination photo.
Bu Sun Kim65020912020-05-20 12:08:20 -0700507 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700508 # another photo.
Bu Sun Kim65020912020-05-20 12:08:20 -0700509 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700510 },
511 },
512 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700513 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
514 # when
515 # GetPhotoRequest.view
516 # is set to
517 # PhotoView.INCLUDE_DOWNLOAD_URL.
518 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
519 # rejected. Not currently populated.
520 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
521 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
522 # photo bytes are uploaded to.
523 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
524 # the form:
525 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
526 },
527 &quot;places&quot;: [ # Places where this photo belongs.
528 { # Place metadata for an entity.
529 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
530 # https://developers.google.com/places/place-id.
531 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
532 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
533 # be the language_code specified in the request, but may be a fallback.
534 },
535 ],
536 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
537 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
538 # means level with the horizon.
539 # NaN indicates an unmeasured quantity.
540 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
541 # NaN indicates an unmeasured quantity.
542 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
543 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
544 # means looking directly up.
545 # NaN indicates an unmeasured quantity.
546 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
547 # confidence (one standard deviation). For example, on Android, this value is
548 # available from this method:
549 # https://developer.android.com/reference/android/location/Location#getAccuracy().
550 # Other platforms have different methods of obtaining similar accuracy
551 # estimations.
552 &quot;latLngPair&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700553 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
554 # When creating a Photo, if the
555 # latitude and longitude pair are not provided, the geolocation from the
556 # exif header is used. A latitude and longitude pair not provided in the
557 # photo or exif header causes the photo process to fail.
558 # of doubles representing degrees latitude and degrees longitude. Unless
559 # specified otherwise, this must conform to the
Bu Sun Kim65020912020-05-20 12:08:20 -0700560 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
Dan O'Mearadd494642020-05-01 07:42:23 -0700561 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim65020912020-05-20 12:08:20 -0700562 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
563 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700564 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700565 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
Dan O'Mearadd494642020-05-01 07:42:23 -0700566 # from North. Value must be &gt;=0 and &lt;360.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700567 # NaN indicates an unmeasured quantity.
Bu Sun Kim65020912020-05-20 12:08:20 -0700568 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
569 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
570 # the first level above ground level, -1 indicates the first level under
571 # ground level. Non-integer values are OK.
572 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
573 # Consider how the elevator buttons would be labeled for this level if there
574 # was an elevator.
575 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700576 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700577 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700578 # When the photo has no exif timestamp, this is used to set a timestamp in
579 # the photo metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700580 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
581 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
582 # Identifier for the photo, which is unique among all photos in
583 # Google.
584 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
585 },
586 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700587 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700588 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # The status for the operation to get or update a single photo in the batch
589 # request.
590 # different programming environments, including REST APIs and RPC APIs. It is
591 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
592 # three pieces of data: error code, error message, and error details.
593 #
594 # You can find out more about this error model and how to work with it in the
595 # [API Design Guide](https://cloud.google.com/apis/design/errors).
596 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
597 # message types for APIs to use.
598 {
599 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
600 },
601 ],
602 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
603 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
604 # user-facing error message should be localized and sent in the
605 # google.rpc.Status.details field, or localized by the client.
606 },
607 },
608 ],
609 }</pre>
610</div>
611
612<div class="method">
613 <code class="details" id="list">list(pageToken=None, filter=None, languageCode=None, view=None, pageSize=None, x__xgafv=None)</code>
614 <pre>Lists all the Photos that belong to
615the user.
616
617&lt;aside class=&quot;note&quot;&gt;&lt;b&gt;Note:&lt;/b&gt; Recently created photos that are still
618being indexed are not returned in the response.&lt;/aside&gt;
619
620Args:
621 pageToken: string, The
622nextPageToken
623value returned from a previous
624ListPhotos
625request, if any.
626 filter: string, Required. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.
627
628The only filter supported at the moment is `placeId`.
629 languageCode: string, The BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more
630information, see
631http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
632If language_code is unspecified, the user&#x27;s language preference for Google
633services is used.
634 view: string, Required. Specifies if a download URL for the photos bytes should be returned in the
635Photos response.
636 pageSize: integer, The maximum number of photos to return.
637`pageSize` must be non-negative. If `pageSize` is zero or is not provided,
638the default page size of 100 is used.
639The number of photos returned in the response may be less than `pageSize`
640if the number of photos that belong to the user is less than `pageSize`.
641 x__xgafv: string, V1 error format.
642 Allowed values
643 1 - v1 error format
644 2 - v2 error format
645
646Returns:
647 An object of the form:
648
649 { # Response to list all photos that belong to a user.
650 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more
651 # results in the list.
652 &quot;photos&quot;: [ # List of photos. The
653 # pageSize field
654 # in the request determines the number of items returned.
655 { # Photo is used to store 360 photos along with photo metadata.
656 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
657 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
658 # photo to another photo.
659 { # A connection is the link from a source photo to a destination photo.
660 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
661 # another photo.
662 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
663 },
664 },
665 ],
666 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
667 # when
668 # GetPhotoRequest.view
669 # is set to
670 # PhotoView.INCLUDE_DOWNLOAD_URL.
671 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
672 # rejected. Not currently populated.
673 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
674 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
675 # photo bytes are uploaded to.
676 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
677 # the form:
678 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
679 },
680 &quot;places&quot;: [ # Places where this photo belongs.
681 { # Place metadata for an entity.
682 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
683 # https://developers.google.com/places/place-id.
684 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
685 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
686 # be the language_code specified in the request, but may be a fallback.
687 },
688 ],
689 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
690 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
691 # means level with the horizon.
692 # NaN indicates an unmeasured quantity.
693 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
694 # NaN indicates an unmeasured quantity.
695 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
696 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
697 # means looking directly up.
698 # NaN indicates an unmeasured quantity.
699 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
700 # confidence (one standard deviation). For example, on Android, this value is
701 # available from this method:
702 # https://developer.android.com/reference/android/location/Location#getAccuracy().
703 # Other platforms have different methods of obtaining similar accuracy
704 # estimations.
705 &quot;latLngPair&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
706 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
707 # When creating a Photo, if the
708 # latitude and longitude pair are not provided, the geolocation from the
709 # exif header is used. A latitude and longitude pair not provided in the
710 # photo or exif header causes the photo process to fail.
711 # of doubles representing degrees latitude and degrees longitude. Unless
712 # specified otherwise, this must conform to the
713 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
714 # standard&lt;/a&gt;. Values must be within normalized ranges.
715 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
716 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
717 },
718 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
719 # from North. Value must be &gt;=0 and &lt;360.
720 # NaN indicates an unmeasured quantity.
721 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
722 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
723 # the first level above ground level, -1 indicates the first level under
724 # ground level. Non-integer values are OK.
725 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
726 # Consider how the elevator buttons would be labeled for this level if there
727 # was an elevator.
728 },
729 },
730 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
731 # When the photo has no exif timestamp, this is used to set a timestamp in
732 # the photo metadata.
733 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
734 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
735 # Identifier for the photo, which is unique among all photos in
736 # Google.
737 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
738 },
739 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
740 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700741 ],
742 }</pre>
743</div>
744
745<div class="method">
746 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
747 <pre>Retrieves the next page of results.
748
749Args:
750 previous_request: The request for the previous page. (required)
751 previous_response: The response from the request for the previous page. (required)
752
753Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700754 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700755 page. Returns None if there are no more items in the collection.
756 </pre>
757</div>
758
759</body></html>