/
streetviewpublish_v1.photos.html
441 lines (402 loc) 路 38.9 KB
/
streetviewpublish_v1.photos.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="streetviewpublish_v1.html">Street View Publish API</a> . <a href="streetviewpublish_v1.photos.html">photos</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchDelete">batchDelete(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a list of Photos and their metadata. Note that if BatchDeletePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchDeletePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchDeletePhotosResponse.results. See DeletePhoto for specific failures that can occur per photo.</p>
<p class="toc_element">
<code><a href="#batchGet">batchGet(languageCode=None, photoIds=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there is an authentication error. Even if BatchGetPhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.</p>
<p class="toc_element">
<code><a href="#batchUpdate">batchUpdate(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the metadata of Photos, such as pose, place association, connections, etc. Changing the pixels of photos is not supported. Note that if BatchUpdatePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchUpdatePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchUpdatePhotosResponse.results. See UpdatePhoto for specific failures that can occur per photo. Only the fields specified in updateMask field are used. If `updateMask` is not present, the update applies to all fields. The number of UpdatePhotoRequest messages in a BatchUpdatePhotosRequest must not exceed 20. > Note: To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(filter=None, languageCode=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the Photos that belong to the user. > Note: Recently created photos that are still being indexed are not returned in the response.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchDelete">batchDelete(body=None, x__xgafv=None)</code>
<pre>Deletes a list of Photos and their metadata. Note that if BatchDeletePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchDeletePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchDeletePhotosResponse.results. See DeletePhoto for specific failures that can occur per photo.
Args:
body: object, The request body.
The object takes the form of:
{ # Request to delete multiple Photos.
"photoIds": [ # Required. IDs of the Photos. HTTP GET requests require the following syntax for the URL query parameter: `photoIds=&photoIds=&...`.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to batch delete of one or more Photos.
"status": [ # The status for the operation to delete a single Photo in the batch request.
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="batchGet">batchGet(languageCode=None, photoIds=None, view=None, x__xgafv=None)</code>
<pre>Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there is an authentication error. Even if BatchGetPhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.
Args:
languageCode: string, Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used.
photoIds: string, Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be `photoIds=&photoIds=&...`. (repeated)
view: string, Required. Specifies if a download URL for the photo bytes should be returned in the Photo response.
Allowed values
BASIC - Server responses do not include the download URL for the photo bytes. The default value.
INCLUDE_DOWNLOAD_URL - Server responses include the download URL for the photo bytes.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to batch get of Photos.
"results": [ # List of results for each individual Photo requested, in the same order as the requests in BatchGetPhotos.
{ # Response payload for a single Photo in batch operations including BatchGetPhotos and BatchUpdatePhotos.
"photo": { # Photo is used to store 360 photos along with photo metadata. # The Photo resource, if the request was successful.
"captureTime": "A String", # Optional. Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
"connections": [ # Optional. Connections to other photos. A connection represents the link from this photo to another photo.
{ # A connection is the link from a source photo to a destination photo.
"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
"id": "A String", # A unique identifier for a photo.
},
},
],
"downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or rejected.
"photoId": { # Identifier for a Photo. # Required. Output only. Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
"id": "A String", # A unique identifier for a photo.
},
"places": [ # Optional. Places where this photo belongs.
{ # Place metadata for an entity.
"languageCode": "A String", # Output only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
"name": "A String", # Output only. The name of the place, localized to the language_code.
"placeId": "A String", # Place identifier, as described in https://developers.google.com/places/place-id.
},
],
"pose": { # Raw pose measurement for an entity. # Optional. Pose of the photo.
"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
"gpsRecordTimestampUnixEpoch": "A String", # Time of the GPS record since UTC epoch.
"heading": 3.14, # The following pose parameters pertain to the center of the photo. They match https://developers.google.com/streetview/spherical-metadata. Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity.
"latLngPair": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
"name": "A String", # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
"number": 3.14, # Optional. Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
},
"pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be >=-90 and <= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
"roll": 3.14, # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
},
"shareLink": "A String", # Output only. The share link for the photo.
"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
"transferStatus": "A String", # Output only. Status of rights transfer on this photo.
"uploadReference": { # Upload reference for media files. # Input only. Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
"uploadUrl": "A String", # An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
},
"uploadTime": "A String", # Output only. Time when the image was uploaded.
"viewCount": "A String", # Output only. View count of the photo.
},
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status for the operation to get or update a single photo in the batch request.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="batchUpdate">batchUpdate(body=None, x__xgafv=None)</code>
<pre>Updates the metadata of Photos, such as pose, place association, connections, etc. Changing the pixels of photos is not supported. Note that if BatchUpdatePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchUpdatePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchUpdatePhotosResponse.results. See UpdatePhoto for specific failures that can occur per photo. Only the fields specified in updateMask field are used. If `updateMask` is not present, the update applies to all fields. The number of UpdatePhotoRequest messages in a BatchUpdatePhotosRequest must not exceed 20. > Note: To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail.
Args:
body: object, The request body.
The object takes the form of:
{ # Request to update the metadata of photos. Updating the pixels of photos is not supported.
"updatePhotoRequests": [ # Required. List of UpdatePhotoRequests.
{ # Request to update the metadata of a Photo. Updating the pixels of a photo is not supported.
"photo": { # Photo is used to store 360 photos along with photo metadata. # Required. Photo object containing the new metadata.
"captureTime": "A String", # Optional. Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
"connections": [ # Optional. Connections to other photos. A connection represents the link from this photo to another photo.
{ # A connection is the link from a source photo to a destination photo.
"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
"id": "A String", # A unique identifier for a photo.
},
},
],
"downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or rejected.
"photoId": { # Identifier for a Photo. # Required. Output only. Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
"id": "A String", # A unique identifier for a photo.
},
"places": [ # Optional. Places where this photo belongs.
{ # Place metadata for an entity.
"languageCode": "A String", # Output only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
"name": "A String", # Output only. The name of the place, localized to the language_code.
"placeId": "A String", # Place identifier, as described in https://developers.google.com/places/place-id.
},
],
"pose": { # Raw pose measurement for an entity. # Optional. Pose of the photo.
"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
"gpsRecordTimestampUnixEpoch": "A String", # Time of the GPS record since UTC epoch.
"heading": 3.14, # The following pose parameters pertain to the center of the photo. They match https://developers.google.com/streetview/spherical-metadata. Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity.
"latLngPair": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
"name": "A String", # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
"number": 3.14, # Optional. Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
},
"pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be >=-90 and <= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
"roll": 3.14, # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
},
"shareLink": "A String", # Output only. The share link for the photo.
"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
"transferStatus": "A String", # Output only. Status of rights transfer on this photo.
"uploadReference": { # Upload reference for media files. # Input only. Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
"uploadUrl": "A String", # An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
},
"uploadTime": "A String", # Output only. Time when the image was uploaded.
"viewCount": "A String", # Output only. View count of the photo.
},
"updateMask": "A String", # Required. Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.lat_lng_pair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` > Note: When updateMask contains repeated fields, the entire set of repeated values get replaced with the new contents. For example, if updateMask contains `connections` and `UpdatePhotoRequest.photo.connections` is empty, all connections are removed.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to batch update of metadata of one or more Photos.
"results": [ # List of results for each individual Photo updated, in the same order as the request.
{ # Response payload for a single Photo in batch operations including BatchGetPhotos and BatchUpdatePhotos.
"photo": { # Photo is used to store 360 photos along with photo metadata. # The Photo resource, if the request was successful.
"captureTime": "A String", # Optional. Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
"connections": [ # Optional. Connections to other photos. A connection represents the link from this photo to another photo.
{ # A connection is the link from a source photo to a destination photo.
"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
"id": "A String", # A unique identifier for a photo.
},
},
],
"downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or rejected.
"photoId": { # Identifier for a Photo. # Required. Output only. Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
"id": "A String", # A unique identifier for a photo.
},
"places": [ # Optional. Places where this photo belongs.
{ # Place metadata for an entity.
"languageCode": "A String", # Output only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
"name": "A String", # Output only. The name of the place, localized to the language_code.
"placeId": "A String", # Place identifier, as described in https://developers.google.com/places/place-id.
},
],
"pose": { # Raw pose measurement for an entity. # Optional. Pose of the photo.
"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
"gpsRecordTimestampUnixEpoch": "A String", # Time of the GPS record since UTC epoch.
"heading": 3.14, # The following pose parameters pertain to the center of the photo. They match https://developers.google.com/streetview/spherical-metadata. Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity.
"latLngPair": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
"name": "A String", # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
"number": 3.14, # Optional. Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
},
"pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be >=-90 and <= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
"roll": 3.14, # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
},
"shareLink": "A String", # Output only. The share link for the photo.
"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
"transferStatus": "A String", # Output only. Status of rights transfer on this photo.
"uploadReference": { # Upload reference for media files. # Input only. Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
"uploadUrl": "A String", # An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
},
"uploadTime": "A String", # Output only. Time when the image was uploaded.
"viewCount": "A String", # Output only. View count of the photo.
},
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The status for the operation to get or update a single photo in the batch request.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(filter=None, languageCode=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>Lists all the Photos that belong to the user. > Note: Recently created photos that are still being indexed are not returned in the response.
Args:
filter: string, Optional. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The filters supported are: `placeId`, `min_latitude`, `max_latitude`, `min_longitude`, `max_longitude`, 'min_capture_time_seconds', and 'max_capture_time_seconds'. See https://google.aip.dev/160 for more information.
languageCode: string, Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used.
pageSize: integer, Optional. The maximum number of photos to return. `pageSize` must be non-negative. If `pageSize` is zero or is not provided, the default page size of 100 is used. The number of photos returned in the response may be less than `pageSize` if the number of photos that belong to the user is less than `pageSize`.
pageToken: string, Optional. The nextPageToken value returned from a previous ListPhotos request, if any.
view: string, Required. Specifies if a download URL for the photos bytes should be returned in the Photos response.
Allowed values
BASIC - Server responses do not include the download URL for the photo bytes. The default value.
INCLUDE_DOWNLOAD_URL - Server responses include the download URL for the photo bytes.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to list all photos that belong to a user.
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"photos": [ # List of photos. The pageSize field in the request determines the number of items returned.
{ # Photo is used to store 360 photos along with photo metadata.
"captureTime": "A String", # Optional. Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
"connections": [ # Optional. Connections to other photos. A connection represents the link from this photo to another photo.
{ # A connection is the link from a source photo to a destination photo.
"target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
"id": "A String", # A unique identifier for a photo.
},
},
],
"downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
"mapsPublishStatus": "A String", # Output only. Status in Google Maps, whether this photo was published or rejected.
"photoId": { # Identifier for a Photo. # Required. Output only. Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
"id": "A String", # A unique identifier for a photo.
},
"places": [ # Optional. Places where this photo belongs.
{ # Place metadata for an entity.
"languageCode": "A String", # Output only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
"name": "A String", # Output only. The name of the place, localized to the language_code.
"placeId": "A String", # Place identifier, as described in https://developers.google.com/places/place-id.
},
],
"pose": { # Raw pose measurement for an entity. # Optional. Pose of the photo.
"accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
"altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
"gpsRecordTimestampUnixEpoch": "A String", # Time of the GPS record since UTC epoch.
"heading": 3.14, # The following pose parameters pertain to the center of the photo. They match https://developers.google.com/streetview/spherical-metadata. Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity.
"latLngPair": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
},
"level": { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
"name": "A String", # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
"number": 3.14, # Optional. Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
},
"pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be >=-90 and <= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
"roll": 3.14, # Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
},
"shareLink": "A String", # Output only. The share link for the photo.
"thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
"transferStatus": "A String", # Output only. Status of rights transfer on this photo.
"uploadReference": { # Upload reference for media files. # Input only. Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
"uploadUrl": "A String", # An upload reference should be unique for each user. It follows the form: "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
},
"uploadTime": "A String", # Output only. Time when the image was uploaded.
"viewCount": "A String", # Output only. View count of the photo.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>