Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / streetviewpublish_v1.photo.html
blob: 45e4d52e25588c727df3a6d7d5a112a909a26460 [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.photo.html">photo</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="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">After the client finishes uploading the photo with the returned</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(photoId, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a Photo and its metadata.</p>
83<p class="toc_element">
84 <code><a href="#get">get(photoId, languageCode=None, x__xgafv=None, view=None)</a></code></p>
85<p class="firstline">Gets the metadata of the specified</p>
86<p class="toc_element">
87 <code><a href="#startUpload">startUpload(body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Creates an upload session to start uploading photo bytes. The method uses</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#update">update(id, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Updates the metadata of a Photo, such</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="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95 <pre>After the client finishes uploading the photo with the returned
96UploadRef,
97CreatePhoto
98publishes the uploaded Photo to
99Street View on Google Maps.
100
101Currently, the only way to set heading, pitch, and roll in CreatePhoto is
102through the [Photo Sphere XMP
103metadata](https://developers.google.com/streetview/spherical-metadata) in
104the photo bytes. CreatePhoto ignores the `pose.heading`, `pose.pitch`,
105`pose.roll`, `pose.altitude`, and `pose.level` fields in Pose.
106
107This method returns the following error codes:
108
109* google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if
110the uploaded photo is not a 360 photo.
111* google.rpc.Code.NOT_FOUND if the upload reference does not exist.
112* google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the
113storage limit.
114
115Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]116 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 The object takes the form of:
118
119{ # Photo is used to store 360 photos along with photo metadata.
120 "viewCount": "A String", # Output only. View count of the photo.
121 "photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
122 # Identifier for the photo, which is unique among all photos in
123 # Google.
124 "id": "A String", # Required. A unique identifier for a photo.
125 },
126 "uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
127 # photo bytes are uploaded to.
128 "uploadUrl": "A String", # Required. An upload reference should be unique for each user. It follows
129 # the form:
130 # "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
131 },
132 "places": [ # Places where this photo belongs.
133 { # Place metadata for an entity.
134 "languageCode": "A String", # Output-only. The language_code that the name is localized with. This should
135 # be the language_code specified in the request, but may be a fallback.
136 "name": "A String", # Output-only. The name of the place, localized to the language_code.
137 "placeId": "A String", # Place identifier, as described in
138 # https://developers.google.com/places/place-id.
139 },
140 ],
141 "connections": [ # Connections to other photos. A connection represents the link from this
142 # photo to another photo.
143 { # A connection is the link from a source photo to a destination photo.
144 "target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
145 # another photo.
146 "id": "A String", # Required. A unique identifier for a photo.
147 },
148 },
149 ],
150 "pose": { # Raw pose measurement for an entity. # Pose of the photo.
151 "latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
152 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
153 # When creating a Photo, if the
154 # latitude and longitude pair are not provided, the geolocation from the
155 # exif header is used. A latitude and longitude pair not provided in the
156 # photo or exif header causes the photo process to fail.
157 # of doubles representing degrees latitude and degrees longitude. Unless
158 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]159 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
160 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
162 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
163 },
164 "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]165 "name": "A String", # Required. A name assigned to this Level, restricted to 3 characters.
166 # Consider how the elevator buttons would be labeled for this level if there
167 # was an elevator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]168 "number": 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
169 # the first level above ground level, -1 indicates the first level under
170 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 },
172 "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
173 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]174 "roll": 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
175 # means level with the horizon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 "pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
178 # 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]179 # means looking directly up.
180 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]181 "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
182 # from North. Value must be &gt;=0 and &lt;360.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 # NaN indicates an unmeasured quantity.
184 "accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
185 # confidence (one standard deviation). For example, on Android, this value is
186 # available from this method:
187 # https://developer.android.com/reference/android/location/Location#getAccuracy().
188 # Other platforms have different methods of obtaining similar accuracy
189 # estimations.
190 },
191 "downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
192 # when
193 # GetPhotoRequest.view
194 # is set to
195 # PhotoView.INCLUDE_DOWNLOAD_URL.
196 "transferStatus": "A String", # Output only. Status of rights transfer on this photo.
197 "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^]198 # rejected. Not currently populated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199 "captureTime": "A String", # Absolute time when the photo was captured.
200 # When the photo has no exif timestamp, this is used to set a timestamp in
201 # the photo metadata.
202 "thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
203 "shareLink": "A String", # Output only. The share link for the photo.
204 }
205
206 x__xgafv: string, V1 error format.
207 Allowed values
208 1 - v1 error format
209 2 - v2 error format
210
211Returns:
212 An object of the form:
213
214 { # Photo is used to store 360 photos along with photo metadata.
215 "viewCount": "A String", # Output only. View count of the photo.
216 "photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
217 # Identifier for the photo, which is unique among all photos in
218 # Google.
219 "id": "A String", # Required. A unique identifier for a photo.
220 },
221 "uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
222 # photo bytes are uploaded to.
223 "uploadUrl": "A String", # Required. An upload reference should be unique for each user. It follows
224 # the form:
225 # "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
226 },
227 "places": [ # Places where this photo belongs.
228 { # Place metadata for an entity.
229 "languageCode": "A String", # Output-only. The language_code that the name is localized with. This should
230 # be the language_code specified in the request, but may be a fallback.
231 "name": "A String", # Output-only. The name of the place, localized to the language_code.
232 "placeId": "A String", # Place identifier, as described in
233 # https://developers.google.com/places/place-id.
234 },
235 ],
236 "connections": [ # Connections to other photos. A connection represents the link from this
237 # photo to another photo.
238 { # A connection is the link from a source photo to a destination photo.
239 "target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
240 # another photo.
241 "id": "A String", # Required. A unique identifier for a photo.
242 },
243 },
244 ],
245 "pose": { # Raw pose measurement for an entity. # Pose of the photo.
246 "latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
247 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
248 # When creating a Photo, if the
249 # latitude and longitude pair are not provided, the geolocation from the
250 # exif header is used. A latitude and longitude pair not provided in the
251 # photo or exif header causes the photo process to fail.
252 # of doubles representing degrees latitude and degrees longitude. Unless
253 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]254 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
255 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
257 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
258 },
259 "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]260 "name": "A String", # Required. A name assigned to this Level, restricted to 3 characters.
261 # Consider how the elevator buttons would be labeled for this level if there
262 # was an elevator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]263 "number": 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
264 # the first level above ground level, -1 indicates the first level under
265 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]266 },
267 "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
268 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]269 "roll": 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
270 # means level with the horizon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]271 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]272 "pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
273 # 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]274 # means looking directly up.
275 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]276 "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
277 # from North. Value must be &gt;=0 and &lt;360.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]278 # NaN indicates an unmeasured quantity.
279 "accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
280 # confidence (one standard deviation). For example, on Android, this value is
281 # available from this method:
282 # https://developer.android.com/reference/android/location/Location#getAccuracy().
283 # Other platforms have different methods of obtaining similar accuracy
284 # estimations.
285 },
286 "downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
287 # when
288 # GetPhotoRequest.view
289 # is set to
290 # PhotoView.INCLUDE_DOWNLOAD_URL.
291 "transferStatus": "A String", # Output only. Status of rights transfer on this photo.
292 "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^]293 # rejected. Not currently populated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]294 "captureTime": "A String", # Absolute time when the photo was captured.
295 # When the photo has no exif timestamp, this is used to set a timestamp in
296 # the photo metadata.
297 "thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
298 "shareLink": "A String", # Output only. The share link for the photo.
299 }</pre>
300</div>
301
302<div class="method">
303 <code class="details" id="delete">delete(photoId, x__xgafv=None)</code>
304 <pre>Deletes a Photo and its metadata.
305
306This method returns the following error codes:
307
308* google.rpc.Code.PERMISSION_DENIED if the requesting user did not
309create the requested photo.
310* google.rpc.Code.NOT_FOUND if the photo ID does not exist.
311
312Args:
313 photoId: string, Required. ID of the Photo. (required)
314 x__xgafv: string, V1 error format.
315 Allowed values
316 1 - v1 error format
317 2 - v2 error format
318
319Returns:
320 An object of the form:
321
322 { # A generic empty message that you can re-use to avoid defining duplicated
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]323 # empty messages in your APIs. A typical example is to use it as the request
324 # or the response type of an API method. For instance:
325 #
326 # service Foo {
327 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
328 # }
329 #
330 # The JSON representation for `Empty` is empty JSON object `{}`.
331 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]332</div>
333
334<div class="method">
335 <code class="details" id="get">get(photoId, languageCode=None, x__xgafv=None, view=None)</code>
336 <pre>Gets the metadata of the specified
337Photo.
338
339This method returns the following error codes:
340
341* google.rpc.Code.PERMISSION_DENIED if the requesting user did not
342create the requested Photo.
343* google.rpc.Code.NOT_FOUND if the requested
344Photo does not exist.
345* google.rpc.Code.UNAVAILABLE if the requested
346Photo is still being indexed.
347
348Args:
349 photoId: string, Required. ID of the Photo. (required)
350 languageCode: string, The BCP-47 language code, such as "en-US" or "sr-Latn". For more
351information, see
352http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
353If language_code is unspecified, the user's language preference for Google
354services is used.
355 x__xgafv: string, V1 error format.
356 Allowed values
357 1 - v1 error format
358 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]359 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]360Photo response.
361
362Returns:
363 An object of the form:
364
365 { # Photo is used to store 360 photos along with photo metadata.
366 "viewCount": "A String", # Output only. View count of the photo.
367 "photoId": { # 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 "id": "A String", # Required. A unique identifier for a photo.
371 },
372 "uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
373 # photo bytes are uploaded to.
374 "uploadUrl": "A String", # Required. An upload reference should be unique for each user. It follows
375 # the form:
376 # "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
377 },
378 "places": [ # Places where this photo belongs.
379 { # Place metadata for an entity.
380 "languageCode": "A String", # Output-only. The language_code that the name is localized with. This should
381 # be the language_code specified in the request, but may be a fallback.
382 "name": "A String", # Output-only. The name of the place, localized to the language_code.
383 "placeId": "A String", # Place identifier, as described in
384 # https://developers.google.com/places/place-id.
385 },
386 ],
387 "connections": [ # Connections to other photos. A connection represents the link from this
388 # photo to another photo.
389 { # A connection is the link from a source photo to a destination photo.
390 "target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
391 # another photo.
392 "id": "A String", # Required. A unique identifier for a photo.
393 },
394 },
395 ],
396 "pose": { # Raw pose measurement for an entity. # Pose of the photo.
397 "latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
398 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
399 # When creating a Photo, if the
400 # latitude and longitude pair are not provided, the geolocation from the
401 # exif header is used. A latitude and longitude pair not provided in the
402 # photo or exif header causes the photo process to fail.
403 # of doubles representing degrees latitude and degrees longitude. Unless
404 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]405 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
406 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]407 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
408 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
409 },
410 "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]411 "name": "A String", # Required. A name assigned to this Level, restricted to 3 characters.
412 # Consider how the elevator buttons would be labeled for this level if there
413 # was an elevator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]414 "number": 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
415 # the first level above ground level, -1 indicates the first level under
416 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]417 },
418 "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
419 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]420 "roll": 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
421 # means level with the horizon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]422 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]423 "pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
424 # 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]425 # means looking directly up.
426 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]427 "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
428 # from North. Value must be &gt;=0 and &lt;360.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]429 # NaN indicates an unmeasured quantity.
430 "accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
431 # confidence (one standard deviation). For example, on Android, this value is
432 # available from this method:
433 # https://developer.android.com/reference/android/location/Location#getAccuracy().
434 # Other platforms have different methods of obtaining similar accuracy
435 # estimations.
436 },
437 "downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
438 # when
439 # GetPhotoRequest.view
440 # is set to
441 # PhotoView.INCLUDE_DOWNLOAD_URL.
442 "transferStatus": "A String", # Output only. Status of rights transfer on this photo.
443 "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^]444 # rejected. Not currently populated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]445 "captureTime": "A String", # Absolute time when the photo was captured.
446 # When the photo has no exif timestamp, this is used to set a timestamp in
447 # the photo metadata.
448 "thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
449 "shareLink": "A String", # Output only. The share link for the photo.
450 }</pre>
451</div>
452
453<div class="method">
454 <code class="details" id="startUpload">startUpload(body=None, x__xgafv=None)</code>
455 <pre>Creates an upload session to start uploading photo bytes. The method uses
456the upload URL of the returned
457UploadRef to upload the bytes for
458the Photo.
459
460In addition to the photo requirements shown in
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]461https://support.google.com/maps/answer/7012050?hl=en&amp;ref_topic=6275604,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]462the photo must meet the following requirements:
463
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]464* Photo Sphere XMP metadata must be included in the photo metadata. See
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]465https://developers.google.com/streetview/spherical-metadata for the
466required fields.
467* The pixel size of the photo must meet the size requirements listed in
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]468https://support.google.com/maps/answer/7012050?hl=en&amp;ref_topic=6275604, and
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]469the photo must be a full 360 horizontally.
470
471After the upload completes, the method uses
472UploadRef with
473CreatePhoto
474to create the Photo object entry.
475
476Args:
477 body: object, The request body.
478 The object takes the form of:
479
480{ # A generic empty message that you can re-use to avoid defining duplicated
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]481 # empty messages in your APIs. A typical example is to use it as the request
482 # or the response type of an API method. For instance:
483 #
484 # service Foo {
485 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
486 # }
487 #
488 # The JSON representation for `Empty` is empty JSON object `{}`.
489}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490
491 x__xgafv: string, V1 error format.
492 Allowed values
493 1 - v1 error format
494 2 - v2 error format
495
496Returns:
497 An object of the form:
498
499 { # Upload reference for media files.
500 "uploadUrl": "A String", # Required. An upload reference should be unique for each user. It follows
501 # the form:
502 # "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
503 }</pre>
504</div>
505
506<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]507 <code class="details" id="update">update(id, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]508 <pre>Updates the metadata of a Photo, such
509as pose, place association, connections, etc. Changing the pixels of a
510photo is not supported.
511
512Only the fields specified in the
513updateMask
514field are used. If `updateMask` is not present, the update applies to all
515fields.
516
517This method returns the following error codes:
518
519* google.rpc.Code.PERMISSION_DENIED if the requesting user did not
520create the requested photo.
521* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.
522* google.rpc.Code.NOT_FOUND if the requested photo does not exist.
523* google.rpc.Code.UNAVAILABLE if the requested
524Photo is still being indexed.
525
526Args:
527 id: string, Required. A unique identifier for a photo. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]528 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]529 The object takes the form of:
530
531{ # Photo is used to store 360 photos along with photo metadata.
532 "viewCount": "A String", # Output only. View count of the photo.
533 "photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
534 # Identifier for the photo, which is unique among all photos in
535 # Google.
536 "id": "A String", # Required. A unique identifier for a photo.
537 },
538 "uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
539 # photo bytes are uploaded to.
540 "uploadUrl": "A String", # Required. An upload reference should be unique for each user. It follows
541 # the form:
542 # "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
543 },
544 "places": [ # Places where this photo belongs.
545 { # Place metadata for an entity.
546 "languageCode": "A String", # Output-only. The language_code that the name is localized with. This should
547 # be the language_code specified in the request, but may be a fallback.
548 "name": "A String", # Output-only. The name of the place, localized to the language_code.
549 "placeId": "A String", # Place identifier, as described in
550 # https://developers.google.com/places/place-id.
551 },
552 ],
553 "connections": [ # Connections to other photos. A connection represents the link from this
554 # photo to another photo.
555 { # A connection is the link from a source photo to a destination photo.
556 "target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
557 # another photo.
558 "id": "A String", # Required. A unique identifier for a photo.
559 },
560 },
561 ],
562 "pose": { # Raw pose measurement for an entity. # Pose of the photo.
563 "latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
564 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
565 # When creating a Photo, if the
566 # latitude and longitude pair are not provided, the geolocation from the
567 # exif header is used. A latitude and longitude pair not provided in the
568 # photo or exif header causes the photo process to fail.
569 # of doubles representing degrees latitude and degrees longitude. Unless
570 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]571 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
572 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
574 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
575 },
576 "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]577 "name": "A String", # Required. A name assigned to this Level, restricted to 3 characters.
578 # Consider how the elevator buttons would be labeled for this level if there
579 # was an elevator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]580 "number": 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
581 # the first level above ground level, -1 indicates the first level under
582 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]583 },
584 "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
585 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]586 "roll": 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
587 # means level with the horizon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]588 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]589 "pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
590 # 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]591 # means looking directly up.
592 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]593 "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
594 # from North. Value must be &gt;=0 and &lt;360.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]595 # NaN indicates an unmeasured quantity.
596 "accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
597 # confidence (one standard deviation). For example, on Android, this value is
598 # available from this method:
599 # https://developer.android.com/reference/android/location/Location#getAccuracy().
600 # Other platforms have different methods of obtaining similar accuracy
601 # estimations.
602 },
603 "downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
604 # when
605 # GetPhotoRequest.view
606 # is set to
607 # PhotoView.INCLUDE_DOWNLOAD_URL.
608 "transferStatus": "A String", # Output only. Status of rights transfer on this photo.
609 "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^]610 # rejected. Not currently populated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]611 "captureTime": "A String", # Absolute time when the photo was captured.
612 # When the photo has no exif timestamp, this is used to set a timestamp in
613 # the photo metadata.
614 "thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
615 "shareLink": "A String", # Output only. The share link for the photo.
616 }
617
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]618 updateMask: string, Required. Mask that identifies fields on the photo metadata to update.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]619If not present, the old Photo
620metadata is entirely replaced with the
621new Photo metadata in this request.
622The update fails if invalid fields are specified. Multiple fields can be
623specified in a comma-delimited list.
624
625The following fields are valid:
626
627* `pose.heading`
628* `pose.latLngPair`
629* `pose.pitch`
630* `pose.roll`
631* `pose.level`
632* `pose.altitude`
633* `connections`
634* `places`
635
636
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]637&lt;aside class="note"&gt;&lt;b&gt;Note:&lt;/b&gt; When
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]638updateMask
639contains repeated fields, the entire set of repeated values get replaced
640with the new contents. For example, if
641updateMask
642contains `connections` and `UpdatePhotoRequest.photo.connections` is empty,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]643all connections are removed.&lt;/aside&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]644 x__xgafv: string, V1 error format.
645 Allowed values
646 1 - v1 error format
647 2 - v2 error format
648
649Returns:
650 An object of the form:
651
652 { # Photo is used to store 360 photos along with photo metadata.
653 "viewCount": "A String", # Output only. View count of the photo.
654 "photoId": { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
655 # Identifier for the photo, which is unique among all photos in
656 # Google.
657 "id": "A String", # Required. A unique identifier for a photo.
658 },
659 "uploadReference": { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
660 # photo bytes are uploaded to.
661 "uploadUrl": "A String", # Required. An upload reference should be unique for each user. It follows
662 # the form:
663 # "https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}"
664 },
665 "places": [ # Places where this photo belongs.
666 { # Place metadata for an entity.
667 "languageCode": "A String", # Output-only. The language_code that the name is localized with. This should
668 # be the language_code specified in the request, but may be a fallback.
669 "name": "A String", # Output-only. The name of the place, localized to the language_code.
670 "placeId": "A String", # Place identifier, as described in
671 # https://developers.google.com/places/place-id.
672 },
673 ],
674 "connections": [ # Connections to other photos. A connection represents the link from this
675 # photo to another photo.
676 { # A connection is the link from a source photo to a destination photo.
677 "target": { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
678 # another photo.
679 "id": "A String", # Required. A unique identifier for a photo.
680 },
681 },
682 ],
683 "pose": { # Raw pose measurement for an entity. # Pose of the photo.
684 "latLngPair": { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
685 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
686 # When creating a Photo, if the
687 # latitude and longitude pair are not provided, the geolocation from the
688 # exif header is used. A latitude and longitude pair not provided in the
689 # photo or exif header causes the photo process to fail.
690 # of doubles representing degrees latitude and degrees longitude. Unless
691 # specified otherwise, this must conform to the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]692 # &lt;a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf"&gt;WGS84
693 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]694 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
695 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
696 },
697 "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]698 "name": "A String", # Required. A name assigned to this Level, restricted to 3 characters.
699 # Consider how the elevator buttons would be labeled for this level if there
700 # was an elevator.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]701 "number": 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
702 # the first level above ground level, -1 indicates the first level under
703 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]704 },
705 "altitude": 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
706 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]707 "roll": 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
708 # means level with the horizon.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]709 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]710 "pitch": 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
711 # 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]712 # means looking directly up.
713 # NaN indicates an unmeasured quantity.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]714 "heading": 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
715 # from North. Value must be &gt;=0 and &lt;360.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]716 # NaN indicates an unmeasured quantity.
717 "accuracyMeters": 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
718 # confidence (one standard deviation). For example, on Android, this value is
719 # available from this method:
720 # https://developer.android.com/reference/android/location/Location#getAccuracy().
721 # Other platforms have different methods of obtaining similar accuracy
722 # estimations.
723 },
724 "downloadUrl": "A String", # Output only. The download URL for the photo bytes. This field is set only
725 # when
726 # GetPhotoRequest.view
727 # is set to
728 # PhotoView.INCLUDE_DOWNLOAD_URL.
729 "transferStatus": "A String", # Output only. Status of rights transfer on this photo.
730 "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^]731 # rejected. Not currently populated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]732 "captureTime": "A String", # Absolute time when the photo was captured.
733 # When the photo has no exif timestamp, this is used to set a timestamp in
734 # the photo metadata.
735 "thumbnailUrl": "A String", # Output only. The thumbnail URL for showing a preview of the given photo.
736 "shareLink": "A String", # Output only. The share link for the photo.
737 }</pre>
738</div>
739
740</body></html>