blob: 2f10b34297e0c51a18fa8cec1c7ddc715c81f0d3 [file] [log] [blame]
Martin Kustermann8c5bbda2017-07-10 13:23:47 +02001{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/streetviewpublish": {
6 "description": "Publish and manage your 360 photos on Google Street View"
7 }
8 }
9 }
10 },
11 "basePath": "",
12 "baseUrl": "https://streetviewpublish.googleapis.com/",
13 "batchPath": "batch",
14 "canonicalName": "Street View Publish",
Jonas Finnemann Jensenef0c8a32020-10-07 20:58:20 +020015 "description": "Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images. ",
Martin Kustermann8c5bbda2017-07-10 13:23:47 +020016 "discoveryVersion": "v1",
17 "documentationLink": "https://developers.google.com/streetview/publish/",
18 "icons": {
19 "x16": "http://www.google.com/images/icons/product/search-16.gif",
20 "x32": "http://www.google.com/images/icons/product/search-32.gif"
21 },
22 "id": "streetviewpublish:v1",
23 "kind": "discovery#restDescription",
24 "name": "streetviewpublish",
25 "ownerDomain": "google.com",
26 "ownerName": "Google",
27 "parameters": {
Kevin Moore1d80b062021-01-27 12:01:41 -080028 "$.xgafv": {
29 "description": "V1 error format.",
30 "enum": [
31 "1",
32 "2"
33 ],
34 "enumDescriptions": [
35 "v1 error format",
36 "v2 error format"
37 ],
Jonas Finnemann Jensendad5d0c2020-05-06 17:16:56 +020038 "location": "query",
39 "type": "string"
40 },
Kevin Moore1d80b062021-01-27 12:01:41 -080041 "access_token": {
42 "description": "OAuth access token.",
Jonas Finnemann Jensendad5d0c2020-05-06 17:16:56 +020043 "location": "query",
44 "type": "string"
45 },
Martin Kustermann81eb88b2018-06-04 12:02:00 +020046 "alt": {
47 "default": "json",
48 "description": "Data format for response.",
49 "enum": [
50 "json",
51 "media",
52 "proto"
53 ],
54 "enumDescriptions": [
55 "Responses with Content-Type of application/json",
56 "Media download with context-dependent Content-Type",
57 "Responses with Content-Type of application/x-protobuf"
58 ],
59 "location": "query",
60 "type": "string"
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +020061 },
Kevin Moore1d80b062021-01-27 12:01:41 -080062 "callback": {
63 "description": "JSONP",
64 "location": "query",
65 "type": "string"
66 },
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +020067 "fields": {
68 "description": "Selector specifying which fields to include in a partial response.",
69 "location": "query",
70 "type": "string"
71 },
72 "key": {
73 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
74 "location": "query",
75 "type": "string"
76 },
Kevin Moore1d80b062021-01-27 12:01:41 -080077 "oauth_token": {
78 "description": "OAuth 2.0 token for the current user.",
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +020079 "location": "query",
80 "type": "string"
81 },
82 "prettyPrint": {
83 "default": "true",
84 "description": "Returns response with indentations and line breaks.",
85 "location": "query",
86 "type": "boolean"
87 },
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +020088 "quotaUser": {
89 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
90 "location": "query",
91 "type": "string"
Kevin Moore1d80b062021-01-27 12:01:41 -080092 },
93 "uploadType": {
94 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
95 "location": "query",
96 "type": "string"
97 },
98 "upload_protocol": {
99 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
100 "location": "query",
101 "type": "string"
Martin Kustermann8c5bbda2017-07-10 13:23:47 +0200102 }
103 },
104 "protocol": "rest",
105 "resources": {
Jonas Finnemann Jensendad5d0c2020-05-06 17:16:56 +0200106 "photo": {
107 "methods": {
Kevin Moore1d80b062021-01-27 12:01:41 -0800108 "create": {
109 "description": "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.",
Kevin Moore6720c222021-06-08 09:41:30 -0700110 "flatPath": "v1/photo",
Kevin Moore1d80b062021-01-27 12:01:41 -0800111 "httpMethod": "POST",
112 "id": "streetviewpublish.photo.create",
113 "parameterOrder": [],
114 "parameters": {},
115 "path": "v1/photo",
116 "request": {
117 "$ref": "Photo"
118 },
119 "response": {
120 "$ref": "Photo"
121 },
122 "scopes": [
123 "https://www.googleapis.com/auth/streetviewpublish"
124 ]
125 },
Jonas Finnemann Jensenef0c8a32020-10-07 20:58:20 +0200126 "delete": {
127 "description": "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.",
Kevin Moore6720c222021-06-08 09:41:30 -0700128 "flatPath": "v1/photo/{photoId}",
Jonas Finnemann Jensenef0c8a32020-10-07 20:58:20 +0200129 "httpMethod": "DELETE",
130 "id": "streetviewpublish.photo.delete",
Martin Kustermannf9109a82018-01-08 15:24:20 +0100131 "parameterOrder": [
132 "photoId"
133 ],
134 "parameters": {
135 "photoId": {
136 "description": "Required. ID of the Photo.",
137 "location": "path",
138 "required": true,
139 "type": "string"
Martin Kustermannf9109a82018-01-08 15:24:20 +0100140 }
141 },
142 "path": "v1/photo/{photoId}",
143 "response": {
Jonas Finnemann Jensenef0c8a32020-10-07 20:58:20 +0200144 "$ref": "Empty"
Martin Kustermannf9109a82018-01-08 15:24:20 +0100145 },
146 "scopes": [
147 "https://www.googleapis.com/auth/streetviewpublish"
148 ]
149 },
Kevin Moore1d80b062021-01-27 12:01:41 -0800150 "get": {
151 "description": "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.",
Kevin Moore6720c222021-06-08 09:41:30 -0700152 "flatPath": "v1/photo/{photoId}",
Kevin Moore1d80b062021-01-27 12:01:41 -0800153 "httpMethod": "GET",
154 "id": "streetviewpublish.photo.get",
155 "parameterOrder": [
156 "photoId"
157 ],
158 "parameters": {
159 "languageCode": {
160 "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used.",
161 "location": "query",
162 "type": "string"
163 },
164 "photoId": {
165 "description": "Required. ID of the Photo.",
166 "location": "path",
167 "required": true,
168 "type": "string"
169 },
170 "view": {
171 "description": "Required. Specifies if a download URL for the photo bytes should be returned in the Photo response.",
172 "enum": [
173 "BASIC",
174 "INCLUDE_DOWNLOAD_URL"
175 ],
176 "enumDescriptions": [
Kevin Moore32d60fa2021-04-25 17:33:47 -0700177 "Server responses do not include the download URL for the photo bytes. The default value.",
Kevin Moore1d80b062021-01-27 12:01:41 -0800178 "Server responses include the download URL for the photo bytes."
179 ],
180 "location": "query",
181 "type": "string"
182 }
183 },
184 "path": "v1/photo/{photoId}",
185 "response": {
186 "$ref": "Photo"
187 },
188 "scopes": [
189 "https://www.googleapis.com/auth/streetviewpublish"
190 ]
191 },
192 "startUpload": {
Kevin Moore44bb6052021-01-27 12:34:41 -0800193 "description": "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?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?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.",
Kevin Moore6720c222021-06-08 09:41:30 -0700194 "flatPath": "v1/photo:startUpload",
Kevin Moore1d80b062021-01-27 12:01:41 -0800195 "httpMethod": "POST",
196 "id": "streetviewpublish.photo.startUpload",
197 "parameterOrder": [],
198 "parameters": {},
199 "path": "v1/photo:startUpload",
200 "request": {
201 "$ref": "Empty"
202 },
203 "response": {
204 "$ref": "UploadRef"
205 },
206 "scopes": [
207 "https://www.googleapis.com/auth/streetviewpublish"
208 ]
209 },
Martin Kustermannbe200482017-12-04 11:42:32 +0100210 "update": {
Jonas Finnemann Jensenef0c8a32020-10-07 20:58:20 +0200211 "description": "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.",
Kevin Moore6720c222021-06-08 09:41:30 -0700212 "flatPath": "v1/photo/{id}",
Martin Kustermannbe200482017-12-04 11:42:32 +0100213 "httpMethod": "PUT",
214 "id": "streetviewpublish.photo.update",
215 "parameterOrder": [
216 "id"
217 ],
218 "parameters": {
Martin Kustermannf9109a82018-01-08 15:24:20 +0100219 "id": {
220 "description": "Required. A unique identifier for a photo.",
221 "location": "path",
222 "required": true,
223 "type": "string"
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200224 },
225 "updateMask": {
226 "description": "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.",
227 "format": "google-fieldmask",
228 "location": "query",
229 "type": "string"
Martin Kustermannbe200482017-12-04 11:42:32 +0100230 }
231 },
232 "path": "v1/photo/{id}",
233 "request": {
234 "$ref": "Photo"
235 },
236 "response": {
237 "$ref": "Photo"
238 },
239 "scopes": [
240 "https://www.googleapis.com/auth/streetviewpublish"
241 ]
Kevin Moore1d80b062021-01-27 12:01:41 -0800242 }
243 }
244 },
245 "photos": {
246 "methods": {
247 "batchDelete": {
248 "description": "Deletes a list of Photos and their metadata. Note that if BatchDeletePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchDeletePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchDeletePhotosResponse.results. See DeletePhoto for specific failures that can occur per photo.",
Kevin Moore6720c222021-06-08 09:41:30 -0700249 "flatPath": "v1/photos:batchDelete",
Kevin Moore1d80b062021-01-27 12:01:41 -0800250 "httpMethod": "POST",
251 "id": "streetviewpublish.photos.batchDelete",
252 "parameterOrder": [],
253 "parameters": {},
254 "path": "v1/photos:batchDelete",
255 "request": {
256 "$ref": "BatchDeletePhotosRequest"
257 },
258 "response": {
259 "$ref": "BatchDeletePhotosResponse"
260 },
261 "scopes": [
262 "https://www.googleapis.com/auth/streetviewpublish"
263 ]
Martin Kustermannbe200482017-12-04 11:42:32 +0100264 },
Kevin Moore1d80b062021-01-27 12:01:41 -0800265 "batchGet": {
266 "description": "Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there is an authentication error. Even if BatchGetPhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.",
Kevin Moore6720c222021-06-08 09:41:30 -0700267 "flatPath": "v1/photos:batchGet",
Jonas Finnemann Jensenef0c8a32020-10-07 20:58:20 +0200268 "httpMethod": "GET",
Kevin Moore1d80b062021-01-27 12:01:41 -0800269 "id": "streetviewpublish.photos.batchGet",
270 "parameterOrder": [],
Jonas Finnemann Jensendad5d0c2020-05-06 17:16:56 +0200271 "parameters": {
Kevin Moore1d80b062021-01-27 12:01:41 -0800272 "languageCode": {
273 "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used.",
274 "location": "query",
275 "type": "string"
276 },
277 "photoIds": {
278 "description": "Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be `photoIds=&photoIds=&...`.",
279 "location": "query",
280 "repeated": true,
281 "type": "string"
282 },
Jonas Finnemann Jensenef0c8a32020-10-07 20:58:20 +0200283 "view": {
284 "description": "Required. Specifies if a download URL for the photo bytes should be returned in the Photo response.",
285 "enum": [
286 "BASIC",
287 "INCLUDE_DOWNLOAD_URL"
288 ],
289 "enumDescriptions": [
Kevin Moore32d60fa2021-04-25 17:33:47 -0700290 "Server responses do not include the download URL for the photo bytes. The default value.",
Jonas Finnemann Jensenef0c8a32020-10-07 20:58:20 +0200291 "Server responses include the download URL for the photo bytes."
292 ],
293 "location": "query",
294 "type": "string"
Kevin Moore1d80b062021-01-27 12:01:41 -0800295 }
296 },
297 "path": "v1/photos:batchGet",
298 "response": {
299 "$ref": "BatchGetPhotosResponse"
300 },
301 "scopes": [
302 "https://www.googleapis.com/auth/streetviewpublish"
303 ]
304 },
305 "batchUpdate": {
306 "description": "Updates the metadata of Photos, such as pose, place association, connections, etc. Changing the pixels of photos is not supported. Note that if BatchUpdatePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchUpdatePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchUpdatePhotosResponse.results. See UpdatePhoto for specific failures that can occur per photo. Only the fields specified in updateMask field are used. If `updateMask` is not present, the update applies to all fields. The number of UpdatePhotoRequest messages in a BatchUpdatePhotosRequest must not exceed 20. *Note:* To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail.",
Kevin Moore6720c222021-06-08 09:41:30 -0700307 "flatPath": "v1/photos:batchUpdate",
Kevin Moore1d80b062021-01-27 12:01:41 -0800308 "httpMethod": "POST",
309 "id": "streetviewpublish.photos.batchUpdate",
310 "parameterOrder": [],
311 "parameters": {},
312 "path": "v1/photos:batchUpdate",
313 "request": {
314 "$ref": "BatchUpdatePhotosRequest"
315 },
316 "response": {
317 "$ref": "BatchUpdatePhotosResponse"
318 },
319 "scopes": [
320 "https://www.googleapis.com/auth/streetviewpublish"
321 ]
322 },
323 "list": {
324 "description": "Lists all the Photos that belong to the user. *Note:* Recently created photos that are still being indexed are not returned in the response.",
Kevin Moore6720c222021-06-08 09:41:30 -0700325 "flatPath": "v1/photos",
Kevin Moore1d80b062021-01-27 12:01:41 -0800326 "httpMethod": "GET",
327 "id": "streetviewpublish.photos.list",
328 "parameterOrder": [],
329 "parameters": {
330 "filter": {
331 "description": "Required. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The only filter supported at the moment is `placeId`.",
332 "location": "query",
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200333 "type": "string"
334 },
335 "languageCode": {
336 "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used.",
337 "location": "query",
338 "type": "string"
Kevin Moore1d80b062021-01-27 12:01:41 -0800339 },
340 "pageSize": {
341 "description": "The maximum number of photos to return. `pageSize` must be non-negative. If `pageSize` is zero or is not provided, the default page size of 100 is used. The number of photos returned in the response may be less than `pageSize` if the number of photos that belong to the user is less than `pageSize`.",
342 "format": "int32",
343 "location": "query",
344 "type": "integer"
345 },
346 "pageToken": {
347 "description": "The nextPageToken value returned from a previous ListPhotos request, if any.",
348 "location": "query",
349 "type": "string"
350 },
351 "view": {
352 "description": "Required. Specifies if a download URL for the photos bytes should be returned in the Photos response.",
353 "enum": [
354 "BASIC",
355 "INCLUDE_DOWNLOAD_URL"
356 ],
357 "enumDescriptions": [
Kevin Moore32d60fa2021-04-25 17:33:47 -0700358 "Server responses do not include the download URL for the photo bytes. The default value.",
Kevin Moore1d80b062021-01-27 12:01:41 -0800359 "Server responses include the download URL for the photo bytes."
360 ],
361 "location": "query",
362 "type": "string"
Jonas Finnemann Jensendad5d0c2020-05-06 17:16:56 +0200363 }
364 },
Kevin Moore1d80b062021-01-27 12:01:41 -0800365 "path": "v1/photos",
Jonas Finnemann Jensendad5d0c2020-05-06 17:16:56 +0200366 "response": {
Kevin Moore1d80b062021-01-27 12:01:41 -0800367 "$ref": "ListPhotosResponse"
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200368 },
369 "scopes": [
370 "https://www.googleapis.com/auth/streetviewpublish"
371 ]
Martin Kustermann12cdd522018-08-27 10:46:50 +0200372 }
373 }
Martin Kustermann8c5bbda2017-07-10 13:23:47 +0200374 }
375 },
Kevin Moore9f833c52021-06-22 15:37:16 -0700376 "revision": "20210621",
Martin Kustermann8c5bbda2017-07-10 13:23:47 +0200377 "rootUrl": "https://streetviewpublish.googleapis.com/",
378 "schemas": {
Kevin Moore1d80b062021-01-27 12:01:41 -0800379 "BatchDeletePhotosRequest": {
380 "description": "Request to delete multiple Photos.",
381 "id": "BatchDeletePhotosRequest",
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200382 "properties": {
Kevin Moore1d80b062021-01-27 12:01:41 -0800383 "photoIds": {
384 "description": "Required. IDs of the Photos. HTTP GET requests require the following syntax for the URL query parameter: `photoIds=&photoIds=&...`.",
385 "items": {
386 "type": "string"
387 },
388 "type": "array"
389 }
390 },
391 "type": "object"
392 },
393 "BatchDeletePhotosResponse": {
394 "description": "Response to batch delete of one or more Photos.",
395 "id": "BatchDeletePhotosResponse",
396 "properties": {
397 "status": {
398 "description": "The status for the operation to delete a single Photo in the batch request.",
399 "items": {
400 "$ref": "Status"
401 },
402 "type": "array"
403 }
404 },
405 "type": "object"
406 },
407 "BatchGetPhotosResponse": {
408 "description": "Response to batch get of Photos.",
409 "id": "BatchGetPhotosResponse",
410 "properties": {
411 "results": {
412 "description": "List of results for each individual Photo requested, in the same order as the requests in BatchGetPhotos.",
413 "items": {
414 "$ref": "PhotoResponse"
415 },
416 "type": "array"
417 }
418 },
419 "type": "object"
420 },
421 "BatchUpdatePhotosRequest": {
422 "description": "Request to update the metadata of photos. Updating the pixels of photos is not supported.",
423 "id": "BatchUpdatePhotosRequest",
424 "properties": {
425 "updatePhotoRequests": {
426 "description": "Required. List of UpdatePhotoRequests.",
427 "items": {
428 "$ref": "UpdatePhotoRequest"
429 },
430 "type": "array"
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200431 }
432 },
433 "type": "object"
434 },
435 "BatchUpdatePhotosResponse": {
436 "description": "Response to batch update of metadata of one or more Photos.",
437 "id": "BatchUpdatePhotosResponse",
438 "properties": {
439 "results": {
440 "description": "List of results for each individual Photo updated, in the same order as the request.",
441 "items": {
442 "$ref": "PhotoResponse"
443 },
444 "type": "array"
445 }
446 },
447 "type": "object"
448 },
449 "Connection": {
450 "description": "A connection is the link from a source photo to a destination photo.",
451 "id": "Connection",
452 "properties": {
453 "target": {
454 "$ref": "PhotoId",
455 "description": "Required. The destination of the connection from the containing photo to another photo."
456 }
457 },
458 "type": "object"
459 },
Kevin Moore1d80b062021-01-27 12:01:41 -0800460 "Empty": {
461 "description": "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 `{}`.",
462 "id": "Empty",
463 "properties": {},
464 "type": "object"
465 },
466 "LatLng": {
Kevin Moore32d60fa2021-04-25 17:33:47 -0700467 "description": "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 object must conform to the WGS84 standard. Values must be within normalized ranges.",
Kevin Moore1d80b062021-01-27 12:01:41 -0800468 "id": "LatLng",
469 "properties": {
470 "latitude": {
471 "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
472 "format": "double",
473 "type": "number"
474 },
475 "longitude": {
476 "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
477 "format": "double",
478 "type": "number"
479 }
480 },
481 "type": "object"
482 },
483 "Level": {
484 "description": "Level information containing level number and its corresponding name.",
485 "id": "Level",
486 "properties": {
487 "name": {
488 "description": "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.",
489 "type": "string"
490 },
491 "number": {
492 "description": "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.",
493 "format": "double",
494 "type": "number"
495 }
496 },
497 "type": "object"
498 },
499 "ListPhotosResponse": {
500 "description": "Response to list all photos that belong to a user.",
501 "id": "ListPhotosResponse",
502 "properties": {
503 "nextPageToken": {
504 "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
505 "type": "string"
506 },
507 "photos": {
508 "description": "List of photos. The pageSize field in the request determines the number of items returned.",
509 "items": {
510 "$ref": "Photo"
511 },
512 "type": "array"
513 }
514 },
515 "type": "object"
516 },
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200517 "Operation": {
518 "description": "This resource represents a long-running operation that is the result of a network API call.",
519 "id": "Operation",
520 "properties": {
Kevin Moore1d80b062021-01-27 12:01:41 -0800521 "done": {
522 "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
523 "type": "boolean"
524 },
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200525 "error": {
526 "$ref": "Status",
527 "description": "The error result of the operation in case of failure or cancellation."
528 },
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200529 "metadata": {
530 "additionalProperties": {
531 "description": "Properties of the object. Contains field @type with type URL.",
532 "type": "any"
533 },
534 "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
535 "type": "object"
536 },
Kevin Moore1d80b062021-01-27 12:01:41 -0800537 "name": {
538 "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200539 "type": "string"
540 },
Kevin Moore1d80b062021-01-27 12:01:41 -0800541 "response": {
542 "additionalProperties": {
543 "description": "Properties of the object. Contains field @type with type URL.",
544 "type": "any"
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200545 },
Kevin Moore1d80b062021-01-27 12:01:41 -0800546 "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
547 "type": "object"
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200548 }
549 },
550 "type": "object"
551 },
552 "Photo": {
553 "description": "Photo is used to store 360 photos along with photo metadata.",
554 "id": "Photo",
555 "properties": {
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200556 "captureTime": {
557 "description": "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.",
558 "format": "google-datetime",
559 "type": "string"
560 },
561 "connections": {
562 "description": "Connections to other photos. A connection represents the link from this photo to another photo.",
563 "items": {
564 "$ref": "Connection"
565 },
566 "type": "array"
567 },
568 "downloadUrl": {
569 "description": "Output only. The download URL for the photo bytes. This field is set only when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL.",
570 "type": "string"
571 },
Kevin Moore1d80b062021-01-27 12:01:41 -0800572 "mapsPublishStatus": {
573 "description": "Output only. Status in Google Maps, whether this photo was published or rejected. Not currently populated.",
574 "enum": [
575 "UNSPECIFIED_MAPS_PUBLISH_STATUS",
576 "PUBLISHED",
577 "REJECTED_UNKNOWN"
578 ],
579 "enumDescriptions": [
580 "The status of the photo is unknown.",
581 "The photo is published to the public through Google Maps.",
582 "The photo has been rejected for an unknown reason."
583 ],
584 "type": "string"
585 },
586 "photoId": {
587 "$ref": "PhotoId",
588 "description": "Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google."
589 },
590 "places": {
591 "description": "Places where this photo belongs.",
592 "items": {
593 "$ref": "Place"
594 },
595 "type": "array"
596 },
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200597 "pose": {
598 "$ref": "Pose",
599 "description": "Pose of the photo."
600 },
Kevin Moore1d80b062021-01-27 12:01:41 -0800601 "shareLink": {
602 "description": "Output only. The share link for the photo.",
603 "type": "string"
604 },
605 "thumbnailUrl": {
606 "description": "Output only. The thumbnail URL for showing a preview of the given photo.",
607 "type": "string"
608 },
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200609 "transferStatus": {
610 "description": "Output only. Status of rights transfer on this photo.",
611 "enum": [
612 "TRANSFER_STATUS_UNKNOWN",
613 "NEVER_TRANSFERRED",
614 "PENDING",
615 "COMPLETED",
616 "REJECTED",
617 "EXPIRED",
618 "CANCELLED",
619 "RECEIVED_VIA_TRANSFER"
620 ],
621 "enumDescriptions": [
622 "The status of this transfer is unspecified.",
623 "This photo has never been in a transfer.",
624 "This photo transfer has been initiated, but the receiver has not yet responded.",
625 "The photo transfer has been completed, and this photo has been transferred to the recipient.",
626 "The recipient rejected this photo transfer.",
627 "The photo transfer expired before the recipient took any action.",
628 "The sender cancelled this photo transfer.",
629 "The recipient owns this photo due to a rights transfer."
630 ],
631 "type": "string"
632 },
Kevin Moore1d80b062021-01-27 12:01:41 -0800633 "uploadReference": {
634 "$ref": "UploadRef",
635 "description": "Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to."
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200636 },
637 "viewCount": {
638 "description": "Output only. View count of the photo.",
639 "format": "int64",
640 "type": "string"
Jonas Finnemann Jensenb29f5c92020-10-09 10:57:19 +0200641 }
642 },
643 "type": "object"
644 },
645 "PhotoId": {
646 "description": "Identifier for a Photo.",
647 "id": "PhotoId",
648 "properties": {
649 "id": {
650 "description": "Required. A unique identifier for a photo.",
651 "type": "string"
652 }
653 },
654 "type": "object"
655 },
Kevin Moore1d80b062021-01-27 12:01:41 -0800656 "PhotoResponse": {
657 "description": "Response payload for a single Photo in batch operations including BatchGetPhotos and BatchUpdatePhotos.",
658 "id": "PhotoResponse",
659 "properties": {
660 "photo": {
661 "$ref": "Photo",
662 "description": "The Photo resource, if the request was successful."
663 },
664 "status": {
665 "$ref": "Status",
666 "description": "The status for the operation to get or update a single photo in the batch request."
667 }
668 },
669 "type": "object"
670 },
671 "Place": {
672 "description": "Place metadata for an entity.",
673 "id": "Place",
674 "properties": {
675 "languageCode": {
676 "description": "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.",
677 "type": "string"
678 },
679 "name": {
680 "description": "Output-only. The name of the place, localized to the language_code.",
681 "type": "string"
682 },
683 "placeId": {
684 "description": "Place identifier, as described in https://developers.google.com/places/place-id.",
685 "type": "string"
686 }
687 },
688 "type": "object"
689 },
690 "Pose": {
691 "description": "Raw pose measurement for an entity.",
692 "id": "Pose",
693 "properties": {
694 "accuracyMeters": {
695 "description": "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.",
696 "format": "float",
697 "type": "number"
698 },
699 "altitude": {
700 "description": "Altitude of the pose in meters above WGS84 ellipsoid. NaN indicates an unmeasured quantity.",
701 "format": "double",
702 "type": "number"
703 },
704 "heading": {
705 "description": "Compass heading, measured at the center of the photo in degrees clockwise from North. Value must be >=0 and <360. NaN indicates an unmeasured quantity.",
706 "format": "double",
707 "type": "number"
708 },
709 "latLngPair": {
710 "$ref": "LatLng",
711 "description": "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."
712 },
713 "level": {
714 "$ref": "Level",
715 "description": "Level (the floor in a building) used to configure vertical navigation."
716 },
717 "pitch": {
718 "description": "Pitch, measured at the center of the photo in degrees. Value must be >=-90 and <= 90. A value of -90 means looking directly down, and a value of 90 means looking directly up. NaN indicates an unmeasured quantity.",
719 "format": "double",
720 "type": "number"
721 },
722 "roll": {
723 "description": "Roll, measured in degrees. Value must be >= 0 and <360. A value of 0 means level with the horizon. NaN indicates an unmeasured quantity.",
724 "format": "double",
725 "type": "number"
726 }
727 },
728 "type": "object"
729 },
Jonas Finnemann Jensenef0c8a32020-10-07 20:58:20 +0200730 "Status": {
731 "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
732 "id": "Status",
733 "properties": {
734 "code": {
735 "description": "The status code, which should be an enum value of google.rpc.Code.",
736 "format": "int32",
737 "type": "integer"
738 },
739 "details": {
740 "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
741 "items": {
742 "additionalProperties": {
743 "description": "Properties of the object. Contains field @type with type URL.",
744 "type": "any"
745 },
746 "type": "object"
747 },
748 "type": "array"
749 },
750 "message": {
751 "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
752 "type": "string"
753 }
754 },
755 "type": "object"
Kevin Moore1d80b062021-01-27 12:01:41 -0800756 },
757 "UpdatePhotoRequest": {
758 "description": "Request to update the metadata of a Photo. Updating the pixels of a photo is not supported.",
759 "id": "UpdatePhotoRequest",
760 "properties": {
761 "photo": {
762 "$ref": "Photo",
763 "description": "Required. Photo object containing the new metadata."
764 },
765 "updateMask": {
766 "description": "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.",
767 "format": "google-fieldmask",
768 "type": "string"
769 }
770 },
771 "type": "object"
772 },
773 "UploadRef": {
774 "description": "Upload reference for media files.",
775 "id": "UploadRef",
776 "properties": {
777 "uploadUrl": {
Kevin Moore44bb6052021-01-27 12:34:41 -0800778 "description": "An upload reference should be unique for each user. It follows the form: \"https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}\"",
Kevin Moore1d80b062021-01-27 12:01:41 -0800779 "type": "string"
780 }
781 },
782 "type": "object"
Martin Kustermann8c5bbda2017-07-10 13:23:47 +0200783 }
784 },
785 "servicePath": "",
786 "title": "Street View Publish API",
Martin Kustermann12cdd522018-08-27 10:46:50 +0200787 "version": "v1",
788 "version_module": true
Martin Kustermann8c5bbda2017-07-10 13:23:47 +0200789}