-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathgoogle-maps.yaml
More file actions
1264 lines (1264 loc) · 71.8 KB
/
google-maps.yaml
File metadata and controls
1264 lines (1264 loc) · 71.8 KB
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
openapi: 3.0.0
servers:
- url: https://places.googleapis.com/
info:
contact:
name: Google
url: https://google.com
x-twitter: youtube
description: ""
license:
name: Creative Commons Attribution 3.0
url: http://creativecommons.org/licenses/by/3.0/
termsOfService: https://developers.google.com/terms/
title: Places API (New)
version: v1
x-apisguru-categories:
- analytics
- media
x-logo:
url: https://upload.wikimedia.org/wikipedia/commons/e/e1/YouTube_play_buttom_icon_%282013-2017%29.svg
x-origin:
- format: google
url: https://places.googleapis.com/$discovery/rest?version=v1
version: v1
x-providerName: googleapis.com
x-serviceName: places
externalDocs:
url: https://mapsplatform.google.com/maps-products/#places-section
tags:
- name: places
paths:
/v1/places:autocomplete:
parameters:
- $ref: "#/components/parameters/_.xgafv"
- $ref: "#/components/parameters/access_token"
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/callback"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/upload_protocol"
- $ref: "#/components/parameters/uploadType"
post:
description: Returns predictions for the given input.
operationId: places.places.autocomplete
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequest"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponse"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
- Oauth2:
- https://www.googleapis.com/auth/maps-platform.places
Oauth2c:
- https://www.googleapis.com/auth/maps-platform.places
- Oauth2:
- https://www.googleapis.com/auth/maps-platform.places.autocomplete
Oauth2c:
- https://www.googleapis.com/auth/maps-platform.places.autocomplete
tags:
- places
/v1/places:searchNearby:
parameters:
- $ref: "#/components/parameters/_.xgafv"
- $ref: "#/components/parameters/access_token"
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/callback"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/upload_protocol"
- $ref: "#/components/parameters/uploadType"
post:
description: Search for places near locations.
operationId: places.places.searchNearby
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GoogleMapsPlacesV1SearchNearbyRequest"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GoogleMapsPlacesV1SearchNearbyResponse"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
- Oauth2:
- https://www.googleapis.com/auth/maps-platform.places
Oauth2c:
- https://www.googleapis.com/auth/maps-platform.places
- Oauth2:
- https://www.googleapis.com/auth/maps-platform.places.nearbysearch
Oauth2c:
- https://www.googleapis.com/auth/maps-platform.places.nearbysearch
tags:
- places
/v1/places:searchText:
parameters:
- $ref: "#/components/parameters/_.xgafv"
- $ref: "#/components/parameters/access_token"
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/callback"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/upload_protocol"
- $ref: "#/components/parameters/uploadType"
post:
description: Text query based place search.
operationId: places.places.searchText
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GoogleMapsPlacesV1SearchTextRequest"
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GoogleMapsPlacesV1SearchTextResponse"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
- Oauth2:
- https://www.googleapis.com/auth/maps-platform.places
Oauth2c:
- https://www.googleapis.com/auth/maps-platform.places
- Oauth2:
- https://www.googleapis.com/auth/maps-platform.places.textsearch
Oauth2c:
- https://www.googleapis.com/auth/maps-platform.places.textsearch
tags:
- places
/v1/{name}:
get:
description: Get a photo media with a photo reference string.
operationId: places.places.photos.getMedia
parameters:
- description: "Required. The resource name of a photo media in the format: `places/{place_id}/photos/{photo_reference}/media`. The resource name of a photo as returned in a Place object's `photos.name` field comes with the format `places/{place_id}/photos/{photo_reference}`. You need to append `/media` at the end of the photo resource to get the photo media resource name."
in: path
name: name
required: true
schema:
type: string
- description: Optional. Specifies the maximum desired height, in pixels, of the image. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the max_height_px and max_width_px properties accept an integer between 1 and 4800, inclusively. If the value is not within the allowed range, an INVALID_ARGUMENT error will be returned. At least one of max_height_px or max_width_px needs to be specified. If neither max_height_px nor max_width_px is specified, an INVALID_ARGUMENT error will be returned.
in: query
name: maxHeightPx
schema:
type: integer
- description: Optional. Specifies the maximum desired width, in pixels, of the image. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the max_height_px and max_width_px properties accept an integer between 1 and 4800, inclusively. If the value is not within the allowed range, an INVALID_ARGUMENT error will be returned. At least one of max_height_px or max_width_px needs to be specified. If neither max_height_px nor max_width_px is specified, an INVALID_ARGUMENT error will be returned.
in: query
name: maxWidthPx
schema:
type: integer
- description: Optional. If set, skip the default HTTP redirect behavior and render a text format (for example, in JSON format for HTTP use case) response. If not set, an HTTP redirect will be issued to redirect the call to the image media. This option is ignored for non-HTTP requests.
in: query
name: skipHttpRedirect
schema:
type: boolean
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GoogleMapsPlacesV1PhotoMedia"
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
- Oauth2:
- https://www.googleapis.com/auth/maps-platform.places
Oauth2c:
- https://www.googleapis.com/auth/maps-platform.places
- Oauth2:
- https://www.googleapis.com/auth/maps-platform.places.details
Oauth2c:
- https://www.googleapis.com/auth/maps-platform.places.details
tags:
- places
parameters:
- $ref: "#/components/parameters/_.xgafv"
- $ref: "#/components/parameters/access_token"
- $ref: "#/components/parameters/alt"
- $ref: "#/components/parameters/callback"
- $ref: "#/components/parameters/fields"
- $ref: "#/components/parameters/key"
- $ref: "#/components/parameters/oauth_token"
- $ref: "#/components/parameters/prettyPrint"
- $ref: "#/components/parameters/quotaUser"
- $ref: "#/components/parameters/upload_protocol"
- $ref: "#/components/parameters/uploadType"
components:
parameters:
_.xgafv:
description: V1 error format.
in: query
name: $.xgafv
schema:
enum:
- "1"
- "2"
type: string
access_token:
description: OAuth access token.
in: query
name: access_token
schema:
type: string
alt:
description: Data format for response.
in: query
name: alt
schema:
enum:
- json
- media
- proto
type: string
callback:
description: JSONP
in: query
name: callback
schema:
type: string
fields:
description: Selector specifying which fields to include in a partial response.
in: query
name: fields
schema:
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.
in: query
name: key
schema:
type: string
oauth_token:
description: OAuth 2.0 token for the current user.
in: query
name: oauth_token
schema:
type: string
prettyPrint:
description: Returns response with indentations and line breaks.
in: query
name: prettyPrint
schema:
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.
in: query
name: quotaUser
schema:
type: string
uploadType:
description: Legacy upload protocol for media (e.g. "media", "multipart").
in: query
name: uploadType
schema:
type: string
upload_protocol:
description: Upload protocol for media (e.g. "raw", "multipart").
in: query
name: upload_protocol
schema:
type: string
schemas:
GoogleGeoTypeViewport:
description: 'A latitude-longitude viewport, represented as two diagonally opposite `low` and `high` points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include: - If `low` = `high`, the viewport consists of that single point. - If `low.longitude` > `high.longitude`, the longitude range is inverted (the viewport crosses the 180 degree longitude line). - If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees, the viewport includes all longitudes. - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees, the longitude range is empty. - If `low.latitude` > `high.latitude`, the latitude range is empty. Both `low` and `high` must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error. For example, this viewport fully encloses New York City: { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }'
properties:
high:
$ref: "#/components/schemas/GoogleTypeLatLng"
description: Required. The high point of the viewport.
low:
$ref: "#/components/schemas/GoogleTypeLatLng"
description: Required. The low point of the viewport.
type: object
GoogleMapsPlacesV1AuthorAttribution:
description: Information about the author of the UGC data. Used in Photo, and Review.
properties:
displayName:
description: Name of the author of the Photo or Review.
type: string
photoUri:
description: Profile photo URI of the author of the Photo or Review.
type: string
uri:
description: URI of the author of the Photo or Review.
type: string
type: object
GoogleMapsPlacesV1AutocompletePlacesRequest:
description: Request proto for AutocompletePlaces.
properties:
includeQueryPredictions:
description: Optional. If true, the response will include both Place and query predictions. Otherwise the response will only return Place predictions.
type: boolean
includedPrimaryTypes:
description: Optional. Included primary Place type (for example, "restaurant" or "gas_station") from https://developers.google.com/maps/documentation/places/web-service/place-types. A Place is only returned if its primary type is included in this list. Up to 5 values can be specified. If no types are specified, all Place types are returned.
items:
type: string
type: array
includedRegionCodes:
description: Optional. Only include results in the specified regions, specified as up to 15 CLDR two-character region codes. An empty set will not restrict the results. If both `location_restriction` and `included_region_codes` are set, the results will be located in the area of intersection.
items:
type: string
type: array
input:
description: Required. The text string on which to search.
type: string
inputOffset:
description: Optional. A zero-based Unicode character offset of `input` indicating the cursor position in `input`. The cursor position may influence what predictions are returned. If empty, defaults to the length of `input`.
format: int32
type: integer
languageCode:
description: Optional. The language in which to return results. Defaults to en-US. The results may be in mixed languages if the language used in `input` is different from `language_code` or if the returned Place does not have a translation from the local language to `language_code`.
type: string
locationBias:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias"
description: Optional. Bias results to a specified location. At most one of `location_bias` or `location_restriction` should be set. If neither are set, the results will be biased by IP address, meaning the IP address will be mapped to an imprecise location and used as a biasing signal.
locationRestriction:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction"
description: Optional. Restrict results to a specified location. At most one of `location_bias` or `location_restriction` should be set. If neither are set, the results will be biased by IP address, meaning the IP address will be mapped to an imprecise location and used as a biasing signal.
origin:
$ref: "#/components/schemas/GoogleTypeLatLng"
description: Optional. The origin point from which to calculate geodesic distance to the destination (returned as `distance_meters`). If this value is omitted, geodesic distance will not be returned.
regionCode:
description: Optional. The region code, specified as a CLDR two-character region code. This affects address formatting, result ranking, and may influence what results are returned. This does not restrict results to the specified region. To restrict results to a region, use `region_code_restriction`.
type: string
sessionToken:
description: "Optional. A string which identifies an Autocomplete session for billing purposes. Must be a URL and filename safe base64 string with at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT error is returned. The session begins when the user starts typing a query, and concludes when they select a place and a call to Place Details or Address Validation is made. Each session can have multiple queries, followed by one Place Details or Address Validation request. The credentials used for each request within a session must belong to the same Google Cloud Console project. Once a session has concluded, the token is no longer valid; your app must generate a fresh token for each session. If the `session_token` parameter is omitted, or if you reuse a session token, the session is charged as if no session token was provided (each request is billed separately). We recommend the following guidelines: * Use session tokens for all Place Autocomplete calls. * Generate a fresh token for each session. Using a version 4 UUID is recommended. * Ensure that the credentials used for all Place Autocomplete, Place Details, and Address Validation requests within a session belong to the same Cloud Console project. * Be sure to pass a unique session token for each new session. Using the same token for more than one session will result in each request being billed individually."
type: string
type: object
GoogleMapsPlacesV1AutocompletePlacesRequestLocationBias:
description: The region to search. The results may be biased around the specified region.
oneOf:
- type: object
properties:
circle:
$ref: "#/components/schemas/GoogleMapsPlacesV1Circle"
description: A circle defined by a center point and radius.
- type: object
properties:
rectangle:
$ref: "#/components/schemas/GoogleGeoTypeViewport"
description: A viewport defined by a northeast and a southwest corner.
GoogleMapsPlacesV1AutocompletePlacesRequestLocationRestriction:
description: The region to search. The results will be restricted to the specified region.
oneOf:
- type: object
properties:
circle:
$ref: "#/components/schemas/GoogleMapsPlacesV1Circle"
description: A circle defined by a center point and radius.
- type: object
properties:
rectangle:
$ref: "#/components/schemas/GoogleGeoTypeViewport"
description: A viewport defined by a northeast and a southwest corner.
GoogleMapsPlacesV1AutocompletePlacesResponse:
description: Response proto for AutocompletePlaces.
properties:
suggestions:
description: Contains a list of suggestions, ordered in descending order of relevance.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion"
type: array
type: object
GoogleMapsPlacesV1AutocompletePlacesResponseSuggestion:
description: An Autocomplete suggestion result.
properties:
placePrediction:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction"
description: A prediction for a Place.
queryPrediction:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction"
description: A prediction for a query.
type: object
GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText:
description: Text representing a Place or query prediction. The text may be used as is or formatted.
properties:
matches:
description: A list of string ranges identifying where the input request matched in `text`. The ranges can be used to format specific parts of `text`. The substrings may not be exact matches of `input` if the matching was determined by criteria other than string matching (for example, spell corrections or transliterations). These values are Unicode character offsets of `text`. The ranges are guaranteed to be ordered in increasing offset values.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange"
type: array
text:
description: Text that may be used as is or formatted with `matches`.
type: string
type: object
GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionPlacePrediction:
description: Prediction results for a Place Autocomplete prediction.
properties:
distanceMeters:
description: The length of the geodesic in meters from `origin` if `origin` is specified. Certain predictions such as routes may not populate this field.
format: int32
type: integer
place:
description: The resource name of the suggested Place. This name can be used in other APIs that accept Place names.
type: string
placeId:
description: The unique identifier of the suggested Place. This identifier can be used in other APIs that accept Place IDs.
type: string
structuredFormat:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat"
description: A breakdown of the Place prediction into main text containing the name of the Place and secondary text containing additional disambiguating features (such as a city or region). `structured_format` is recommended for developers who wish to show two separate, but related, UI elements. Developers who wish to show a single UI element may want to use `text` instead. They are two different ways to represent a Place prediction. Users should not try to parse `structured_format` into `text` or vice versa.
text:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText"
description: Contains the human-readable name for the returned result. For establishment results, this is usually the business name and address. `text` is recommended for developers who wish to show a single UI element. Developers who wish to show two separate, but related, UI elements may want to use `structured_format` instead. They are two different ways to represent a Place prediction. Users should not try to parse `structured_format` into `text` or vice versa. This text may be different from the `display_name` returned by GetPlace. May be in mixed languages if the request `input` and `language_code` are in different languages or if the Place does not have a translation from the local language to `language_code`.
types:
description: List of types that apply to this Place from Table A or Table B in https://developers.google.com/maps/documentation/places/web-service/place-types. A type is a categorization of a Place. Places with shared types will share similar characteristics.
items:
type: string
type: array
type: object
GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionQueryPrediction:
description: Prediction results for a Query Autocomplete prediction.
properties:
structuredFormat:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat"
description: A breakdown of the query prediction into main text containing the query and secondary text containing additional disambiguating features (such as a city or region). `structured_format` is recommended for developers who wish to show two separate, but related, UI elements. Developers who wish to show a single UI element may want to use `text` instead. They are two different ways to represent a query prediction. Users should not try to parse `structured_format` into `text` or vice versa.
text:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText"
description: The predicted text. This text does not represent a Place, but rather a text query that could be used in a search endpoint (for example, TextSearch). `text` is recommended for developers who wish to show a single UI element. Developers who wish to show two separate, but related, UI elements may want to use `structured_format` instead. They are two different ways to represent a query prediction. Users should not try to parse `structured_format` into `text` or vice versa. May be in mixed languages if the request `input` and `language_code` are in different languages or if part of the query does not have a translation from the local language to `language_code`.
type: object
GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStringRange:
description: Identifies a substring within a given text.
properties:
endOffset:
description: Zero-based offset of the last Unicode character (exclusive).
format: int32
type: integer
startOffset:
description: Zero-based offset of the first Unicode character of the string (inclusive).
format: int32
type: integer
type: object
GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionStructuredFormat:
description: Contains a breakdown of a Place or query prediction into main text and secondary text. For Place predictions, the main text contains the specific name of the Place. For query predictions, the main text contains the query. The secondary text contains additional disambiguating features (such as a city or region) to further identify the Place or refine the query.
properties:
mainText:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText"
description: Represents the name of the Place or query.
secondaryText:
$ref: "#/components/schemas/GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText"
description: Represents additional disambiguating features (such as a city or region) to further identify the Place or refine the query.
type: object
GoogleMapsPlacesV1Circle:
description: Circle with a LatLng as center and radius.
properties:
center:
$ref: "#/components/schemas/GoogleTypeLatLng"
description: Required. Center latitude and longitude. The range of latitude must be within [-90.0, 90.0]. The range of the longitude must be within [-180.0, 180.0].
radius:
description: Required. Radius measured in meters. The radius must be within [0.0, 50000.0].
format: double
type: number
type: object
GoogleMapsPlacesV1EVChargeOptions:
description: Information about the EV Charge Station hosted in Place. Terminology follows https://afdc.energy.gov/fuels/electricity_infrastructure.html One port could charge one car at a time. One port has one or more connectors. One station has one or more ports.
properties:
connectorAggregation:
description: A list of EV charging connector aggregations that contain connectors of the same type and same charge rate.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation"
type: array
connectorCount:
description: Number of connectors at this station. However, because some ports can have multiple connectors but only be able to charge one car at a time (e.g.) the number of connectors may be greater than the total number of cars which can charge simultaneously.
format: int32
type: integer
type: object
GoogleMapsPlacesV1EVChargeOptionsConnectorAggregation:
description: EV charging information grouped by [type, max_charge_rate_kw]. Shows EV charge aggregation of connectors that have the same type and max charge rate in kw.
properties:
availabilityLastUpdateTime:
description: The timestamp when the connector availability information in this aggregation was last updated.
format: google-datetime
type: string
availableCount:
description: Number of connectors in this aggregation that are currently available.
format: int32
type: integer
count:
description: Number of connectors in this aggregation.
format: int32
type: integer
maxChargeRateKw:
description: The static max charging rate in kw of each connector in the aggregation.
format: double
type: number
outOfServiceCount:
description: Number of connectors in this aggregation that are currently out of service.
format: int32
type: integer
type:
description: The connector type of this aggregation.
enum:
- EV_CONNECTOR_TYPE_UNSPECIFIED
- EV_CONNECTOR_TYPE_OTHER
- EV_CONNECTOR_TYPE_J1772
- EV_CONNECTOR_TYPE_TYPE_2
- EV_CONNECTOR_TYPE_CHADEMO
- EV_CONNECTOR_TYPE_CCS_COMBO_1
- EV_CONNECTOR_TYPE_CCS_COMBO_2
- EV_CONNECTOR_TYPE_TESLA
- EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T
- EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET
type: string
type: object
GoogleMapsPlacesV1FuelOptions:
description: The most recent information about fuel options in a gas station. This information is updated regularly.
properties:
fuelPrices:
description: The last known fuel price for each type of fuel this station has. There is one entry per fuel type this station has. Order is not important.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1FuelOptionsFuelPrice"
type: array
type: object
GoogleMapsPlacesV1FuelOptionsFuelPrice:
description: Fuel price information for a given type.
properties:
price:
$ref: "#/components/schemas/GoogleTypeMoney"
description: The price of the fuel.
type:
description: The type of fuel.
enum:
- FUEL_TYPE_UNSPECIFIED
- DIESEL
- REGULAR_UNLEADED
- MIDGRADE
- PREMIUM
- SP91
- SP91_E10
- SP92
- SP95
- SP95_E10
- SP98
- SP99
- SP100
- LPG
- E80
- E85
- METHANE
- BIO_DIESEL
- TRUCK_DIESEL
type: string
updateTime:
description: The time the fuel price was last updated.
format: google-datetime
type: string
type: object
GoogleMapsPlacesV1Photo:
description: Information about a photo of a place.
properties:
authorAttributions:
description: This photo's authors.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1AuthorAttribution"
type: array
heightPx:
description: The maximum available height, in pixels.
format: int32
type: integer
name:
description: 'Identifier. A reference representing this place photo which may be used to look up this place photo again (also called the API "resource" name: `places/{place_id}/photos/{photo}`).'
type: string
widthPx:
description: The maximum available width, in pixels.
format: int32
type: integer
type: object
GoogleMapsPlacesV1PhotoMedia:
description: A photo media from Places API.
properties:
name:
description: "The resource name of a photo media in the format: `places/{place_id}/photos/{photo_reference}/media`."
type: string
photoUri:
description: A short-lived uri that can be used to render the photo.
type: string
type: object
GoogleMapsPlacesV1Place:
description: All the information representing a Place.
properties:
accessibilityOptions:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceAccessibilityOptions"
description: Information about the accessibility options a place offers.
addressComponents:
description: "Repeated components for each locality level. Note the following facts about the address_components[] array: - The array of address components may contain more components than the formatted_address. - The array does not necessarily include all the political entities that contain an address, apart from those included in the formatted_address. To retrieve all the political entities that contain a specific address, you should use reverse geocoding, passing the latitude/longitude of the address as a parameter to the request. - The format of the response is not guaranteed to remain the same between requests. In particular, the number of address_components varies based on the address requested and can change over time for the same address. A component can change position in the array. The type of the component can change. A particular component may be missing in a later response."
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceAddressComponent"
type: array
adrFormatAddress:
description: "The place's address in adr microformat: http://microformats.org/wiki/adr."
type: string
allowsDogs:
description: Place allows dogs.
type: boolean
attributions:
description: A set of data provider that must be shown with this result.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceAttribution"
type: array
businessStatus:
description: The business status for the place.
enum:
- BUSINESS_STATUS_UNSPECIFIED
- OPERATIONAL
- CLOSED_TEMPORARILY
- CLOSED_PERMANENTLY
type: string
curbsidePickup:
description: Specifies if the business supports curbside pickup.
type: boolean
currentOpeningHours:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours"
description: The hours of operation for the next seven days (including today). The time period starts at midnight on the date of the request and ends at 11:59 pm six days later. This field includes the special_days subfield of all hours, set for dates that have exceptional hours.
currentSecondaryOpeningHours:
description: Contains an array of entries for the next seven days including information about secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place. This field includes the special_days subfield of all hours, set for dates that have exceptional hours.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours"
type: array
delivery:
description: Specifies if the business supports delivery.
type: boolean
dineIn:
description: Specifies if the business supports indoor or outdoor seating options.
type: boolean
displayName:
$ref: "#/components/schemas/GoogleTypeLocalizedText"
description: The localized name of the place, suitable as a short human-readable description. For example, "Google Sydney", "Starbucks", "Pyrmont", etc.
editorialSummary:
$ref: "#/components/schemas/GoogleTypeLocalizedText"
description: Contains a summary of the place. A summary is comprised of a textual overview, and also includes the language code for these if applicable. Summary text must be presented as-is and can not be modified or altered.
evChargeOptions:
$ref: "#/components/schemas/GoogleMapsPlacesV1EVChargeOptions"
description: Information of ev charging options.
formattedAddress:
description: A full, human-readable address for this place.
type: string
fuelOptions:
$ref: "#/components/schemas/GoogleMapsPlacesV1FuelOptions"
description: The most recent information about fuel options in a gas station. This information is updated regularly.
goodForChildren:
description: Place is good for children.
type: boolean
goodForGroups:
description: Place accommodates groups.
type: boolean
goodForWatchingSports:
description: Place is suitable for watching sports.
type: boolean
googleMapsUri:
description: A URL providing more information about this place.
type: string
iconBackgroundColor:
description: "Background color for icon_mask in hex format, e.g. #909CE1."
type: string
iconMaskBaseUri:
description: A truncated URL to an icon mask. User can access different icon type by appending type suffix to the end (eg, ".svg" or ".png").
type: string
id:
description: The unique identifier of a place.
type: string
internationalPhoneNumber:
description: A human-readable phone number for the place, in international format.
type: string
liveMusic:
description: Place provides live music.
type: boolean
location:
$ref: "#/components/schemas/GoogleTypeLatLng"
description: The position of this place.
menuForChildren:
description: Place has a children's menu.
type: boolean
name:
description: This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
type: string
nationalPhoneNumber:
description: A human-readable phone number for the place, in national format.
type: string
outdoorSeating:
description: Place provides outdoor seating.
type: boolean
parkingOptions:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceParkingOptions"
description: Options of parking provided by the place.
paymentOptions:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlacePaymentOptions"
description: Payment options the place accepts. If a payment option data is not available, the payment option field will be unset.
photos:
description: Information (including references) about photos of this place. A maximum of 10 photos can be returned.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1Photo"
type: array
plusCode:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlacePlusCode"
description: Plus code of the place location lat/long.
priceLevel:
description: Price level of the place.
enum:
- PRICE_LEVEL_UNSPECIFIED
- PRICE_LEVEL_FREE
- PRICE_LEVEL_INEXPENSIVE
- PRICE_LEVEL_MODERATE
- PRICE_LEVEL_EXPENSIVE
- PRICE_LEVEL_VERY_EXPENSIVE
type: string
primaryType:
description: The primary type of the given result. This type must one of the Places API supported types. For example, "restaurant", "cafe", "airport", etc. A place can only have a single primary type. For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types
type: string
primaryTypeDisplayName:
$ref: "#/components/schemas/GoogleTypeLocalizedText"
description: The display name of the primary type, localized to the request language if applicable. For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types
rating:
description: A rating between 1.0 and 5.0, based on user reviews of this place.
format: double
type: number
regularOpeningHours:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours"
description: The regular hours of operation.
regularSecondaryOpeningHours:
description: Contains an array of entries for information about regular secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHours"
type: array
reservable:
description: Specifies if the place supports reservations.
type: boolean
restroom:
description: Place has restroom.
type: boolean
reviews:
description: List of reviews about this place, sorted by relevance. A maximum of 5 reviews can be returned.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1Review"
type: array
servesBeer:
description: Specifies if the place serves beer.
type: boolean
servesBreakfast:
description: Specifies if the place serves breakfast.
type: boolean
servesBrunch:
description: Specifies if the place serves brunch.
type: boolean
servesCocktails:
description: Place serves cocktails.
type: boolean
servesCoffee:
description: Place serves coffee.
type: boolean
servesDessert:
description: Place serves dessert.
type: boolean
servesDinner:
description: Specifies if the place serves dinner.
type: boolean
servesLunch:
description: Specifies if the place serves lunch.
type: boolean
servesVegetarianFood:
description: Specifies if the place serves vegetarian food.
type: boolean
servesWine:
description: Specifies if the place serves wine.
type: boolean
shortFormattedAddress:
description: A short, human-readable address for this place.
type: string
subDestinations:
description: A list of sub destinations related to the place.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceSubDestination"
type: array
takeout:
description: Specifies if the business supports takeout.
type: boolean
types:
description: A set of type tags for this result. For example, "political" and "locality". For the complete list of possible values, see Table A and Table B at https://developers.google.com/maps/documentation/places/web-service/place-types
items:
type: string
type: array
userRatingCount:
description: The total number of reviews (with or without text) for this place.
format: int32
type: integer
utcOffsetMinutes:
description: Number of minutes this place's timezone is currently offset from UTC. This is expressed in minutes to support timezones that are offset by fractions of an hour, e.g. X hours and 15 minutes.
format: int32
type: integer
viewport:
$ref: "#/components/schemas/GoogleGeoTypeViewport"
description: A viewport suitable for displaying the place on an average-sized map.
websiteUri:
description: The authoritative website for this place, e.g. a business' homepage. Note that for places that are part of a chain (e.g. an IKEA store), this will usually be the website for the individual store, not the overall chain.
type: string
type: object
GoogleMapsPlacesV1PlaceAccessibilityOptions:
description: Information about the accessibility options a place offers.
properties:
wheelchairAccessibleEntrance:
description: Places has wheelchair accessible entrance.
type: boolean
wheelchairAccessibleParking:
description: Place offers wheelchair accessible parking.
type: boolean
wheelchairAccessibleRestroom:
description: Place has wheelchair accessible restroom.
type: boolean
wheelchairAccessibleSeating:
description: Place has wheelchair accessible seating.
type: boolean
type: object
GoogleMapsPlacesV1PlaceAddressComponent:
description: The structured components that form the formatted address, if this information is available.
properties:
languageCode:
description: The language used to format this components, in CLDR notation.
type: string
longText:
description: The full text description or name of the address component. For example, an address component for the country Australia may have a long_name of "Australia".
type: string
shortText:
description: An abbreviated textual name for the address component, if available. For example, an address component for the country of Australia may have a short_name of "AU".
type: string
types:
description: An array indicating the type(s) of the address component.
items:
type: string
type: array
type: object
GoogleMapsPlacesV1PlaceAttribution:
description: Information about data providers of this place.
properties:
provider:
description: Name of the Place's data provider.
type: string
providerUri:
description: URI to the Place's data provider.
type: string
type: object
GoogleMapsPlacesV1PlaceOpeningHours:
description: Information about business hour of the place.
properties:
openNow:
description: Is this place open right now? Always present unless we lack time-of-day or timezone data for these opening hours.
type: boolean
periods:
description: The periods that this place is open during the week. The periods are in chronological order, starting with Sunday in the place-local timezone. An empty (but not absent) value indicates a place that is never open, e.g. because it is closed temporarily for renovations.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriod"
type: array
secondaryHoursType:
description: A type string used to identify the type of secondary hours.
enum:
- SECONDARY_HOURS_TYPE_UNSPECIFIED
- DRIVE_THROUGH
- HAPPY_HOUR
- DELIVERY
- TAKEOUT
- KITCHEN
- BREAKFAST
- LUNCH
- DINNER
- BRUNCH
- PICKUP
- ACCESS
- SENIOR_HOURS
- ONLINE_SERVICE_HOURS
type: string
specialDays:
description: Structured information for special days that fall within the period that the returned opening hours cover. Special days are days that could impact the business hours of a place, e.g. Christmas day. Set for current_opening_hours and current_secondary_opening_hours if there are exceptional hours.
items:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay"
type: array
weekdayDescriptions:
description: 'Localized strings describing the opening hours of this place, one string for each day of the week. Will be empty if the hours are unknown or could not be converted to localized text. Example: "Sun: 18:00–06:00"'
items:
type: string
type: array
type: object
GoogleMapsPlacesV1PlaceOpeningHoursPeriod:
description: A period the place remains in open_now status.
properties:
close:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint"
description: The time that the place starts to be closed.
open:
$ref: "#/components/schemas/GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint"
description: The time that the place starts to be open.
type: object
GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint:
description: Status changing points.
properties:
date:
$ref: "#/components/schemas/GoogleTypeDate"
description: Date in the local timezone for the place.
day:
description: A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is Monday, etc.
format: int32
type: integer
hour:
description: The hour in 2 digits. Ranges from 00 to 23.
format: int32
type: integer
minute:
description: The minute in 2 digits. Ranges from 00 to 59.
format: int32
type: integer
truncated:
description: Whether or not this endpoint was truncated. Truncation occurs when the real hours are outside the times we are willing to return hours between, so we truncate the hours back to these boundaries. This ensures that at most 24 * 7 hours from midnight of the day of the request are returned.
type: boolean
type: object
GoogleMapsPlacesV1PlaceOpeningHoursSpecialDay:
description: Structured information for special days that fall within the period that the returned opening hours cover. Special days are days that could impact the business hours of a place, e.g. Christmas day.
properties:
date:
$ref: "#/components/schemas/GoogleTypeDate"
description: The date of this special day.
type: object
GoogleMapsPlacesV1PlaceParkingOptions:
description: Information about parking options for the place. A parking lot could support more than one option at the same time.
properties:
freeGarageParking:
description: Place offers free garage parking.
type: boolean
freeParkingLot:
description: Place offers free parking lots.
type: boolean
freeStreetParking:
description: Place offers free street parking.
type: boolean
paidGarageParking:
description: Place offers paid garage parking.
type: boolean
paidParkingLot:
description: Place offers paid parking lots.
type: boolean
paidStreetParking:
description: Place offers paid street parking.
type: boolean
valetParking:
description: Place offers valet parking.
type: boolean
type: object
GoogleMapsPlacesV1PlacePaymentOptions:
description: Payment options the place accepts.
properties:
acceptsCashOnly:
description: Place accepts cash only as payment. Places with this attribute may still accept other payment methods.
type: boolean
acceptsCreditCards:
description: Place accepts credit cards as payment.
type: boolean
acceptsDebitCards:
description: Place accepts debit cards as payment.
type: boolean
acceptsNfc:
description: Place accepts NFC payments.
type: boolean
type: object
GoogleMapsPlacesV1PlacePlusCode:
description: "Plus code (http://plus.codes) is a location reference with two formats: global code defining a 14mx14m (1/8000th of a degree) or smaller rectangle, and compound code, replacing the prefix with a reference location."
properties:
compoundCode:
description: Place's compound code, such as "33GV+HQ, Ramberg, Norway", containing the suffix of the global code and replacing the prefix with a formatted name of a reference entity.
type: string
globalCode:
description: Place's global (full) code, such as "9FWM33GV+HQ", representing an 1/8000 by 1/8000 degree area (~14 by 14 meters).