blob: d0b77c45f12f4af5c8dbcbb3041f5247526998bb [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 Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#batchGet">batchGet(view=None, languageCode=None, photoIds=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 Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#list">list(languageCode=None, view=None, pageSize=None, filter=None, pageToken=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 Kimd059ad82020-07-22 17:02:09 -0700149 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
150 # user-facing error message should be localized and sent in the
151 # google.rpc.Status.details field, or localized by the client.
152 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700153 },
154 ],
155 }</pre>
156</div>
157
158<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700159 <code class="details" id="batchGet">batchGet(view=None, languageCode=None, photoIds=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 view: string, Required. Specifies if a download URL for the photo bytes should be returned in the
179Photo response.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700180 languageCode: string, The BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more
181information, see
182http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
183If language_code is unspecified, the user&#x27;s language preference for Google
184services is used.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700185 photoIds: string, Required. IDs of the Photos. For HTTP
186GET requests, the URL query parameter should be
187`photoIds=&lt;id1&gt;&amp;photoIds=&lt;id2&gt;&amp;...`. (repeated)
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 Kimd059ad82020-07-22 17:02:09 -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;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
210 # Identifier for the photo, which is unique among all photos in
211 # Google.
212 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
213 },
214 &quot;places&quot;: [ # Places where this photo belongs.
215 { # Place metadata for an entity.
216 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
217 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
218 # be the language_code specified in the request, but may be a fallback.
219 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
220 # https://developers.google.com/places/place-id.
221 },
222 ],
223 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
224 # when
225 # GetPhotoRequest.view
226 # is set to
227 # PhotoView.INCLUDE_DOWNLOAD_URL.
228 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
229 # When the photo has no exif timestamp, this is used to set a timestamp in
230 # the photo metadata.
231 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
232 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
233 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
234 # from North. Value must be &gt;=0 and &lt;360.
235 # NaN indicates an unmeasured quantity.
236 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
237 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
238 # Consider how the elevator buttons would be labeled for this level if there
239 # was an elevator.
240 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
241 # the first level above ground level, -1 indicates the first level under
242 # ground level. Non-integer values are OK.
243 },
244 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
245 # means level with the horizon.
246 # NaN indicates an unmeasured quantity.
247 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
248 # NaN indicates an unmeasured quantity.
249 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
250 # confidence (one standard deviation). For example, on Android, this value is
251 # available from this method:
252 # https://developer.android.com/reference/android/location/Location#getAccuracy().
253 # Other platforms have different methods of obtaining similar accuracy
254 # estimations.
255 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
256 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
257 # means looking directly up.
258 # NaN indicates an unmeasured quantity.
259 &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:
260 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
261 # When creating a Photo, if the
262 # latitude and longitude pair are not provided, the geolocation from the
263 # exif header is used. A latitude and longitude pair not provided in the
264 # photo or exif header causes the photo process to fail.
265 # of doubles representing degrees latitude and degrees longitude. Unless
266 # specified otherwise, this must conform to the
267 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
268 # standard&lt;/a&gt;. Values must be within normalized ranges.
269 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
270 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
271 },
272 },
273 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
274 # photo to another photo.
275 { # A connection is the link from a source photo to a destination photo.
276 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
277 # another photo.
278 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
279 },
280 },
281 ],
282 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
283 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
284 # photo bytes are uploaded to.
285 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
286 # the form:
287 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
288 },
289 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
290 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
291 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
292 # rejected. Not currently populated.
293 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700294 &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 Kimd059ad82020-07-22 17:02:09 -0700308 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
309 # user-facing error message should be localized and sent in the
310 # google.rpc.Status.details field, or localized by the client.
311 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
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 Kimd059ad82020-07-22 17:02:09 -0700365 &quot;photo&quot;: { # Photo is used to store 360 photos along with photo metadata. # Required. Photo object containing the
366 # new metadata.
367 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
368 # Identifier for the photo, which is unique among all photos in
369 # Google.
370 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
371 },
372 &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
376 # be the language_code specified in the request, but may be a fallback.
377 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
378 # https://developers.google.com/places/place-id.
379 },
380 ],
381 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
382 # when
383 # GetPhotoRequest.view
384 # is set to
385 # PhotoView.INCLUDE_DOWNLOAD_URL.
386 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
387 # When the photo has no exif timestamp, this is used to set a timestamp in
388 # the photo metadata.
389 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
390 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
391 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
392 # from North. Value must be &gt;=0 and &lt;360.
393 # NaN indicates an unmeasured quantity.
394 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
395 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
396 # Consider how the elevator buttons would be labeled for this level if there
397 # was an elevator.
398 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
399 # the first level above ground level, -1 indicates the first level under
400 # ground level. Non-integer values are OK.
401 },
402 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
403 # means level with the horizon.
404 # NaN indicates an unmeasured quantity.
405 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
406 # NaN indicates an unmeasured quantity.
407 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
408 # confidence (one standard deviation). For example, on Android, this value is
409 # available from this method:
410 # https://developer.android.com/reference/android/location/Location#getAccuracy().
411 # Other platforms have different methods of obtaining similar accuracy
412 # estimations.
413 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
414 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
415 # means looking directly up.
416 # NaN indicates an unmeasured quantity.
417 &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:
418 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
419 # When creating a Photo, if the
420 # latitude and longitude pair are not provided, the geolocation from the
421 # exif header is used. A latitude and longitude pair not provided in the
422 # photo or exif header causes the photo process to fail.
423 # of doubles representing degrees latitude and degrees longitude. Unless
424 # specified otherwise, this must conform to the
425 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
426 # standard&lt;/a&gt;. Values must be within normalized ranges.
427 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
428 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
429 },
430 },
431 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
432 # photo to another photo.
433 { # A connection is the link from a source photo to a destination photo.
434 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
435 # another photo.
436 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
437 },
438 },
439 ],
440 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
441 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
442 # photo bytes are uploaded to.
443 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
444 # the form:
445 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
446 },
447 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
448 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
449 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
450 # rejected. Not currently populated.
451 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700452 &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 Kim4ed7d3f2020-05-27 12:20:54 -0700501 &quot;photo&quot;: { # Photo is used to store 360 photos along with photo metadata. # The Photo resource, if the request
502 # was successful.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700503 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
504 # Identifier for the photo, which is unique among all photos in
505 # Google.
506 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700507 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700508 &quot;places&quot;: [ # Places where this photo belongs.
509 { # Place metadata for an entity.
510 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
511 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
512 # be the language_code specified in the request, but may be a fallback.
513 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
514 # https://developers.google.com/places/place-id.
515 },
516 ],
517 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
518 # when
519 # GetPhotoRequest.view
520 # is set to
521 # PhotoView.INCLUDE_DOWNLOAD_URL.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700522 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
523 # When the photo has no exif timestamp, this is used to set a timestamp in
524 # the photo metadata.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700525 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
526 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
527 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
528 # from North. Value must be &gt;=0 and &lt;360.
529 # NaN indicates an unmeasured quantity.
530 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
531 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
532 # Consider how the elevator buttons would be labeled for this level if there
533 # was an elevator.
534 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
535 # the first level above ground level, -1 indicates the first level under
536 # ground level. Non-integer values are OK.
537 },
538 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
539 # means level with the horizon.
540 # NaN indicates an unmeasured quantity.
541 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
542 # NaN indicates an unmeasured quantity.
543 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
544 # confidence (one standard deviation). For example, on Android, this value is
545 # available from this method:
546 # https://developer.android.com/reference/android/location/Location#getAccuracy().
547 # Other platforms have different methods of obtaining similar accuracy
548 # estimations.
549 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
550 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
551 # means looking directly up.
552 # NaN indicates an unmeasured quantity.
553 &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:
554 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
555 # When creating a Photo, if the
556 # latitude and longitude pair are not provided, the geolocation from the
557 # exif header is used. A latitude and longitude pair not provided in the
558 # photo or exif header causes the photo process to fail.
559 # of doubles representing degrees latitude and degrees longitude. Unless
560 # specified otherwise, this must conform to the
561 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
562 # standard&lt;/a&gt;. Values must be within normalized ranges.
563 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
564 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
565 },
566 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700567 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
568 # photo to another photo.
569 { # A connection is the link from a source photo to a destination photo.
570 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
571 # another photo.
572 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
573 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700574 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700575 ],
576 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
577 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
578 # photo bytes are uploaded to.
579 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
580 # the form:
581 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
Bu Sun Kim65020912020-05-20 12:08:20 -0700582 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700583 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700584 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700585 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
586 # rejected. Not currently populated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700587 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -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;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
603 # user-facing error message should be localized and sent in the
604 # google.rpc.Status.details field, or localized by the client.
605 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
606 },
607 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700608 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700609 }</pre>
610</div>
611
612<div class="method">
613 <code class="details" id="list">list(languageCode=None, view=None, pageSize=None, filter=None, pageToken=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 languageCode: string, The BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more
622information, see
623http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
624If language_code is unspecified, the user&#x27;s language preference for Google
625services is used.
626 view: string, Required. Specifies if a download URL for the photos bytes should be returned in the
627Photos response.
628 pageSize: integer, The maximum number of photos to return.
629`pageSize` must be non-negative. If `pageSize` is zero or is not provided,
630the default page size of 100 is used.
631The number of photos returned in the response may be less than `pageSize`
632if the number of photos that belong to the user is less than `pageSize`.
633 filter: string, Required. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.
634
635The only filter supported at the moment is `placeId`.
636 pageToken: string, The
637nextPageToken
638value returned from a previous
639ListPhotos
640request, if any.
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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700650 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700652 &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;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
657 # Identifier for the photo, which is unique among all photos in
658 # Google.
659 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
660 },
661 &quot;places&quot;: [ # Places where this photo belongs.
662 { # Place metadata for an entity.
663 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
664 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
665 # be the language_code specified in the request, but may be a fallback.
666 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
667 # https://developers.google.com/places/place-id.
668 },
669 ],
670 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
671 # when
672 # GetPhotoRequest.view
673 # is set to
674 # PhotoView.INCLUDE_DOWNLOAD_URL.
675 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
676 # When the photo has no exif timestamp, this is used to set a timestamp in
677 # the photo metadata.
678 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
679 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
680 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
681 # from North. Value must be &gt;=0 and &lt;360.
682 # NaN indicates an unmeasured quantity.
683 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
684 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
685 # Consider how the elevator buttons would be labeled for this level if there
686 # was an elevator.
687 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
688 # the first level above ground level, -1 indicates the first level under
689 # ground level. Non-integer values are OK.
690 },
691 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
692 # means level with the horizon.
693 # NaN indicates an unmeasured quantity.
694 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
695 # NaN indicates an unmeasured quantity.
696 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
697 # confidence (one standard deviation). For example, on Android, this value is
698 # available from this method:
699 # https://developer.android.com/reference/android/location/Location#getAccuracy().
700 # Other platforms have different methods of obtaining similar accuracy
701 # estimations.
702 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
703 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
704 # means looking directly up.
705 # NaN indicates an unmeasured quantity.
706 &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:
707 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
708 # When creating a Photo, if the
709 # latitude and longitude pair are not provided, the geolocation from the
710 # exif header is used. A latitude and longitude pair not provided in the
711 # photo or exif header causes the photo process to fail.
712 # of doubles representing degrees latitude and degrees longitude. Unless
713 # specified otherwise, this must conform to the
714 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
715 # standard&lt;/a&gt;. Values must be within normalized ranges.
716 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
717 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
718 },
719 },
720 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
721 # photo to another photo.
722 { # A connection is the link from a source photo to a destination photo.
723 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
724 # another photo.
725 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
726 },
727 },
728 ],
729 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
730 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
731 # photo bytes are uploaded to.
732 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
733 # the form:
734 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
735 },
736 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
737 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
738 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
739 # rejected. Not currently populated.
740 },
741 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700742 }</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>