Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / streetviewpublish_v1.photos.html
blob: 6265b56e8b297d35619e579697f6e28539b254fd [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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 -0700[diff] [blame^]78 <code><a href="#batchDelete">batchDelete(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Deletes a list of Photos and their</p>
80<p class="toc_element">
81 <code><a href="#batchGet">batchGet(languageCode=None, photoIds=None, x__xgafv=None, view=None)</a></code></p>
82<p class="firstline">Gets the metadata of the specified</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#batchUpdate">batchUpdate(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Updates the metadata of Photos, such</p>
86<p class="toc_element">
87 <code><a href="#list">list(languageCode=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
88<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 -0700[diff] [blame^]94 <code class="details" id="batchDelete">batchDelete(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95 <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 -0700[diff] [blame^]113 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 The object takes the form of:
115
116{ # Request to delete multiple Photos.
117 "photoIds": [ # Required. IDs of the Photos. HTTP
118 # GET requests require the following syntax for the URL query parameter:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]119 # `photoIds=&lt;id1&gt;&amp;photoIds=&lt;id2&gt;&amp;...`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 "A String",
121 ],
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.
134 "status": [ # The status for the operation to delete a single
135 # 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).
143 "message": "A String", # A developer-facing error message, which should be in English. Any
144 # user-facing error message should be localized and sent in the
145 # google.rpc.Status.details field, or localized by the client.
146 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
147 "details": [ # A list of messages that carry the error details. There is a common set of
148 # message types for APIs to use.
149 {
150 "a_key": "", # Properties of the object. Contains field @type with type URL.
151 },
152 ],
153 },
154 ],
155 }</pre>
156</div>
157
158<div class="method">
159 <code class="details" id="batchGet">batchGet(languageCode=None, photoIds=None, x__xgafv=None, view=None)</code>
160 <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:
178 languageCode: string, The BCP-47 language code, such as "en-US" or "sr-Latn". For more
179information, see
180http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
181If language_code is unspecified, the user's language preference for Google
182services 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 -0700[diff] [blame^]185`photoIds=&lt;id1&gt;&amp;photoIds=&lt;id2&gt;&amp;...`. (repeated)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]190 view: string, Required. Specifies if a download URL for the photo bytes should be returned in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191Photo response.
192
193Returns:
194 An object of the form:
195
196 { # Response to batch get of Photos.
197 "results": [ # List of results for each individual
198 # 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.
207 "status": { # 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
208 # request.
209 # different programming environments, including REST APIs and RPC APIs. It is
210 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
211 # three pieces of data: error code, error message, and error details.
212 #
213 # You can find out more about this error model and how to work with it in the
214 # [API Design Guide](https://cloud.google.com/apis/design/errors).
215 "message": "A String", # A developer-facing error message, which should be in English. Any
216 # user-facing error message should be localized and sent in the
217 # google.rpc.Status.details field, or localized by the client.
218 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
219 "details": [ # A list of messages that carry the error details. There is a common set of
220 # message types for APIs to use.
221 {
222 "a_key": "", # Properties of the object. Contains field @type with type URL.
223 },
224 ],
225 },
226 "photo": { # Photo is used to store 360 photos along with photo metadata. # The Photo resource, if the request
227 # was successful.
228 "viewCount": "A String", # Output only. View count of the photo.
229 "photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
230 # Identifier for the photo, which is unique among all photos in
231 # Google.
232 "id": "A String", # Required. A unique identifier for a photo.
233 },
234 "uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
235 # photo bytes are uploaded to.
236 "uploadUrl": "A String", # Required. An upload reference should be unique for each user. It follows
237 # the form:
238 # "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
239 },
240 "places": [ # Places where this photo belongs.
241 { # Place metadata for an entity.
242 "languageCode": "A String", # Output-only. The language_code that the name is localized with. This should
243 # be the language_code specified in the request, but may be a fallback.
244 "name": "A String", # Output-only. The name of the place, localized to the language_code.
245 "placeId": "A String", # Place identifier, as described in
246 # https://developers.google.com/places/place-id.
247 },
248 ],
249 "connections": [ # Connections to other photos. A connection represents the link from this
250 # photo to another photo.
251 { # A connection is the link from a source photo to a destination photo.
252 "target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
253 # another photo.
254 "id": "A String", # Required. A unique identifier for a photo.
255 },
256 },
257 ],
258 "pose": { # Raw pose measurement for an entity. # Pose of the photo.
259 "latLngPair": { # 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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]267 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
268 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
270 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
271 },
272 "level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]273 "name": "A String", # Required. A name assigned to this Level, restricted to 3 characters.
274 # Consider how the elevator buttons would be labeled for this level if there
275 # was an elevator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]276 "number": 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
277 # the first level above ground level, -1 indicates the first level under
278 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 },
280 "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
281 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]282 "roll": 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
283 # means level with the horizon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]285 "pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
286 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]287 # means looking directly up.
288 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]289 "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
290 # from North. Value must be &gt;=0 and &lt;360.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291 # NaN indicates an unmeasured quantity.
292 "accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
293 # confidence (one standard deviation). For example, on Android, this value is
294 # available from this method:
295 # https://developer.android.com/reference/android/location/Location#getAccuracy().
296 # Other platforms have different methods of obtaining similar accuracy
297 # estimations.
298 },
299 "downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
300 # when
301 # GetPhotoRequest.view
302 # is set to
303 # PhotoView.INCLUDE_DOWNLOAD_URL.
304 "transferStatus": "A String", # Output only. Status of rights transfer on this photo.
305 "mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]306 # rejected. Not currently populated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 "captureTime": "A String", # Absolute time when the photo was captured.
308 # When the photo has no exif timestamp, this is used to set a timestamp in
309 # the photo metadata.
310 "thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
311 "shareLink": "A String", # Output only. The share link for the photo.
312 },
313 },
314 ],
315 }</pre>
316</div>
317
318<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]319 <code class="details" id="batchUpdate">batchUpdate(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 <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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]349&lt;aside class="note"&gt;&lt;b&gt;Note:&lt;/b&gt; To update
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]350Pose.altitude,
351Pose.latLngPair has to be
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]352filled as well. Otherwise, the request will fail.&lt;/aside&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353
354Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]355 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]356 The object takes the form of:
357
358{ # Request to update the metadata of photos.
359 # Updating the pixels of photos is not supported.
360 "updatePhotoRequests": [ # Required. List of
361 # UpdatePhotoRequests.
362 { # Request to update the metadata of a
363 # Photo. Updating the pixels of a photo
364 # is not supported.
365 "photo": { # Photo is used to store 360 photos along with photo metadata. # Required. Photo object containing the
366 # new metadata.
367 "viewCount": "A String", # Output only. View count of the photo.
368 "photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
369 # Identifier for the photo, which is unique among all photos in
370 # Google.
371 "id": "A String", # Required. A unique identifier for a photo.
372 },
373 "uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
374 # photo bytes are uploaded to.
375 "uploadUrl": "A String", # Required. An upload reference should be unique for each user. It follows
376 # the form:
377 # "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
378 },
379 "places": [ # Places where this photo belongs.
380 { # Place metadata for an entity.
381 "languageCode": "A String", # Output-only. The language_code that the name is localized with. This should
382 # be the language_code specified in the request, but may be a fallback.
383 "name": "A String", # Output-only. The name of the place, localized to the language_code.
384 "placeId": "A String", # Place identifier, as described in
385 # https://developers.google.com/places/place-id.
386 },
387 ],
388 "connections": [ # Connections to other photos. A connection represents the link from this
389 # photo to another photo.
390 { # A connection is the link from a source photo to a destination photo.
391 "target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
392 # another photo.
393 "id": "A String", # Required. A unique identifier for a photo.
394 },
395 },
396 ],
397 "pose": { # Raw pose measurement for an entity. # Pose of the photo.
398 "latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
399 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
400 # When creating a Photo, if the
401 # latitude and longitude pair are not provided, the geolocation from the
402 # exif header is used. A latitude and longitude pair not provided in the
403 # photo or exif header causes the photo process to fail.
404 # of doubles representing degrees latitude and degrees longitude. Unless
405 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]406 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
407 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]408 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
409 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
410 },
411 "level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 "name": "A String", # Required. A name assigned to this Level, restricted to 3 characters.
413 # Consider how the elevator buttons would be labeled for this level if there
414 # was an elevator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]415 "number": 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
416 # the first level above ground level, -1 indicates the first level under
417 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]418 },
419 "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
420 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]421 "roll": 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
422 # means level with the horizon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]423 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]424 "pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
425 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]426 # means looking directly up.
427 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]428 "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
429 # from North. Value must be &gt;=0 and &lt;360.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]430 # NaN indicates an unmeasured quantity.
431 "accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
432 # confidence (one standard deviation). For example, on Android, this value is
433 # available from this method:
434 # https://developer.android.com/reference/android/location/Location#getAccuracy().
435 # Other platforms have different methods of obtaining similar accuracy
436 # estimations.
437 },
438 "downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
439 # when
440 # GetPhotoRequest.view
441 # is set to
442 # PhotoView.INCLUDE_DOWNLOAD_URL.
443 "transferStatus": "A String", # Output only. Status of rights transfer on this photo.
444 "mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]445 # rejected. Not currently populated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]446 "captureTime": "A String", # Absolute time when the photo was captured.
447 # When the photo has no exif timestamp, this is used to set a timestamp in
448 # the photo metadata.
449 "thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
450 "shareLink": "A String", # Output only. The share link for the photo.
451 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]452 "updateMask": "A String", # Required. Mask that identifies fields on the photo metadata to update.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]453 # 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 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]471 # &lt;aside class="note"&gt;&lt;b&gt;Note:&lt;/b&gt; When
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]472 # 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 -0700[diff] [blame^]477 # all connections are removed.&lt;/aside&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]478 },
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.
492 "results": [ # List of results for each individual
493 # 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.
501 "status": { # 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
502 # request.
503 # different programming environments, including REST APIs and RPC APIs. It is
504 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
505 # three pieces of data: error code, error message, and error details.
506 #
507 # You can find out more about this error model and how to work with it in the
508 # [API Design Guide](https://cloud.google.com/apis/design/errors).
509 "message": "A String", # A developer-facing error message, which should be in English. Any
510 # user-facing error message should be localized and sent in the
511 # google.rpc.Status.details field, or localized by the client.
512 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
513 "details": [ # A list of messages that carry the error details. There is a common set of
514 # message types for APIs to use.
515 {
516 "a_key": "", # Properties of the object. Contains field @type with type URL.
517 },
518 ],
519 },
520 "photo": { # Photo is used to store 360 photos along with photo metadata. # The Photo resource, if the request
521 # was successful.
522 "viewCount": "A String", # Output only. View count of the photo.
523 "photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
524 # Identifier for the photo, which is unique among all photos in
525 # Google.
526 "id": "A String", # Required. A unique identifier for a photo.
527 },
528 "uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
529 # photo bytes are uploaded to.
530 "uploadUrl": "A String", # Required. An upload reference should be unique for each user. It follows
531 # the form:
532 # "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
533 },
534 "places": [ # Places where this photo belongs.
535 { # Place metadata for an entity.
536 "languageCode": "A String", # Output-only. The language_code that the name is localized with. This should
537 # be the language_code specified in the request, but may be a fallback.
538 "name": "A String", # Output-only. The name of the place, localized to the language_code.
539 "placeId": "A String", # Place identifier, as described in
540 # https://developers.google.com/places/place-id.
541 },
542 ],
543 "connections": [ # Connections to other photos. A connection represents the link from this
544 # photo to another photo.
545 { # A connection is the link from a source photo to a destination photo.
546 "target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
547 # another photo.
548 "id": "A String", # Required. A unique identifier for a photo.
549 },
550 },
551 ],
552 "pose": { # Raw pose measurement for an entity. # Pose of the photo.
553 "latLngPair": { # 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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]561 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
562 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]563 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
564 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
565 },
566 "level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]567 "name": "A String", # Required. A name assigned to this Level, restricted to 3 characters.
568 # Consider how the elevator buttons would be labeled for this level if there
569 # was an elevator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]570 "number": 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
571 # the first level above ground level, -1 indicates the first level under
572 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 },
574 "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
575 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]576 "roll": 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
577 # means level with the horizon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]578 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]579 "pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
580 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]581 # means looking directly up.
582 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]583 "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
584 # from North. Value must be &gt;=0 and &lt;360.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]585 # NaN indicates an unmeasured quantity.
586 "accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
587 # confidence (one standard deviation). For example, on Android, this value is
588 # available from this method:
589 # https://developer.android.com/reference/android/location/Location#getAccuracy().
590 # Other platforms have different methods of obtaining similar accuracy
591 # estimations.
592 },
593 "downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
594 # when
595 # GetPhotoRequest.view
596 # is set to
597 # PhotoView.INCLUDE_DOWNLOAD_URL.
598 "transferStatus": "A String", # Output only. Status of rights transfer on this photo.
599 "mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]600 # rejected. Not currently populated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]601 "captureTime": "A String", # Absolute time when the photo was captured.
602 # When the photo has no exif timestamp, this is used to set a timestamp in
603 # the photo metadata.
604 "thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
605 "shareLink": "A String", # Output only. The share link for the photo.
606 },
607 },
608 ],
609 }</pre>
610</div>
611
612<div class="method">
613 <code class="details" id="list">list(languageCode=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None, view=None)</code>
614 <pre>Lists all the Photos that belong to
615the user.
616
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]617&lt;aside class="note"&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;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]619
620Args:
621 languageCode: string, The BCP-47 language code, such as "en-US" or "sr-Latn". For more
622information, see
623http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
624If language_code is unspecified, the user's language preference for Google
625services is used.
626 pageSize: integer, The maximum number of photos to return.
627`pageSize` must be non-negative. If `pageSize` is zero or is not provided,
628the default page size of 100 is used.
629The number of photos returned in the response may be less than `pageSize`
630if the number of photos that belong to the user is less than `pageSize`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]631 filter: string, Required. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]632
633The only filter supported at the moment is `placeId`.
634 pageToken: string, The
635nextPageToken
636value returned from a previous
637ListPhotos
638request, if any.
639 x__xgafv: string, V1 error format.
640 Allowed values
641 1 - v1 error format
642 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]643 view: string, Required. Specifies if a download URL for the photos bytes should be returned in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]644Photos response.
645
646Returns:
647 An object of the form:
648
649 { # Response to list all photos that belong to a user.
650 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
651 # results in the list.
652 "photos": [ # 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 "viewCount": "A String", # Output only. View count of the photo.
657 "photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
658 # Identifier for the photo, which is unique among all photos in
659 # Google.
660 "id": "A String", # Required. A unique identifier for a photo.
661 },
662 "uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
663 # photo bytes are uploaded to.
664 "uploadUrl": "A String", # Required. An upload reference should be unique for each user. It follows
665 # the form:
666 # "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
667 },
668 "places": [ # Places where this photo belongs.
669 { # Place metadata for an entity.
670 "languageCode": "A String", # Output-only. The language_code that the name is localized with. This should
671 # be the language_code specified in the request, but may be a fallback.
672 "name": "A String", # Output-only. The name of the place, localized to the language_code.
673 "placeId": "A String", # Place identifier, as described in
674 # https://developers.google.com/places/place-id.
675 },
676 ],
677 "connections": [ # Connections to other photos. A connection represents the link from this
678 # photo to another photo.
679 { # A connection is the link from a source photo to a destination photo.
680 "target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
681 # another photo.
682 "id": "A String", # Required. A unique identifier for a photo.
683 },
684 },
685 ],
686 "pose": { # Raw pose measurement for an entity. # Pose of the photo.
687 "latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
688 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
689 # When creating a Photo, if the
690 # latitude and longitude pair are not provided, the geolocation from the
691 # exif header is used. A latitude and longitude pair not provided in the
692 # photo or exif header causes the photo process to fail.
693 # of doubles representing degrees latitude and degrees longitude. Unless
694 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]695 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
696 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]697 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
698 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
699 },
700 "level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]701 "name": "A String", # Required. A name assigned to this Level, restricted to 3 characters.
702 # Consider how the elevator buttons would be labeled for this level if there
703 # was an elevator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]704 "number": 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
705 # the first level above ground level, -1 indicates the first level under
706 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]707 },
708 "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
709 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]710 "roll": 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
711 # means level with the horizon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]712 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]713 "pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
714 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]715 # means looking directly up.
716 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]717 "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
718 # from North. Value must be &gt;=0 and &lt;360.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]719 # NaN indicates an unmeasured quantity.
720 "accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
721 # confidence (one standard deviation). For example, on Android, this value is
722 # available from this method:
723 # https://developer.android.com/reference/android/location/Location#getAccuracy().
724 # Other platforms have different methods of obtaining similar accuracy
725 # estimations.
726 },
727 "downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
728 # when
729 # GetPhotoRequest.view
730 # is set to
731 # PhotoView.INCLUDE_DOWNLOAD_URL.
732 "transferStatus": "A String", # Output only. Status of rights transfer on this photo.
733 "mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]734 # rejected. Not currently populated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]735 "captureTime": "A String", # Absolute time when the photo was captured.
736 # When the photo has no exif timestamp, this is used to set a timestamp in
737 # the photo metadata.
738 "thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
739 "shareLink": "A String", # Output only. The share link for the photo.
740 },
741 ],
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:
754 A request object that you can call 'execute()' on to request the next
755 page. Returns None if there are no more items in the collection.
756 </pre>
757</div>
758
759</body></html>