blob: 5d64df8788a400af40e7023559f7196cb6113319 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">After the client finishes uploading the photo with the returned UploadRef, CreatePhoto publishes the uploaded Photo to Street View on Google Maps. Currently, the only way to set heading, pitch, and roll in CreatePhoto is through the [Photo Sphere XMP metadata](https://developers.google.com/streetview/spherical-metadata) in the photo bytes. CreatePhoto ignores the `pose.heading`, `pose.pitch`, `pose.roll`, `pose.altitude`, and `pose.level` fields in Pose. This method returns the following error codes: * google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if the uploaded photo is not a 360 photo. * google.rpc.Code.NOT_FOUND if the upload reference does not exist. * google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the storage limit.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083<p class="toc_element">
84 <code><a href="#delete">delete(photoId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">Deletes a Photo and its metadata. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. * google.rpc.Code.NOT_FOUND if the photo ID does not exist.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080087 <code><a href="#get">get(photoId, languageCode=None, view=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="firstline">Gets the metadata of the specified Photo. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested Photo. * google.rpc.Code.NOT_FOUND if the requested Photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070089<p class="toc_element">
90 <code><a href="#startUpload">startUpload(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<p class="firstline">Creates an upload session to start uploading photo bytes. The method uses the upload URL of the returned UploadRef to upload the bytes for the Photo. In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, the photo must meet the following requirements: * Photo Sphere XMP metadata must be included in the photo metadata. See https://developers.google.com/streetview/spherical-metadata for the required fields. * The pixel size of the photo must meet the size requirements listed in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload completes, the method uses UploadRef with CreatePhoto to create the Photo object entry.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#update">update(id, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094<p class="firstline">Updates the metadata of a Photo, such as pose, place association, connections, etc. Changing the pixels of a photo is not supported. Only the fields specified in the updateMask field are used. If `updateMask` is not present, the update applies to all fields. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. * google.rpc.Code.INVALID_ARGUMENT if the request is malformed. * google.rpc.Code.NOT_FOUND if the requested photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070095<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 <pre>After the client finishes uploading the photo with the returned UploadRef, CreatePhoto publishes the uploaded Photo to Street View on Google Maps. Currently, the only way to set heading, pitch, and roll in CreatePhoto is through the [Photo Sphere XMP metadata](https://developers.google.com/streetview/spherical-metadata) in the photo bytes. CreatePhoto ignores the `pose.heading`, `pose.pitch`, `pose.roll`, `pose.altitude`, and `pose.level` fields in Pose. This method returns the following error codes: * google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if the uploaded photo is not a 360 photo. * google.rpc.Code.NOT_FOUND if the upload reference does not exist. * google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the storage limit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700104
105Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700106 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700107 The object takes the form of:
108
109{ # Photo is used to store 360 photos along with photo metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800110 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
111 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this photo to another photo.
112 { # A connection is the link from a source photo to a destination photo.
113 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
114 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800115 },
116 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800117 ],
118 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
119 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.
120 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
121 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
122 },
123 &quot;places&quot;: [ # Places where this photo belongs.
124 { # Place metadata for an entity.
125 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
126 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
127 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in https://developers.google.com/places/place-id.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800128 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800129 ],
130 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
131 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
132 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
133 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be &gt;=0 and &lt;360. NaN indicates an unmeasured quantity.
134 &quot;latLngPair&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
135 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
136 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800137 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
139 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
140 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
141 },
142 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90 and &lt;= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
143 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
144 },
145 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
146 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
147 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
148 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
149 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows the form: &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
150 },
151 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
152}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700153
154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159Returns:
160 An object of the form:
161
162 { # Photo is used to store 360 photos along with photo metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800163 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
164 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this photo to another photo.
165 { # A connection is the link from a source photo to a destination photo.
166 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800167 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
168 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800169 },
170 ],
171 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
172 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.
173 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
174 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
175 },
176 &quot;places&quot;: [ # Places where this photo belongs.
177 { # Place metadata for an entity.
178 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
179 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
180 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in https://developers.google.com/places/place-id.
181 },
182 ],
183 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
184 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
185 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
186 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be &gt;=0 and &lt;360. NaN indicates an unmeasured quantity.
187 &quot;latLngPair&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
188 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
189 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
190 },
191 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
192 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
193 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
194 },
195 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90 and &lt;= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
196 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
197 },
198 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
199 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
200 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
201 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
202 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows the form: &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
203 },
204 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
205}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700206</div>
207
208<div class="method">
209 <code class="details" id="delete">delete(photoId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700210 <pre>Deletes a Photo and its metadata. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. * google.rpc.Code.NOT_FOUND if the photo ID does not exist.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700211
212Args:
213 photoId: string, Required. ID of the Photo. (required)
214 x__xgafv: string, V1 error format.
215 Allowed values
216 1 - v1 error format
217 2 - v2 error format
218
219Returns:
220 An object of the form:
221
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700222 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800223}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700224</div>
225
226<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800227 <code class="details" id="get">get(photoId, languageCode=None, view=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700228 <pre>Gets the metadata of the specified Photo. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested Photo. * google.rpc.Code.NOT_FOUND if the requested Photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700229
230Args:
231 photoId: string, Required. ID of the Photo. (required)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800232 languageCode: string, The BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user&#x27;s language preference for Google services is used.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700233 view: string, Required. Specifies if a download URL for the photo bytes should be returned in the Photo response.
234 Allowed values
235 BASIC - Server reponses do not include the download URL for the photo bytes. The default value.
236 INCLUDE_DOWNLOAD_URL - Server responses include the download URL for the photo bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700237 x__xgafv: string, V1 error format.
238 Allowed values
239 1 - v1 error format
240 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700241
242Returns:
243 An object of the form:
244
245 { # Photo is used to store 360 photos along with photo metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800246 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
247 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this photo to another photo.
248 { # A connection is the link from a source photo to a destination photo.
249 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800250 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
251 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800252 },
253 ],
254 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
255 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.
256 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
257 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
258 },
259 &quot;places&quot;: [ # Places where this photo belongs.
260 { # Place metadata for an entity.
261 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
262 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
263 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in https://developers.google.com/places/place-id.
264 },
265 ],
266 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
267 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
268 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
269 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be &gt;=0 and &lt;360. NaN indicates an unmeasured quantity.
270 &quot;latLngPair&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
271 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
272 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
273 },
274 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
275 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
276 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
277 },
278 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90 and &lt;= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
279 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
280 },
281 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
282 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
283 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
284 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
285 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows the form: &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
286 },
287 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
288}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700289</div>
290
291<div class="method">
292 <code class="details" id="startUpload">startUpload(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700293 <pre>Creates an upload session to start uploading photo bytes. The method uses the upload URL of the returned UploadRef to upload the bytes for the Photo. In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?hl=en&amp;ref_topic=6275604, the photo must meet the following requirements: * Photo Sphere XMP metadata must be included in the photo metadata. See https://developers.google.com/streetview/spherical-metadata for the required fields. * The pixel size of the photo must meet the size requirements listed in https://support.google.com/maps/answer/7012050?hl=en&amp;ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload completes, the method uses UploadRef with CreatePhoto to create the Photo object entry.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700294
295Args:
296 body: object, The request body.
297 The object takes the form of:
298
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700299{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800300}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700301
302 x__xgafv: string, V1 error format.
303 Allowed values
304 1 - v1 error format
305 2 - v2 error format
306
307Returns:
308 An object of the form:
309
310 { # Upload reference for media files.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800311 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows the form: &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
312}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700313</div>
314
315<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700316 <code class="details" id="update">update(id, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700317 <pre>Updates the metadata of a Photo, such as pose, place association, connections, etc. Changing the pixels of a photo is not supported. Only the fields specified in the updateMask field are used. If `updateMask` is not present, the update applies to all fields. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested photo. * google.rpc.Code.INVALID_ARGUMENT if the request is malformed. * google.rpc.Code.NOT_FOUND if the requested photo does not exist. * google.rpc.Code.UNAVAILABLE if the requested Photo is still being indexed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700318
319Args:
320 id: string, Required. A unique identifier for a photo. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700321 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700322 The object takes the form of:
323
324{ # Photo is used to store 360 photos along with photo metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800325 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
326 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this photo to another photo.
327 { # A connection is the link from a source photo to a destination photo.
328 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
329 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800330 },
331 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800332 ],
333 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
334 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.
335 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
336 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
337 },
338 &quot;places&quot;: [ # Places where this photo belongs.
339 { # Place metadata for an entity.
340 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
341 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
342 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in https://developers.google.com/places/place-id.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800343 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800344 ],
345 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
346 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
347 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
348 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be &gt;=0 and &lt;360. NaN indicates an unmeasured quantity.
349 &quot;latLngPair&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
350 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
351 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800352 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800353 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
354 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
355 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
356 },
357 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90 and &lt;= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
358 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
359 },
360 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
361 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
362 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
363 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
364 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows the form: &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
365 },
366 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
367}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700368
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700369 updateMask: string, Required. Mask that identifies fields on the photo metadata to update. If not present, the old Photo metadata is entirely replaced with the new Photo metadata in this request. The update fails if invalid fields are specified. Multiple fields can be specified in a comma-delimited list. The following fields are valid: * `pose.heading` * `pose.latLngPair` * `pose.pitch` * `pose.roll` * `pose.level` * `pose.altitude` * `connections` * `places` *Note:* When updateMask contains repeated fields, the entire set of repeated values get replaced with the new contents. For example, if updateMask contains `connections` and `UpdatePhotoRequest.photo.connections` is empty, all connections are removed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700370 x__xgafv: string, V1 error format.
371 Allowed values
372 1 - v1 error format
373 2 - v2 error format
374
375Returns:
376 An object of the form:
377
378 { # Photo is used to store 360 photos along with photo metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800379 &quot;captureTime&quot;: &quot;A String&quot;, # Absolute time when the photo was captured. When the photo has no exif timestamp, this is used to set a timestamp in the photo metadata.
380 &quot;connections&quot;: [ # Connections to other photos. A connection represents the link from this photo to another photo.
381 { # A connection is the link from a source photo to a destination photo.
382 &quot;target&quot;: { # Identifier for a Photo. # Required. The destination of the connection from the containing photo to another photo.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800383 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
384 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800385 },
386 ],
387 &quot;downloadUrl&quot;: &quot;A String&quot;, # Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.
388 &quot;mapsPublishStatus&quot;: &quot;A String&quot;, # Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.
389 &quot;photoId&quot;: { # Identifier for a Photo. # Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.
390 &quot;id&quot;: &quot;A String&quot;, # Required. A unique identifier for a photo.
391 },
392 &quot;places&quot;: [ # Places where this photo belongs.
393 { # Place metadata for an entity.
394 &quot;languageCode&quot;: &quot;A String&quot;, # Output-only. The language_code that the name is localized with. This should be the language_code specified in the request, but may be a fallback.
395 &quot;name&quot;: &quot;A String&quot;, # Output-only. The name of the place, localized to the language_code.
396 &quot;placeId&quot;: &quot;A String&quot;, # Place identifier, as described in https://developers.google.com/places/place-id.
397 },
398 ],
399 &quot;pose&quot;: { # Raw pose measurement for an entity. # Pose of the photo.
400 &quot;accuracyMeters&quot;: 3.14, # The estimated horizontal accuracy of this pose in meters with 68% confidence (one standard deviation). For example, on Android, this value is available from this method: https://developer.android.com/reference/android/location/Location#getAccuracy(). Other platforms have different methods of obtaining similar accuracy estimations.
401 &quot;altitude&quot;: 3.14, # Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.
402 &quot;heading&quot;: 3.14, # Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be &gt;=0 and &lt;360. NaN indicates an unmeasured quantity.
403 &quot;latLngPair&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. # Latitude and longitude pair of the pose, as explained here: https://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng When creating a Photo, if the latitude and longitude pair are not provided, the geolocation from the exif header is used. A latitude and longitude pair not provided in the photo or exif header causes the photo process to fail.
404 &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
405 &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
406 },
407 &quot;level&quot;: { # Level information containing level number and its corresponding name. # Level (the floor in a building) used to configure vertical navigation.
408 &quot;name&quot;: &quot;A String&quot;, # Required. A name assigned to this Level, restricted to 3 characters. Consider how the elevator buttons would be labeled for this level if there was an elevator.
409 &quot;number&quot;: 3.14, # Floor number, used for ordering. 0 indicates the ground level, 1 indicates the first level above ground level, -1 indicates the first level under ground level. Non-integer values are OK.
410 },
411 &quot;pitch&quot;: 3.14, # Pitch, measured at the center of the photo in degrees. Value must be &gt;=-90 and &lt;= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.
412 &quot;roll&quot;: 3.14, # Roll, measured in degrees. Value must be &gt;= 0 and &lt;360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.
413 },
414 &quot;shareLink&quot;: &quot;A String&quot;, # Output only. The share link for the photo.
415 &quot;thumbnailUrl&quot;: &quot;A String&quot;, # Output only. The thumbnail URL for showing a preview of the given photo.
416 &quot;transferStatus&quot;: &quot;A String&quot;, # Output only. Status of rights transfer on this photo.
417 &quot;uploadReference&quot;: { # Upload reference for media files. # Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to.
418 &quot;uploadUrl&quot;: &quot;A String&quot;, # Required. An upload reference should be unique for each user. It follows the form: &quot;https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}&quot;
419 },
420 &quot;viewCount&quot;: &quot;A String&quot;, # Output only. View count of the photo.
421}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700422</div>
423
424</body></html>