blob: bf7beddb9565f462ab76aa177b556aa632bbc43c [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="streetviewpublish_v1.html">Street View Publish API</a> . <a href="streetviewpublish_v1.photo.html">photo</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<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">
Bu Sun Kim65020912020-05-20 12:08:20 -070084 <code><a href="#get">get(photoId, view=None, languageCode=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<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 -070090 <code><a href="#update">update(id, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<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 -070094 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070095 <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 -0700116 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700117 The object takes the form of:
118
119{ # Photo is used to store 360 photos along with photo metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700120 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
121 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
122 # photo to another photo.
123 { # A connection is the link from a source photo to a destination photo.
124 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
125 # another photo.
126 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
127 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700128 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700129 ],
130 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
131 # when
132 # GetPhotoRequest.view
133 # is set to
134 # PhotoView.INCLUDE_DOWNLOAD_URL.
135 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
136 # rejected. Not currently populated.
137 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
138 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
139 # photo bytes are uploaded to.
140 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
141 # the form:
142 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
143 },
144 &quot;places&quot;: [ # Places where this photo belongs.
145 { # Place metadata for an entity.
146 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
147 # https://developers.google.com/places/place-id.
148 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
149 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
150 # be the language_code specified in the request, but may be a fallback.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700151 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700152 ],
153 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
154 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
155 # means level with the horizon.
156 # NaN indicates an unmeasured quantity.
157 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
158 # NaN indicates an unmeasured quantity.
159 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
160 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
161 # means looking directly up.
162 # NaN indicates an unmeasured quantity.
163 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
164 # confidence (one standard deviation). For example, on Android, this value is
165 # available from this method:
166 # https://developer.android.com/reference/android/location/Location#getAccuracy().
167 # Other platforms have different methods of obtaining similar accuracy
168 # estimations.
169 &quot;latLngPair&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
170 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
171 # When creating a Photo, if the
172 # latitude and longitude pair are not provided, the geolocation from the
173 # exif header is used. A latitude and longitude pair not provided in the
174 # photo or exif header causes the photo process to fail.
175 # of doubles representing degrees latitude and degrees longitude. Unless
176 # specified otherwise, this must conform to the
177 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
178 # standard&lt;/a&gt;. Values must be within normalized ranges.
179 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
180 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700181 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700182 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
183 # from North. Value must be &gt;=0 and &lt;360.
184 # NaN indicates an unmeasured quantity.
185 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
186 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
187 # the first level above ground level, -1 indicates the first level under
188 # ground level. Non-integer values are OK.
189 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
190 # Consider how the elevator buttons would be labeled for this level if there
191 # was an elevator.
192 },
193 },
194 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
195 # When the photo has no exif timestamp, this is used to set a timestamp in
196 # the photo metadata.
197 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
198 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
199 # Identifier for the photo, which is unique among all photos in
200 # Google.
201 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
202 },
203 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
204}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700205
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700215 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
216 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
217 # photo to another photo.
218 { # A connection is the link from a source photo to a destination photo.
219 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
220 # another photo.
221 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
222 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700223 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700224 ],
225 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
226 # when
227 # GetPhotoRequest.view
228 # is set to
229 # PhotoView.INCLUDE_DOWNLOAD_URL.
230 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
231 # rejected. Not currently populated.
232 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
233 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
234 # photo bytes are uploaded to.
235 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
236 # the form:
237 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
238 },
239 &quot;places&quot;: [ # Places where this photo belongs.
240 { # Place metadata for an entity.
241 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
242 # https://developers.google.com/places/place-id.
243 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
244 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
245 # be the language_code specified in the request, but may be a fallback.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700246 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700247 ],
248 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
249 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
250 # means level with the horizon.
251 # NaN indicates an unmeasured quantity.
252 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
253 # NaN indicates an unmeasured quantity.
254 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
255 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
256 # means looking directly up.
257 # NaN indicates an unmeasured quantity.
258 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
259 # confidence (one standard deviation). For example, on Android, this value is
260 # available from this method:
261 # https://developer.android.com/reference/android/location/Location#getAccuracy().
262 # Other platforms have different methods of obtaining similar accuracy
263 # estimations.
264 &quot;latLngPair&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
265 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
266 # When creating a Photo, if the
267 # latitude and longitude pair are not provided, the geolocation from the
268 # exif header is used. A latitude and longitude pair not provided in the
269 # photo or exif header causes the photo process to fail.
270 # of doubles representing degrees latitude and degrees longitude. Unless
271 # specified otherwise, this must conform to the
272 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
273 # standard&lt;/a&gt;. Values must be within normalized ranges.
274 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
275 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700276 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700277 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
278 # from North. Value must be &gt;=0 and &lt;360.
279 # NaN indicates an unmeasured quantity.
280 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
281 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
282 # the first level above ground level, -1 indicates the first level under
283 # ground level. Non-integer values are OK.
284 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
285 # Consider how the elevator buttons would be labeled for this level if there
286 # was an elevator.
287 },
288 },
289 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
290 # When the photo has no exif timestamp, this is used to set a timestamp in
291 # the photo metadata.
292 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
293 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
294 # Identifier for the photo, which is unique among all photos in
295 # Google.
296 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
297 },
298 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
299 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700300</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
Bu Sun Kim65020912020-05-20 12:08:20 -0700323 # 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 -0700332</div>
333
334<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700335 <code class="details" id="get">get(photoId, view=None, languageCode=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700336 <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)
Bu Sun Kim65020912020-05-20 12:08:20 -0700350 view: string, Required. Specifies if a download URL for the photo bytes should be returned in the
351Photo response.
352 languageCode: string, The BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700353information, see
354http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
Bu Sun Kim65020912020-05-20 12:08:20 -0700355If language_code is unspecified, the user&#x27;s language preference for Google
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700356services is used.
357 x__xgafv: string, V1 error format.
358 Allowed values
359 1 - v1 error format
360 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700361
362Returns:
363 An object of the form:
364
365 { # Photo is used to store 360 photos along with photo metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700366 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
367 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
368 # photo to another photo.
369 { # A connection is the link from a source photo to a destination photo.
370 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
371 # another photo.
372 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
373 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700374 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700375 ],
376 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
377 # when
378 # GetPhotoRequest.view
379 # is set to
380 # PhotoView.INCLUDE_DOWNLOAD_URL.
381 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
382 # rejected. Not currently populated.
383 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
384 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
385 # photo bytes are uploaded to.
386 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
387 # the form:
388 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
389 },
390 &quot;places&quot;: [ # Places where this photo belongs.
391 { # Place metadata for an entity.
392 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
393 # https://developers.google.com/places/place-id.
394 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
395 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
396 # be the language_code specified in the request, but may be a fallback.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700397 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700398 ],
399 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
400 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
401 # means level with the horizon.
402 # NaN indicates an unmeasured quantity.
403 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
404 # NaN indicates an unmeasured quantity.
405 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
406 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
407 # means looking directly up.
408 # NaN indicates an unmeasured quantity.
409 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
410 # confidence (one standard deviation). For example, on Android, this value is
411 # available from this method:
412 # https://developer.android.com/reference/android/location/Location#getAccuracy().
413 # Other platforms have different methods of obtaining similar accuracy
414 # estimations.
415 &quot;latLngPair&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
416 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
417 # When creating a Photo, if the
418 # latitude and longitude pair are not provided, the geolocation from the
419 # exif header is used. A latitude and longitude pair not provided in the
420 # photo or exif header causes the photo process to fail.
421 # of doubles representing degrees latitude and degrees longitude. Unless
422 # specified otherwise, this must conform to the
423 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
424 # standard&lt;/a&gt;. Values must be within normalized ranges.
425 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
426 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700427 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700428 &quot;heading&quot;: 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.
430 # NaN indicates an unmeasured quantity.
431 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
432 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
433 # the first level above ground level, -1 indicates the first level under
434 # ground level. Non-integer values are OK.
435 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
436 # Consider how the elevator buttons would be labeled for this level if there
437 # was an elevator.
438 },
439 },
440 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
441 # When the photo has no exif timestamp, this is used to set a timestamp in
442 # the photo metadata.
443 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
444 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
445 # Identifier for the photo, which is unique among all photos in
446 # Google.
447 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
448 },
449 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
450 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700451</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 -0700461https://support.google.com/maps/answer/7012050?hl=en&amp;ref_topic=6275604,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700462the photo must meet the following requirements:
463
Dan O'Mearadd494642020-05-01 07:42:23 -0700464* Photo Sphere XMP metadata must be included in the photo metadata. See
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700465https://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 -0700468https://support.google.com/maps/answer/7012050?hl=en&amp;ref_topic=6275604, and
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700469the 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
Bu Sun Kim65020912020-05-20 12:08:20 -0700481 # 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 -0700490
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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700500 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700501 # the form:
Bu Sun Kim65020912020-05-20 12:08:20 -0700502 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700503 }</pre>
504</div>
505
506<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700507 <code class="details" id="update">update(id, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700508 <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 -0700528 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700529 The object takes the form of:
530
531{ # Photo is used to store 360 photos along with photo metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700532 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
533 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
534 # photo to another photo.
535 { # A connection is the link from a source photo to a destination photo.
536 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
537 # another photo.
538 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
539 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700540 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700541 ],
542 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
543 # when
544 # GetPhotoRequest.view
545 # is set to
546 # PhotoView.INCLUDE_DOWNLOAD_URL.
547 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
548 # rejected. Not currently populated.
549 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
550 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
551 # photo bytes are uploaded to.
552 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
553 # the form:
554 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
555 },
556 &quot;places&quot;: [ # Places where this photo belongs.
557 { # Place metadata for an entity.
558 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
559 # https://developers.google.com/places/place-id.
560 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
561 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
562 # be the language_code specified in the request, but may be a fallback.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700563 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700564 ],
565 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
566 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
567 # means level with the horizon.
568 # NaN indicates an unmeasured quantity.
569 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
570 # NaN indicates an unmeasured quantity.
571 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
572 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
573 # means looking directly up.
574 # NaN indicates an unmeasured quantity.
575 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
576 # confidence (one standard deviation). For example, on Android, this value is
577 # available from this method:
578 # https://developer.android.com/reference/android/location/Location#getAccuracy().
579 # Other platforms have different methods of obtaining similar accuracy
580 # estimations.
581 &quot;latLngPair&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
582 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
583 # When creating a Photo, if the
584 # latitude and longitude pair are not provided, the geolocation from the
585 # exif header is used. A latitude and longitude pair not provided in the
586 # photo or exif header causes the photo process to fail.
587 # of doubles representing degrees latitude and degrees longitude. Unless
588 # specified otherwise, this must conform to the
589 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
590 # standard&lt;/a&gt;. Values must be within normalized ranges.
591 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
592 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700593 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700594 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
595 # from North. Value must be &gt;=0 and &lt;360.
596 # NaN indicates an unmeasured quantity.
597 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
598 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
599 # the first level above ground level, -1 indicates the first level under
600 # ground level. Non-integer values are OK.
601 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
602 # Consider how the elevator buttons would be labeled for this level if there
603 # was an elevator.
604 },
605 },
606 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
607 # When the photo has no exif timestamp, this is used to set a timestamp in
608 # the photo metadata.
609 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
610 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
611 # Identifier for the photo, which is unique among all photos in
612 # Google.
613 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
614 },
615 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
616}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700617
Dan O'Mearadd494642020-05-01 07:42:23 -0700618 updateMask: string, Required. Mask that identifies fields on the photo metadata to update.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700619If 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
Bu Sun Kim65020912020-05-20 12:08:20 -0700637&lt;aside class=&quot;note&quot;&gt;&lt;b&gt;Note:&lt;/b&gt; When
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700638updateMask
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 -0700643all connections are removed.&lt;/aside&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700644 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700653 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
654 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
655 # photo to another photo.
656 { # A connection is the link from a source photo to a destination photo.
657 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
658 # another photo.
659 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
660 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700661 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700662 ],
663 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
664 # when
665 # GetPhotoRequest.view
666 # is set to
667 # PhotoView.INCLUDE_DOWNLOAD_URL.
668 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
669 # rejected. Not currently populated.
670 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
671 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
672 # photo bytes are uploaded to.
673 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
674 # the form:
675 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
676 },
677 &quot;places&quot;: [ # Places where this photo belongs.
678 { # Place metadata for an entity.
679 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
680 # https://developers.google.com/places/place-id.
681 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
682 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
683 # be the language_code specified in the request, but may be a fallback.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700684 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700685 ],
686 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
687 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
688 # means level with the horizon.
689 # NaN indicates an unmeasured quantity.
690 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
691 # NaN indicates an unmeasured quantity.
692 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
693 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
694 # means looking directly up.
695 # NaN indicates an unmeasured quantity.
696 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
697 # confidence (one standard deviation). For example, on Android, this value is
698 # available from this method:
699 # https://developer.android.com/reference/android/location/Location#getAccuracy().
700 # Other platforms have different methods of obtaining similar accuracy
701 # estimations.
702 &quot;latLngPair&quot;: { # An object representing a latitude/longitude pair. This is expressed as a pair # Latitude and longitude pair of the pose, as explained here:
703 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
704 # When creating a Photo, if the
705 # latitude and longitude pair are not provided, the geolocation from the
706 # exif header is used. A latitude and longitude pair not provided in the
707 # photo or exif header causes the photo process to fail.
708 # of doubles representing degrees latitude and degrees longitude. Unless
709 # specified otherwise, this must conform to the
710 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
711 # standard&lt;/a&gt;. Values must be within normalized ranges.
712 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
713 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700714 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700715 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
716 # from North. Value must be &gt;=0 and &lt;360.
717 # NaN indicates an unmeasured quantity.
718 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
719 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
720 # the first level above ground level, -1 indicates the first level under
721 # ground level. Non-integer values are OK.
722 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
723 # Consider how the elevator buttons would be labeled for this level if there
724 # was an elevator.
725 },
726 },
727 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
728 # When the photo has no exif timestamp, this is used to set a timestamp in
729 # the photo metadata.
730 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
731 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
732 # Identifier for the photo, which is unique among all photos in
733 # Google.
734 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
735 },
736 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
737 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700738</div>
739
740</body></html>