blob: a294ef30ab3f3e6b5d8da9bc2d82ab44b1ea9459 [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 Kimd059ad82020-07-22 17:02:09 -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 Kimd059ad82020-07-22 17:02:09 -0700120 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
121 # Identifier for the photo, which is unique among all photos in
122 # Google.
123 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
124 },
125 &quot;places&quot;: [ # Places where this photo belongs.
126 { # Place metadata for an entity.
127 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
128 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
129 # be the language_code specified in the request, but may be a fallback.
130 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
131 # https://developers.google.com/places/place-id.
132 },
133 ],
134 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
135 # when
136 # GetPhotoRequest.view
137 # is set to
138 # PhotoView.INCLUDE_DOWNLOAD_URL.
139 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
140 # When the photo has no exif timestamp, this is used to set a timestamp in
141 # the photo metadata.
142 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
143 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
144 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
145 # from North. Value must be &gt;=0 and &lt;360.
146 # NaN indicates an unmeasured quantity.
147 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
148 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
149 # Consider how the elevator buttons would be labeled for this level if there
150 # was an elevator.
151 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
152 # the first level above ground level, -1 indicates the first level under
153 # ground level. Non-integer values are OK.
154 },
155 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
156 # means level with the horizon.
157 # NaN indicates an unmeasured quantity.
158 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
159 # NaN indicates an unmeasured quantity.
160 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
161 # confidence (one standard deviation). For example, on Android, this value is
162 # available from this method:
163 # https://developer.android.com/reference/android/location/Location#getAccuracy().
164 # Other platforms have different methods of obtaining similar accuracy
165 # estimations.
166 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
167 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
168 # means looking directly up.
169 # NaN indicates an unmeasured quantity.
170 &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:
171 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
172 # When creating a Photo, if the
173 # latitude and longitude pair are not provided, the geolocation from the
174 # exif header is used. A latitude and longitude pair not provided in the
175 # photo or exif header causes the photo process to fail.
176 # of doubles representing degrees latitude and degrees longitude. Unless
177 # specified otherwise, this must conform to the
178 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
179 # standard&lt;/a&gt;. Values must be within normalized ranges.
180 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
181 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
182 },
183 },
184 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
185 # photo to another photo.
186 { # A connection is the link from a source photo to a destination photo.
187 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
188 # another photo.
189 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
190 },
191 },
192 ],
193 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
194 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
195 # photo bytes are uploaded to.
196 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
197 # the form:
198 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
199 },
200 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
201 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
202 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
203 # rejected. Not currently populated.
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 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
216 # Identifier for the photo, which is unique among all photos in
217 # Google.
218 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
219 },
220 &quot;places&quot;: [ # Places where this photo belongs.
221 { # Place metadata for an entity.
222 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
223 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
224 # be the language_code specified in the request, but may be a fallback.
225 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
226 # https://developers.google.com/places/place-id.
227 },
228 ],
229 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
230 # when
231 # GetPhotoRequest.view
232 # is set to
233 # PhotoView.INCLUDE_DOWNLOAD_URL.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700234 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
235 # When the photo has no exif timestamp, this is used to set a timestamp in
236 # the photo metadata.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700237 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
238 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
239 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
240 # from North. Value must be &gt;=0 and &lt;360.
241 # NaN indicates an unmeasured quantity.
242 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
243 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
244 # Consider how the elevator buttons would be labeled for this level if there
245 # was an elevator.
246 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
247 # the first level above ground level, -1 indicates the first level under
248 # ground level. Non-integer values are OK.
249 },
250 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
251 # means level with the horizon.
252 # NaN indicates an unmeasured quantity.
253 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
254 # NaN indicates an unmeasured quantity.
255 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
256 # confidence (one standard deviation). For example, on Android, this value is
257 # available from this method:
258 # https://developer.android.com/reference/android/location/Location#getAccuracy().
259 # Other platforms have different methods of obtaining similar accuracy
260 # estimations.
261 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
262 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
263 # means looking directly up.
264 # NaN indicates an unmeasured quantity.
265 &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:
266 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
267 # When creating a Photo, if the
268 # latitude and longitude pair are not provided, the geolocation from the
269 # exif header is used. A latitude and longitude pair not provided in the
270 # photo or exif header causes the photo process to fail.
271 # of doubles representing degrees latitude and degrees longitude. Unless
272 # specified otherwise, this must conform to the
273 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
274 # standard&lt;/a&gt;. Values must be within normalized ranges.
275 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
276 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
277 },
278 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700279 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
280 # photo to another photo.
281 { # A connection is the link from a source photo to a destination photo.
282 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
283 # another photo.
284 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
285 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700286 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700287 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700288 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
Bu Sun Kim65020912020-05-20 12:08:20 -0700289 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
290 # photo bytes are uploaded to.
291 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
292 # the form:
293 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
294 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700295 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700296 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700297 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
298 # rejected. Not currently populated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700299 }</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 Kim4ed7d3f2020-05-27 12:20:54 -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 Kimd059ad82020-07-22 17:02:09 -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 Kimd059ad82020-07-22 17:02:09 -0700350 view: string, Required. Specifies if a download URL for the photo bytes should be returned in the
351Photo response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700352 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 Kimd059ad82020-07-22 17:02:09 -0700366 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
367 # Identifier for the photo, which is unique among all photos in
368 # Google.
369 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
370 },
371 &quot;places&quot;: [ # Places where this photo belongs.
372 { # Place metadata for an entity.
373 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
374 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
375 # be the language_code specified in the request, but may be a fallback.
376 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
377 # https://developers.google.com/places/place-id.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700378 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700379 ],
380 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
381 # when
382 # GetPhotoRequest.view
383 # is set to
384 # PhotoView.INCLUDE_DOWNLOAD_URL.
385 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
386 # When the photo has no exif timestamp, this is used to set a timestamp in
387 # the photo metadata.
388 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
389 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
390 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
391 # from North. Value must be &gt;=0 and &lt;360.
392 # NaN indicates an unmeasured quantity.
393 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
394 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
395 # Consider how the elevator buttons would be labeled for this level if there
396 # was an elevator.
397 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
398 # the first level above ground level, -1 indicates the first level under
399 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700400 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700401 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
402 # means level with the horizon.
403 # NaN indicates an unmeasured quantity.
404 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
405 # NaN indicates an unmeasured quantity.
406 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
407 # confidence (one standard deviation). For example, on Android, this value is
408 # available from this method:
409 # https://developer.android.com/reference/android/location/Location#getAccuracy().
410 # Other platforms have different methods of obtaining similar accuracy
411 # estimations.
412 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
413 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
414 # means looking directly up.
415 # NaN indicates an unmeasured quantity.
416 &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:
417 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
418 # When creating a Photo, if the
419 # latitude and longitude pair are not provided, the geolocation from the
420 # exif header is used. A latitude and longitude pair not provided in the
421 # photo or exif header causes the photo process to fail.
422 # of doubles representing degrees latitude and degrees longitude. Unless
423 # specified otherwise, this must conform to the
424 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
425 # standard&lt;/a&gt;. Values must be within normalized ranges.
426 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
427 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700428 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700429 },
430 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
431 # photo to another photo.
432 { # A connection is the link from a source photo to a destination photo.
433 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
434 # another photo.
435 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
436 },
437 },
438 ],
439 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
440 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
441 # photo bytes are uploaded to.
442 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
443 # the form:
444 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
445 },
446 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
447 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
448 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
449 # rejected. Not currently populated.
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 Kim4ed7d3f2020-05-27 12:20:54 -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 Kimd059ad82020-07-22 17:02:09 -0700532 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
533 # Identifier for the photo, which is unique among all photos in
534 # Google.
535 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
536 },
537 &quot;places&quot;: [ # Places where this photo belongs.
538 { # Place metadata for an entity.
539 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
540 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
541 # be the language_code specified in the request, but may be a fallback.
542 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
543 # https://developers.google.com/places/place-id.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700544 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700545 ],
546 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
547 # when
548 # GetPhotoRequest.view
549 # is set to
550 # PhotoView.INCLUDE_DOWNLOAD_URL.
551 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
552 # When the photo has no exif timestamp, this is used to set a timestamp in
553 # the photo metadata.
554 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
555 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
556 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
557 # from North. Value must be &gt;=0 and &lt;360.
558 # NaN indicates an unmeasured quantity.
559 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
560 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
561 # Consider how the elevator buttons would be labeled for this level if there
562 # was an elevator.
563 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
564 # the first level above ground level, -1 indicates the first level under
565 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700566 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700567 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
568 # means level with the horizon.
569 # NaN indicates an unmeasured quantity.
570 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
571 # NaN indicates an unmeasured quantity.
572 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
573 # confidence (one standard deviation). For example, on Android, this value is
574 # available from this method:
575 # https://developer.android.com/reference/android/location/Location#getAccuracy().
576 # Other platforms have different methods of obtaining similar accuracy
577 # estimations.
578 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
579 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
580 # means looking directly up.
581 # NaN indicates an unmeasured quantity.
582 &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:
583 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
584 # When creating a Photo, if the
585 # latitude and longitude pair are not provided, the geolocation from the
586 # exif header is used. A latitude and longitude pair not provided in the
587 # photo or exif header causes the photo process to fail.
588 # of doubles representing degrees latitude and degrees longitude. Unless
589 # specified otherwise, this must conform to the
590 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
591 # standard&lt;/a&gt;. Values must be within normalized ranges.
592 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
593 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700594 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700595 },
596 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
597 # photo to another photo.
598 { # A connection is the link from a source photo to a destination photo.
599 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
600 # another photo.
601 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
602 },
603 },
604 ],
605 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
606 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
607 # photo bytes are uploaded to.
608 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
609 # the form:
610 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
611 },
612 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
613 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
614 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
615 # rejected. Not currently populated.
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 Kimd059ad82020-07-22 17:02:09 -0700653 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
654 # Identifier for the photo, which is unique among all photos in
655 # Google.
656 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
657 },
658 &quot;places&quot;: [ # Places where this photo belongs.
659 { # Place metadata for an entity.
660 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
661 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
662 # be the language_code specified in the request, but may be a fallback.
663 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
664 # https://developers.google.com/places/place-id.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700665 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700666 ],
667 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
668 # when
669 # GetPhotoRequest.view
670 # is set to
671 # PhotoView.INCLUDE_DOWNLOAD_URL.
672 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
673 # When the photo has no exif timestamp, this is used to set a timestamp in
674 # the photo metadata.
675 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
676 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
677 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
678 # from North. Value must be &gt;=0 and &lt;360.
679 # NaN indicates an unmeasured quantity.
680 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
681 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
682 # Consider how the elevator buttons would be labeled for this level if there
683 # was an elevator.
684 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
685 # the first level above ground level, -1 indicates the first level under
686 # ground level. Non-integer values are OK.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700687 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700688 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
689 # means level with the horizon.
690 # NaN indicates an unmeasured quantity.
691 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
692 # NaN indicates an unmeasured quantity.
693 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
694 # confidence (one standard deviation). For example, on Android, this value is
695 # available from this method:
696 # https://developer.android.com/reference/android/location/Location#getAccuracy().
697 # Other platforms have different methods of obtaining similar accuracy
698 # estimations.
699 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
700 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
701 # means looking directly up.
702 # NaN indicates an unmeasured quantity.
703 &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:
704 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
705 # When creating a Photo, if the
706 # latitude and longitude pair are not provided, the geolocation from the
707 # exif header is used. A latitude and longitude pair not provided in the
708 # photo or exif header causes the photo process to fail.
709 # of doubles representing degrees latitude and degrees longitude. Unless
710 # specified otherwise, this must conform to the
711 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
712 # standard&lt;/a&gt;. Values must be within normalized ranges.
713 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
714 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700715 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700716 },
717 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
718 # photo to another photo.
719 { # A connection is the link from a source photo to a destination photo.
720 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
721 # another photo.
722 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
723 },
724 },
725 ],
726 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
727 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
728 # photo bytes are uploaded to.
729 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
730 # the form:
731 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
732 },
733 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
734 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
735 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
736 # rejected. Not currently populated.
737 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700738</div>
739
740</body></html>