/
streetviewpublish.v1.json
1329 lines (1329 loc) 路 59 KB
/
streetviewpublish.v1.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/streetviewpublish": {
"description": "Publish and manage your 360 photos on Google Street View"
}
}
}
},
"basePath": "",
"baseUrl": "https://streetviewpublish.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Street View Publish",
"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. ",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/streetview/publish/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "streetviewpublish:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://streetviewpublish.mtls.googleapis.com/",
"name": "streetviewpublish",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"photo": {
"methods": {
"create": {
"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.",
"flatPath": "v1/photo",
"httpMethod": "POST",
"id": "streetviewpublish.photo.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/photo",
"request": {
"$ref": "Photo"
},
"response": {
"$ref": "Photo"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
},
"delete": {
"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.",
"flatPath": "v1/photo/{photoId}",
"httpMethod": "DELETE",
"id": "streetviewpublish.photo.delete",
"parameterOrder": [
"photoId"
],
"parameters": {
"photoId": {
"description": "Required. ID of the Photo.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/photo/{photoId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
},
"get": {
"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.",
"flatPath": "v1/photo/{photoId}",
"httpMethod": "GET",
"id": "streetviewpublish.photo.get",
"parameterOrder": [
"photoId"
],
"parameters": {
"languageCode": {
"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.",
"location": "query",
"type": "string"
},
"photoId": {
"description": "Required. ID of the Photo.",
"location": "path",
"required": true,
"type": "string"
},
"view": {
"description": "Required. Specifies if a download URL for the photo bytes should be returned in the Photo response.",
"enum": [
"BASIC",
"INCLUDE_DOWNLOAD_URL"
],
"enumDescriptions": [
"Server responses do not include the download URL for the photo bytes. The default value.",
"Server responses include the download URL for the photo bytes."
],
"location": "query",
"type": "string"
}
},
"path": "v1/photo/{photoId}",
"response": {
"$ref": "Photo"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
},
"startUpload": {
"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.",
"flatPath": "v1/photo:startUpload",
"httpMethod": "POST",
"id": "streetviewpublish.photo.startUpload",
"parameterOrder": [],
"parameters": {},
"path": "v1/photo:startUpload",
"request": {
"$ref": "Empty"
},
"response": {
"$ref": "UploadRef"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
},
"update": {
"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.",
"flatPath": "v1/photo/{id}",
"httpMethod": "PUT",
"id": "streetviewpublish.photo.update",
"parameterOrder": [
"id"
],
"parameters": {
"id": {
"description": "A unique identifier for a photo.",
"location": "path",
"required": true,
"type": "string"
},
"updateMask": {
"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.lat_lng_pair` * `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.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/photo/{id}",
"request": {
"$ref": "Photo"
},
"response": {
"$ref": "Photo"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
}
}
},
"photoSequence": {
"methods": {
"create": {
"description": "After the client finishes uploading the PhotoSequence with the returned UploadRef, CreatePhotoSequence extracts a sequence of 360 photos from a video or Extensible Device Metadata (XDM, http://www.xdm.org/) to be published to Street View on Google Maps. `CreatePhotoSequence` returns an Operation, with the PhotoSequence Id set in the `Operation.name` field. This method returns the following error codes: * google.rpc.Code.INVALID_ARGUMENT if the request is malformed. * google.rpc.Code.NOT_FOUND if the upload reference does not exist.",
"flatPath": "v1/photoSequence",
"httpMethod": "POST",
"id": "streetviewpublish.photoSequence.create",
"parameterOrder": [],
"parameters": {
"inputType": {
"description": "Required. The input form of PhotoSequence.",
"enum": [
"INPUT_TYPE_UNSPECIFIED",
"VIDEO",
"XDM"
],
"enumDescriptions": [
"Not specified. Server will return google.rpc.Code.INVALID_ARGUMENT.",
"360 Video.",
"Extensible Device Metadata, http://www.xdm.org"
],
"location": "query",
"type": "string"
}
},
"path": "v1/photoSequence",
"request": {
"$ref": "PhotoSequence"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
},
"delete": {
"description": "Deletes a PhotoSequence 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 sequence. * google.rpc.Code.NOT_FOUND if the photo sequence ID does not exist. * google.rpc.Code.FAILED_PRECONDITION if the photo sequence ID is not yet finished processing.",
"flatPath": "v1/photoSequence/{sequenceId}",
"httpMethod": "DELETE",
"id": "streetviewpublish.photoSequence.delete",
"parameterOrder": [
"sequenceId"
],
"parameters": {
"sequenceId": {
"description": "Required. ID of the PhotoSequence.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/photoSequence/{sequenceId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
},
"get": {
"description": "Gets the metadata of the specified PhotoSequence via the Operation interface. This method returns the following three types of responses: * `Operation.done` = false, if the processing of PhotoSequence is not finished yet. * `Operation.done` = true and `Operation.error` is populated, if there was an error in processing. * `Operation.done` = true and `Operation.response` is poulated, which contains a PhotoSequence message. This method returns the following error codes: * google.rpc.Code.PERMISSION_DENIED if the requesting user did not create the requested PhotoSequence. * google.rpc.Code.NOT_FOUND if the requested PhotoSequence does not exist.",
"flatPath": "v1/photoSequence/{sequenceId}",
"httpMethod": "GET",
"id": "streetviewpublish.photoSequence.get",
"parameterOrder": [
"sequenceId"
],
"parameters": {
"filter": {
"description": "Optional. The filter expression. For example: `published_status=PUBLISHED`. The filters supported are: `published_status`. See https://google.aip.dev/160 for more information.",
"location": "query",
"type": "string"
},
"sequenceId": {
"description": "Required. ID of the photo sequence.",
"location": "path",
"required": true,
"type": "string"
},
"view": {
"deprecated": true,
"description": "Specifies if a download URL for the photo sequence should be returned in `download_url` of individual photos in the PhotoSequence response. > Note: Currently not implemented.",
"enum": [
"BASIC",
"INCLUDE_DOWNLOAD_URL"
],
"enumDescriptions": [
"Server responses do not include the download URL for the photo bytes. The default value.",
"Server responses include the download URL for the photo bytes."
],
"location": "query",
"type": "string"
}
},
"path": "v1/photoSequence/{sequenceId}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
},
"startUpload": {
"description": "Creates an upload session to start uploading photo sequence data. The upload URL of the returned UploadRef is used to upload the data for the `photoSequence`. After the upload is complete, the UploadRef is used with CreatePhotoSequence to create the PhotoSequence object entry.",
"flatPath": "v1/photoSequence:startUpload",
"httpMethod": "POST",
"id": "streetviewpublish.photoSequence.startUpload",
"parameterOrder": [],
"parameters": {},
"path": "v1/photoSequence:startUpload",
"request": {
"$ref": "Empty"
},
"response": {
"$ref": "UploadRef"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
}
}
},
"photoSequences": {
"methods": {
"list": {
"description": "Lists all the PhotoSequences that belong to the user, in descending CreatePhotoSequence timestamp order.",
"flatPath": "v1/photoSequences",
"httpMethod": "GET",
"id": "streetviewpublish.photoSequences.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "Optional. The filter expression. For example: `imagery_type=SPHERICAL`. The filters supported are: `imagery_type`, `processing_state`, `min_latitude`, `max_latitude`, `min_longitude`, `max_longitude`, and `filename_query`. See https://google.aip.dev/160 for more information. Filename queries should sent as a Phrase in order to support multple words and special characters by adding escaped quotes. Ex: filename_query=\"example of a phrase.mp4\"",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of photo sequences 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 photo sequences returned in the response may be less than `pageSize` if the number of matches is less than `pageSize`. This is currently unimplemented but is in process.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The nextPageToken value returned from a previous ListPhotoSequences request, if any.",
"location": "query",
"type": "string"
}
},
"path": "v1/photoSequences",
"response": {
"$ref": "ListPhotoSequencesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
}
}
},
"photos": {
"methods": {
"batchDelete": {
"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.",
"flatPath": "v1/photos:batchDelete",
"httpMethod": "POST",
"id": "streetviewpublish.photos.batchDelete",
"parameterOrder": [],
"parameters": {},
"path": "v1/photos:batchDelete",
"request": {
"$ref": "BatchDeletePhotosRequest"
},
"response": {
"$ref": "BatchDeletePhotosResponse"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
},
"batchGet": {
"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.",
"flatPath": "v1/photos:batchGet",
"httpMethod": "GET",
"id": "streetviewpublish.photos.batchGet",
"parameterOrder": [],
"parameters": {
"languageCode": {
"description": "Optional. 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.",
"location": "query",
"type": "string"
},
"photoIds": {
"description": "Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be `photoIds=&photoIds=&...`.",
"location": "query",
"repeated": true,
"type": "string"
},
"view": {
"description": "Required. Specifies if a download URL for the photo bytes should be returned in the Photo response.",
"enum": [
"BASIC",
"INCLUDE_DOWNLOAD_URL"
],
"enumDescriptions": [
"Server responses do not include the download URL for the photo bytes. The default value.",
"Server responses include the download URL for the photo bytes."
],
"location": "query",
"type": "string"
}
},
"path": "v1/photos:batchGet",
"response": {
"$ref": "BatchGetPhotosResponse"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
},
"batchUpdate": {
"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.",
"flatPath": "v1/photos:batchUpdate",
"httpMethod": "POST",
"id": "streetviewpublish.photos.batchUpdate",
"parameterOrder": [],
"parameters": {},
"path": "v1/photos:batchUpdate",
"request": {
"$ref": "BatchUpdatePhotosRequest"
},
"response": {
"$ref": "BatchUpdatePhotosResponse"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
},
"list": {
"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.",
"flatPath": "v1/photos",
"httpMethod": "GET",
"id": "streetviewpublish.photos.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "Optional. The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`. The filters supported are: `placeId`, `min_latitude`, `max_latitude`, `min_longitude`, `max_longitude`, 'min_capture_time_seconds', and 'max_capture_time_seconds'. See https://google.aip.dev/160 for more information.",
"location": "query",
"type": "string"
},
"languageCode": {
"description": "Optional. 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.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. 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`.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The nextPageToken value returned from a previous ListPhotos request, if any.",
"location": "query",
"type": "string"
},
"view": {
"description": "Required. Specifies if a download URL for the photos bytes should be returned in the Photos response.",
"enum": [
"BASIC",
"INCLUDE_DOWNLOAD_URL"
],
"enumDescriptions": [
"Server responses do not include the download URL for the photo bytes. The default value.",
"Server responses include the download URL for the photo bytes."
],
"location": "query",
"type": "string"
}
},
"path": "v1/photos",
"response": {
"$ref": "ListPhotosResponse"
},
"scopes": [
"https://www.googleapis.com/auth/streetviewpublish"
]
}
}
}
},
"revision": "20230522",
"rootUrl": "https://streetviewpublish.googleapis.com/",
"schemas": {
"BatchDeletePhotosRequest": {
"description": "Request to delete multiple Photos.",
"id": "BatchDeletePhotosRequest",
"properties": {
"photoIds": {
"description": "Required. IDs of the Photos. HTTP GET requests require the following syntax for the URL query parameter: `photoIds=&photoIds=&...`.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BatchDeletePhotosResponse": {
"description": "Response to batch delete of one or more Photos.",
"id": "BatchDeletePhotosResponse",
"properties": {
"status": {
"description": "The status for the operation to delete a single Photo in the batch request.",
"items": {
"$ref": "Status"
},
"type": "array"
}
},
"type": "object"
},
"BatchGetPhotosResponse": {
"description": "Response to batch get of Photos.",
"id": "BatchGetPhotosResponse",
"properties": {
"results": {
"description": "List of results for each individual Photo requested, in the same order as the requests in BatchGetPhotos.",
"items": {
"$ref": "PhotoResponse"
},
"type": "array"
}
},
"type": "object"
},
"BatchUpdatePhotosRequest": {
"description": "Request to update the metadata of photos. Updating the pixels of photos is not supported.",
"id": "BatchUpdatePhotosRequest",
"properties": {
"updatePhotoRequests": {
"description": "Required. List of UpdatePhotoRequests.",
"items": {
"$ref": "UpdatePhotoRequest"
},
"type": "array"
}
},
"type": "object"
},
"BatchUpdatePhotosResponse": {
"description": "Response to batch update of metadata of one or more Photos.",
"id": "BatchUpdatePhotosResponse",
"properties": {
"results": {
"description": "List of results for each individual Photo updated, in the same order as the request.",
"items": {
"$ref": "PhotoResponse"
},
"type": "array"
}
},
"type": "object"
},
"Connection": {
"description": "A connection is the link from a source photo to a destination photo.",
"id": "Connection",
"properties": {
"target": {
"$ref": "PhotoId",
"description": "Required. The destination of the connection from the containing photo to another photo."
}
},
"type": "object"
},
"Empty": {
"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); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"GpsDataGapFailureDetails": {
"description": "Details related to ProcessingFailureReason#GPS_DATA_GAP. If there are multiple GPS data gaps, only the one with the largest duration is reported here.",
"id": "GpsDataGapFailureDetails",
"properties": {
"gapDuration": {
"description": "The duration of the gap in GPS data that was found.",
"format": "google-duration",
"type": "string"
},
"gapStartTime": {
"description": "Relative time (from the start of the video stream) when the gap started.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"Imu": {
"description": "IMU data from the device sensors.",
"id": "Imu",
"properties": {
"accelMpsps": {
"description": "The accelerometer measurements in meters/sec^2 with increasing timestamps from devices.",
"items": {
"$ref": "Measurement3d"
},
"type": "array"
},
"gyroRps": {
"description": "The gyroscope measurements in radians/sec with increasing timestamps from devices.",
"items": {
"$ref": "Measurement3d"
},
"type": "array"
},
"magUt": {
"description": "The magnetometer measurements of the magnetic field in microtesla (uT) with increasing timestamps from devices.",
"items": {
"$ref": "Measurement3d"
},
"type": "array"
}
},
"type": "object"
},
"ImuDataGapFailureDetails": {
"description": "Details related to ProcessingFailureReason#IMU_DATA_GAP. If there are multiple IMU data gaps, only the one with the largest duration is reported here.",
"id": "ImuDataGapFailureDetails",
"properties": {
"gapDuration": {
"description": "The duration of the gap in IMU data that was found.",
"format": "google-duration",
"type": "string"
},
"gapStartTime": {
"description": "Relative time (from the start of the video stream) when the gap started.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"InsufficientGpsFailureDetails": {
"description": "Details related to ProcessingFailureReason#INSUFFICIENT_GPS.",
"id": "InsufficientGpsFailureDetails",
"properties": {
"gpsPointsFound": {
"description": "The number of GPS points that were found in the video.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"LatLng": {
"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.",
"id": "LatLng",
"properties": {
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"format": "double",
"type": "number"
},
"longitude": {
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"LatLngBounds": {
"description": "A rectangle in geographical coordinates.",
"id": "LatLngBounds",
"properties": {
"northeast": {
"$ref": "LatLng",
"description": "The northeast corner of these bounds."
},
"southwest": {
"$ref": "LatLng",
"description": "The southwest corner of these bounds."
}
},
"type": "object"
},
"Level": {
"description": "Level information containing level number and its corresponding name.",
"id": "Level",
"properties": {
"name": {
"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.",
"type": "string"
},
"number": {
"description": "Optional. 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.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"ListPhotoSequencesResponse": {
"description": "Response to list all photo sequences that belong to a user.",
"id": "ListPhotoSequencesResponse",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"photoSequences": {
"description": "List of photo sequences via Operation interface. The maximum number of items returned is based on the pageSize field in the request. Each item in the list can have three possible states, * `Operation.done` = false, if the processing of PhotoSequence is not finished yet. * `Operation.done` = true and `Operation.error` is populated, if there was an error in processing. * `Operation.done` = true and `Operation.response` contains a PhotoSequence message, In each sequence, only Id is populated.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"type": "object"
},
"ListPhotosResponse": {
"description": "Response to list all photos that belong to a user.",
"id": "ListPhotosResponse",
"properties": {
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
"type": "string"
},
"photos": {
"description": "List of photos. The pageSize field in the request determines the number of items returned.",
"items": {
"$ref": "Photo"
},
"type": "array"
}
},
"type": "object"
},
"Measurement3d": {
"description": "A Generic 3d measurement sample.",
"id": "Measurement3d",
"properties": {
"captureTime": {
"description": "The timestamp of the IMU measurement.",
"format": "google-datetime",
"type": "string"
},
"x": {
"description": "The sensor measurement in the x axis.",
"format": "float",
"type": "number"
},
"y": {
"description": "The sensor measurement in the y axis.",
"format": "float",
"type": "number"
},
"z": {
"description": "The sensor measurement in the z axis.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"NoOverlapGpsFailureDetails": {
"description": "Details related to PhotoSequenceProcessingFailureReason#NO_OVERLAP_GPS.",
"id": "NoOverlapGpsFailureDetails",
"properties": {
"gpsEndTime": {
"description": "Time of last recorded GPS point.",
"format": "google-datetime",
"type": "string"
},
"gpsStartTime": {
"description": "Time of first recorded GPS point.",
"format": "google-datetime",
"type": "string"
},
"videoEndTime": {
"description": "End time of video.",
"format": "google-datetime",
"type": "string"
},
"videoStartTime": {
"description": "Start time of video.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"NotOutdoorsFailureDetails": {
"description": "Details related to ProcessingFailureReason#NOT_OUTDOORS. If there are multiple indoor frames found, the first frame is recorded here.",
"id": "NotOutdoorsFailureDetails",
"properties": {
"startTime": {
"description": "Relative time (from the start of the video stream) when an indoor frame was found.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"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.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"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.",
"type": "object"
},
"name": {
"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}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"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`.",
"type": "object"
}
},
"type": "object"
},
"Photo": {
"description": "Photo is used to store 360 photos along with photo metadata.",
"id": "Photo",
"properties": {
"captureTime": {
"description": "Optional. 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.",
"format": "google-datetime",
"type": "string"
},
"connections": {
"description": "Optional. Connections to other photos. A connection represents the link from this photo to another photo.",
"items": {
"$ref": "Connection"
},
"type": "array"
},
"downloadUrl": {
"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.",
"readOnly": true,
"type": "string"
},
"mapsPublishStatus": {
"description": "Output only. Status in Google Maps, whether this photo was published or rejected.",
"enum": [
"UNSPECIFIED_MAPS_PUBLISH_STATUS",
"PUBLISHED",
"REJECTED_UNKNOWN"
],
"enumDescriptions": [
"The status of the photo is unknown.",
"The photo is published to the public through Google Maps.",
"The photo has been rejected for an unknown reason."
],
"readOnly": true,
"type": "string"
},
"photoId": {
"$ref": "PhotoId",
"description": "Required. Output only. Required when updating a photo. Output only when creating a photo. Identifier for the photo, which is unique among all photos in Google.",
"readOnly": true
},
"places": {
"description": "Optional. Places where this photo belongs.",
"items": {
"$ref": "Place"
},
"type": "array"
},
"pose": {
"$ref": "Pose",
"description": "Optional. Pose of the photo."
},
"shareLink": {
"description": "Output only. The share link for the photo.",
"readOnly": true,
"type": "string"
},
"thumbnailUrl": {
"description": "Output only. The thumbnail URL for showing a preview of the given photo.",
"readOnly": true,
"type": "string"
},
"transferStatus": {
"description": "Output only. Status of rights transfer on this photo.",
"enum": [
"TRANSFER_STATUS_UNKNOWN",
"NEVER_TRANSFERRED",
"PENDING",
"COMPLETED",
"REJECTED",
"EXPIRED",
"CANCELLED",
"RECEIVED_VIA_TRANSFER"
],
"enumDescriptions": [
"The status of this transfer is unspecified.",
"This photo has never been in a transfer.",
"This photo transfer has been initiated, but the receiver has not yet responded.",
"The photo transfer has been completed, and this photo has been transferred to the recipient.",
"The recipient rejected this photo transfer.",
"The photo transfer expired before the recipient took any action.",
"The sender cancelled this photo transfer.",
"The recipient owns this photo due to a rights transfer."
],
"readOnly": true,
"type": "string"
},
"uploadReference": {
"$ref": "UploadRef",
"description": "Input only. Required when creating a photo. Input only. The resource URL where the photo bytes are uploaded to."
},
"uploadTime": {
"description": "Output only. Time when the image was uploaded.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"viewCount": {
"description": "Output only. View count of the photo.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PhotoId": {
"description": "Identifier for a Photo.",
"id": "PhotoId",
"properties": {
"id": {
"description": "A unique identifier for a photo.",
"type": "string"
}
},