blob: 5502fb6dc87f5bbd9fae5d40988899d7bdf039e9 [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 Kim4ed7d3f2020-05-27 12:20:54 -070084 <code><a href="#get">get(photoId, languageCode=None, view=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 Kim4ed7d3f2020-05-27 12:20:54 -0700120 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
121 # When the photo has no exif timestamp, this is used to set a timestamp in
122 # the photo metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700123 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
124 # photo to another photo.
125 { # A connection is the link from a source photo to a destination photo.
126 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
127 # another photo.
128 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
129 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700130 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700131 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700132 &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 -0700133 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
134 # photo bytes are uploaded to.
135 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
136 # the form:
137 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
138 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700139 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
Bu Sun Kim65020912020-05-20 12:08:20 -0700140 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
Bu Sun Kim65020912020-05-20 12:08:20 -0700141 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
142 # confidence (one standard deviation). For example, on Android, this value is
143 # available from this method:
144 # https://developer.android.com/reference/android/location/Location#getAccuracy().
145 # Other platforms have different methods of obtaining similar accuracy
146 # estimations.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700147 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
148 # NaN indicates an unmeasured quantity.
149 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
150 # from North. Value must be &gt;=0 and &lt;360.
151 # NaN indicates an unmeasured quantity.
152 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
153 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
154 # Consider how the elevator buttons would be labeled for this level if there
155 # was an elevator.
156 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
157 # the first level above ground level, -1 indicates the first level under
158 # ground level. Non-integer values are OK.
159 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700160 &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:
161 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
162 # When creating a Photo, if the
163 # latitude and longitude pair are not provided, the geolocation from the
164 # exif header is used. A latitude and longitude pair not provided in the
165 # photo or exif header causes the photo process to fail.
166 # of doubles representing degrees latitude and degrees longitude. Unless
167 # specified otherwise, this must conform to the
168 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
169 # standard&lt;/a&gt;. Values must be within normalized ranges.
Bu Sun Kim65020912020-05-20 12:08:20 -0700170 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700171 &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 -0700172 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700173 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
174 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
175 # means looking directly up.
Bu Sun Kim65020912020-05-20 12:08:20 -0700176 # NaN indicates an unmeasured quantity.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700177 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
178 # means level with the horizon.
179 # NaN indicates an unmeasured quantity.
Bu Sun Kim65020912020-05-20 12:08:20 -0700180 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700181 &quot;places&quot;: [ # Places where this photo belongs.
182 { # Place metadata for an entity.
183 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
184 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
185 # be the language_code specified in the request, but may be a fallback.
186 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
187 # https://developers.google.com/places/place-id.
188 },
189 ],
190 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
191 # when
192 # GetPhotoRequest.view
193 # is set to
194 # PhotoView.INCLUDE_DOWNLOAD_URL.
195 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
Bu Sun Kim65020912020-05-20 12:08:20 -0700196 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
197 # Identifier for the photo, which is unique among all photos in
198 # Google.
199 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
200 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700201 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
202 # rejected. Not currently populated.
203 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of 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 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
216 # When the photo has no exif timestamp, this is used to set a timestamp in
217 # the photo metadata.
218 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
219 # photo to another photo.
220 { # A connection is the link from a source photo to a destination photo.
221 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
222 # another photo.
223 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
224 },
225 },
226 ],
227 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
228 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
229 # photo bytes are uploaded to.
230 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
231 # the form:
232 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
233 },
234 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
235 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
236 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
237 # confidence (one standard deviation). For example, on Android, this value is
238 # available from this method:
239 # https://developer.android.com/reference/android/location/Location#getAccuracy().
240 # Other platforms have different methods of obtaining similar accuracy
241 # estimations.
242 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
243 # NaN indicates an unmeasured quantity.
244 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
245 # from North. Value must be &gt;=0 and &lt;360.
246 # NaN indicates an unmeasured quantity.
247 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
248 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
249 # Consider how the elevator buttons would be labeled for this level if there
250 # was an elevator.
251 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
252 # the first level above ground level, -1 indicates the first level under
253 # ground level. Non-integer values are OK.
254 },
255 &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:
256 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
257 # When creating a Photo, if the
258 # latitude and longitude pair are not provided, the geolocation from the
259 # exif header is used. A latitude and longitude pair not provided in the
260 # photo or exif header causes the photo process to fail.
261 # of doubles representing degrees latitude and degrees longitude. Unless
262 # specified otherwise, this must conform to the
263 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
264 # standard&lt;/a&gt;. Values must be within normalized ranges.
265 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
266 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
267 },
268 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
269 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
270 # means looking directly up.
271 # NaN indicates an unmeasured quantity.
272 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
273 # means level with the horizon.
274 # NaN indicates an unmeasured quantity.
275 },
276 &quot;places&quot;: [ # Places where this photo belongs.
277 { # Place metadata for an entity.
278 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
279 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
280 # be the language_code specified in the request, but may be a fallback.
281 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
282 # https://developers.google.com/places/place-id.
283 },
284 ],
285 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
286 # when
287 # GetPhotoRequest.view
288 # is set to
289 # PhotoView.INCLUDE_DOWNLOAD_URL.
290 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
291 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
292 # Identifier for the photo, which is unique among all photos in
293 # Google.
294 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
295 },
296 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
297 # rejected. Not currently populated.
298 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the 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 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 Kim4ed7d3f2020-05-27 12:20:54 -0700335 <code class="details" id="get">get(photoId, languageCode=None, view=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 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 -0700351information, see
352http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
Bu Sun Kim65020912020-05-20 12:08:20 -0700353If language_code is unspecified, the user&#x27;s language preference for Google
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700354services is used.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700355 view: string, Required. Specifies if a download URL for the photo bytes should be returned in the
356Photo response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700357 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 Kim4ed7d3f2020-05-27 12:20:54 -0700366 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
367 # When the photo has no exif timestamp, this is used to set a timestamp in
368 # the photo metadata.
369 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
370 # photo to another photo.
371 { # A connection is the link from a source photo to a destination photo.
372 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
373 # another photo.
374 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
375 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700376 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700377 ],
378 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
379 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
380 # photo bytes are uploaded to.
381 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
382 # the form:
383 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700384 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700385 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
386 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
387 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
388 # confidence (one standard deviation). For example, on Android, this value is
389 # available from this method:
390 # https://developer.android.com/reference/android/location/Location#getAccuracy().
391 # Other platforms have different methods of obtaining similar accuracy
392 # estimations.
393 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
394 # NaN indicates an unmeasured quantity.
395 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
396 # from North. Value must be &gt;=0 and &lt;360.
397 # NaN indicates an unmeasured quantity.
398 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
399 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
400 # Consider how the elevator buttons would be labeled for this level if there
401 # was an elevator.
402 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
403 # the first level above ground level, -1 indicates the first level under
404 # ground level. Non-integer values are OK.
405 },
406 &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:
407 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
408 # When creating a Photo, if the
409 # latitude and longitude pair are not provided, the geolocation from the
410 # exif header is used. A latitude and longitude pair not provided in the
411 # photo or exif header causes the photo process to fail.
412 # of doubles representing degrees latitude and degrees longitude. Unless
413 # specified otherwise, this must conform to the
414 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
415 # standard&lt;/a&gt;. Values must be within normalized ranges.
416 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
417 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
418 },
419 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
420 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
421 # means looking directly up.
422 # NaN indicates an unmeasured quantity.
423 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
424 # means level with the horizon.
425 # NaN indicates an unmeasured quantity.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700426 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700427 &quot;places&quot;: [ # Places where this photo belongs.
428 { # Place metadata for an entity.
429 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
430 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
431 # be the language_code specified in the request, but may be a fallback.
432 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
433 # https://developers.google.com/places/place-id.
434 },
435 ],
436 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
437 # when
438 # GetPhotoRequest.view
439 # is set to
440 # PhotoView.INCLUDE_DOWNLOAD_URL.
441 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
442 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
443 # Identifier for the photo, which is unique among all photos in
444 # Google.
445 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700446 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700447 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
448 # rejected. Not currently populated.
449 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the 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 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 Kim4ed7d3f2020-05-27 12:20:54 -0700532 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
533 # When the photo has no exif timestamp, this is used to set a timestamp in
534 # the photo metadata.
535 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
536 # photo to another photo.
537 { # A connection is the link from a source photo to a destination photo.
538 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
539 # another photo.
540 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
541 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700542 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700543 ],
544 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
545 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
546 # photo bytes are uploaded to.
547 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
548 # the form:
549 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700550 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700551 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
552 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
553 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
554 # confidence (one standard deviation). For example, on Android, this value is
555 # available from this method:
556 # https://developer.android.com/reference/android/location/Location#getAccuracy().
557 # Other platforms have different methods of obtaining similar accuracy
558 # estimations.
559 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
560 # NaN indicates an unmeasured quantity.
561 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
562 # from North. Value must be &gt;=0 and &lt;360.
563 # NaN indicates an unmeasured quantity.
564 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
565 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
566 # Consider how the elevator buttons would be labeled for this level if there
567 # was an elevator.
568 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
569 # the first level above ground level, -1 indicates the first level under
570 # ground level. Non-integer values are OK.
571 },
572 &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:
573 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
574 # When creating a Photo, if the
575 # latitude and longitude pair are not provided, the geolocation from the
576 # exif header is used. A latitude and longitude pair not provided in the
577 # photo or exif header causes the photo process to fail.
578 # of doubles representing degrees latitude and degrees longitude. Unless
579 # specified otherwise, this must conform to the
580 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
581 # standard&lt;/a&gt;. Values must be within normalized ranges.
582 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
583 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
584 },
585 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
586 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
587 # means looking directly up.
588 # NaN indicates an unmeasured quantity.
589 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
590 # means level with the horizon.
591 # NaN indicates an unmeasured quantity.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700592 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700593 &quot;places&quot;: [ # Places where this photo belongs.
594 { # Place metadata for an entity.
595 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
596 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
597 # be the language_code specified in the request, but may be a fallback.
598 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
599 # https://developers.google.com/places/place-id.
600 },
601 ],
602 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
603 # when
604 # GetPhotoRequest.view
605 # is set to
606 # PhotoView.INCLUDE_DOWNLOAD_URL.
607 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
608 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
609 # Identifier for the photo, which is unique among all photos in
610 # Google.
611 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700612 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700613 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
614 # rejected. Not currently populated.
615 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the 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 Kim4ed7d3f2020-05-27 12:20:54 -0700653 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured.
654 # When the photo has no exif timestamp, this is used to set a timestamp in
655 # the photo metadata.
656 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this
657 # photo to another photo.
658 { # A connection is the link from a source photo to a destination photo.
659 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to
660 # another photo.
661 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
662 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700663 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700664 ],
665 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
666 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the
667 # photo bytes are uploaded to.
668 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows
669 # the form:
670 # &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700671 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700672 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
673 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
674 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68%
675 # confidence (one standard deviation). For example, on Android, this value is
676 # available from this method:
677 # https://developer.android.com/reference/android/location/Location#getAccuracy().
678 # Other platforms have different methods of obtaining similar accuracy
679 # estimations.
680 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid.
681 # NaN indicates an unmeasured quantity.
682 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise
683 # from North. Value must be &gt;=0 and &lt;360.
684 # NaN indicates an unmeasured quantity.
685 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
686 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters.
687 # Consider how the elevator buttons would be labeled for this level if there
688 # was an elevator.
689 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates
690 # the first level above ground level, -1 indicates the first level under
691 # ground level. Non-integer values are OK.
692 },
693 &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:
694 # https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng
695 # When creating a Photo, if the
696 # latitude and longitude pair are not provided, the geolocation from the
697 # exif header is used. A latitude and longitude pair not provided in the
698 # photo or exif header causes the photo process to fail.
699 # of doubles representing degrees latitude and degrees longitude. Unless
700 # specified otherwise, this must conform to the
701 # &lt;a href=&quot;http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf&quot;&gt;WGS84
702 # standard&lt;/a&gt;. Values must be within normalized ranges.
703 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
704 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
705 },
706 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90
707 # and &lt;= 90. A value of -90 means looking directly down, and a value of 90
708 # means looking directly up.
709 # NaN indicates an unmeasured quantity.
710 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0
711 # means level with the horizon.
712 # NaN indicates an unmeasured quantity.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700713 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700714 &quot;places&quot;: [ # Places where this photo belongs.
715 { # Place metadata for an entity.
716 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
717 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should
718 # be the language_code specified in the request, but may be a fallback.
719 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in
720 # https://developers.google.com/places/place-id.
721 },
722 ],
723 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only
724 # when
725 # GetPhotoRequest.view
726 # is set to
727 # PhotoView.INCLUDE_DOWNLOAD_URL.
728 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
729 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo.
730 # Identifier for the photo, which is unique among all photos in
731 # Google.
732 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700733 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700734 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or
735 # rejected. Not currently populated.
736 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
737 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700738</div>
739
740</body></html>