forked from scottybo/Laravel-Google-My-Business
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathmybusiness_google_rest_v4p8.json
11651 lines (11651 loc) · 499 KB
/
mybusiness_google_rest_v4p8.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
{
"kind": "discovery#restDescription",
"discoveryVersion": "v1",
"id": "mybusiness:v4",
"name": "mybusiness",
"canonicalName": "My Business",
"version": "v4",
"revision": "0",
"title": "Google My Business API",
"description": "The Google My Business API provides an interface for managing business location information on Google.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"documentationLink": "https://developers.google.com/my-business/",
"protocol": "rest",
"rootUrl": "https://mybusiness.googleapis.com/",
"mtlsRootUrl": "https://mybusiness.mtls.googleapis.com/",
"servicePath": "",
"baseUrl": "https://mybusiness.googleapis.com/",
"batchPath": "batch",
"version_module": true,
"fullyEncodeReservedExpansion": true,
"parameters": {
"access_token": {
"type": "string",
"description": "OAuth access token.",
"location": "query"
},
"alt": {
"type": "string",
"description": "Data format for response.",
"default": "json",
"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"
},
"callback": {
"type": "string",
"description": "JSONP",
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"type": "string",
"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"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"quotaUser": {
"type": "string",
"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"
},
"upload_protocol": {
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query"
},
"uploadType": {
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query"
},
"$.xgafv": {
"type": "string",
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query"
}
},
"schemas": {
"AcceptInvitationRequest": {
"id": "AcceptInvitationRequest",
"description": "Request message for AccessControl.AcceptInvitation.",
"type": "object",
"properties": {
}
},
"Empty": {
"id": "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); } The JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {
}
},
"DeclineInvitationRequest": {
"id": "DeclineInvitationRequest",
"description": "Request message for AccessControl.DeclineInvitation.",
"type": "object",
"properties": {
}
},
"ListInvitationsResponse": {
"id": "ListInvitationsResponse",
"description": "Response message for AccessControl.ListInvitations.",
"type": "object",
"properties": {
"invitations": {
"description": "A collection of location invitations that are pending for the account. The number of invitations listed here cannot exceed 1000.",
"type": "array",
"items": {
"$ref": "Invitation"
}
}
}
},
"Invitation": {
"id": "Invitation",
"description": "Output only. Represents a pending invitation.",
"type": "object",
"properties": {
"name": {
"description": "The resource name for the invitation.",
"type": "string"
},
"targetAccount": {
"description": "The sparsely populated account this invitation is for.",
"$ref": "Account"
},
"targetLocation": {
"description": "The target location this invitation is for.",
"$ref": "TargetLocation"
},
"role": {
"description": "The invited role on the account.",
"type": "string",
"enumDescriptions": [
"Not specified.",
"The admin has owner-level access and is the primary owner. (Displays as 'Primary Owner' in UI).",
"The admin has owner-level access. (Displays as 'Owner' in UI).",
"The admin has managerial access.",
"The admin can manage social (Google+) pages. (Displays as 'Site Manager' in UI)."
],
"enum": [
"ADMIN_ROLE_UNSPECIFIED",
"OWNER",
"CO_OWNER",
"MANAGER",
"COMMUNITY_MANAGER"
]
}
}
},
"Account": {
"id": "Account",
"description": "An account is a container for your business's locations. If you are the only user who manages locations for your business, you can use your personal Google Account. To share management of locations with multiple users, [create a business account] (https:\/\/support.google.com\/business\/answer\/6085339?ref_topic=6085325).",
"type": "object",
"properties": {
"name": {
"description": "The resource name, in the format `accounts\/{account_id}`.",
"type": "string"
},
"accountName": {
"description": "The name of the account. *Note:* For an account with AccountType `PERSONAL`, this is the first and last name of the user account.",
"type": "string"
},
"type": {
"description": "Output only. Specifies the AccountType of this account.",
"type": "string",
"enumDescriptions": [
"Not specified.",
"An end-user account.",
"A group of Locations. For more information, see the [help center article] (https:\/\/support.google.com\/business\/answer\/6085326)",
"A User Group for segregating organization staff in groups. For more information, see the [help center article](https:\/\/support.google.com\/business\/answer\/7655731)",
"An organization representing a company. For more information, see the [help center article](https:\/\/support.google.com\/business\/answer\/7663063)"
],
"enum": [
"ACCOUNT_TYPE_UNSPECIFIED",
"PERSONAL",
"LOCATION_GROUP",
"USER_GROUP",
"ORGANIZATION"
]
},
"role": {
"description": "Output only. Specifies the AccountRole the caller has for this account.",
"type": "string",
"enumDescriptions": [
"Not specified.",
"The user owns this account. (Displays as 'Primary Owner' in UI).",
"The user is a co-owner of the account. (Displays as 'Owner' in UI).",
"The user can manage this account.",
"The user can manage social (Google+) pages for the account. (Displays as 'Site Manager' in UI)."
],
"enum": [
"ACCOUNT_ROLE_UNSPECIFIED",
"OWNER",
"CO_OWNER",
"MANAGER",
"COMMUNITY_MANAGER"
]
},
"state": {
"description": "Output only. Indicates the AccountState of this account.",
"$ref": "AccountState"
},
"accountNumber": {
"description": "Account reference number if provisioned.",
"type": "string"
},
"permissionLevel": {
"description": "Output only. Specifies the PermissionLevel the caller has for this account.",
"type": "string",
"enumDescriptions": [
"Not specified.",
"The user has owner level permission.",
"The user has member level permission."
],
"enum": [
"PERMISSION_LEVEL_UNSPECIFIED",
"OWNER_LEVEL",
"MEMBER_LEVEL"
]
},
"organizationInfo": {
"description": "Additional info for an organization. This is populated only for an organization account.",
"$ref": "OrganizationInfo"
}
}
},
"AccountState": {
"id": "AccountState",
"description": "Indicates status of the account, such as whether the account has been verified by Google.",
"type": "object",
"properties": {
"status": {
"description": "If verified, future locations that are created are automatically connected to Google Maps, and have Google+ pages created, without requiring moderation.",
"type": "string",
"enumDescriptions": [
"Not specified.",
"Verified account.",
"Account that is not verified, and verification has not been requested.",
"Account that is not verified, but verification has been requested."
],
"enum": [
"ACCOUNT_STATUS_UNSPECIFIED",
"VERIFIED",
"UNVERIFIED",
"VERIFICATION_REQUESTED"
]
}
}
},
"OrganizationInfo": {
"id": "OrganizationInfo",
"description": "Additional Info stored for an organization.",
"type": "object",
"properties": {
"registeredDomain": {
"description": "The registered domain for the account.",
"type": "string"
},
"postalAddress": {
"description": "The postal address for the account.",
"$ref": "PostalAddress"
},
"phoneNumber": {
"description": "The contact number for the organization.",
"type": "string"
}
}
},
"PostalAddress": {
"id": "PostalAddress",
"description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input \/ editing: - Use an i18n-ready address widget such as https:\/\/github.com\/google\/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https:\/\/support.google.com\/business\/answer\/6397478",
"type": "object",
"properties": {
"revision": {
"description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.",
"type": "integer",
"format": "int32"
},
"regionCode": {
"description": "Required. CLDR region code of the country\/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http:\/\/cldr.unicode.org\/ and http:\/\/www.unicode.org\/cldr\/charts\/30\/supplemental\/territory_information.html for details. Example: \"CH\" for Switzerland.",
"type": "string"
},
"languageCode": {
"description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country\/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".",
"type": "string"
},
"postalCode": {
"description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state\/zip validation in the U.S.A.).",
"type": "string"
},
"sortingCode": {
"description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (e.g. C\u00F4te d'Ivoire).",
"type": "string"
},
"administrativeArea": {
"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.",
"type": "string"
},
"locality": {
"description": "Optional. Generally refers to the city\/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.",
"type": "string"
},
"sublocality": {
"description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.",
"type": "string"
},
"addressLines": {
"description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country\/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
"type": "array",
"items": {
"type": "string"
}
},
"recipients": {
"description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.",
"type": "array",
"items": {
"type": "string"
}
},
"organization": {
"description": "Optional. The name of the organization at the address.",
"type": "string"
}
}
},
"TargetLocation": {
"id": "TargetLocation",
"description": "Represents a target location for a pending invitation.",
"type": "object",
"properties": {
"locationName": {
"description": "The name of the location to which the user is invited.",
"type": "string"
},
"locationAddress": {
"description": "The address of the location to which the user is invited.",
"type": "string"
}
}
},
"ListAccountAdminsResponse": {
"id": "ListAccountAdminsResponse",
"description": "Response message for AccessControl.ListAccountAdmins.",
"type": "object",
"properties": {
"admins": {
"description": "A collection of Admin instances.",
"type": "array",
"items": {
"$ref": "Admin"
}
}
}
},
"Admin": {
"id": "Admin",
"description": "An administrator of an Account or a Location.",
"type": "object",
"properties": {
"name": {
"description": "The resource name. For account admins, this is in the form: `accounts\/{account_id}\/admins\/{admin_id}` For location admins, this is in the form: `accounts\/{account_id}\/locations\/{location_id}\/admins\/{admin_id}`",
"type": "string"
},
"adminName": {
"description": "The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names.",
"type": "string"
},
"role": {
"description": "Specifies the AdminRole that this admin uses with the specified Account or Location resource.",
"type": "string",
"enumDescriptions": [
"Not specified.",
"The admin has owner-level access and is the primary owner. (Displays as 'Primary Owner' in UI).",
"The admin has owner-level access. (Displays as 'Owner' in UI).",
"The admin has managerial access.",
"The admin can manage social (Google+) pages. (Displays as 'Site Manager' in UI)."
],
"enum": [
"ADMIN_ROLE_UNSPECIFIED",
"OWNER",
"CO_OWNER",
"MANAGER",
"COMMUNITY_MANAGER"
]
},
"pendingInvitation": {
"description": "Output only. Indicates whether this admin has a pending invitation for the specified resource.",
"type": "boolean"
}
}
},
"ListLocationAdminsResponse": {
"id": "ListLocationAdminsResponse",
"description": "Response message for AccessControl.ListLocationAdmins.",
"type": "object",
"properties": {
"admins": {
"description": "A collection of Admin instances.",
"type": "array",
"items": {
"$ref": "Admin"
}
}
}
},
"ListAccountsResponse": {
"id": "ListAccountsResponse",
"description": "Response message for Accounts.ListAccounts.",
"type": "object",
"properties": {
"accounts": {
"description": "A collection of accounts to which the user has access. The personal account of the user doing the query will always be the first item of the result, unless it is filtered out.",
"type": "array",
"items": {
"$ref": "Account"
}
},
"nextPageToken": {
"description": "If the number of accounts exceeds the requested page size, this field is populated with a token to fetch the next page of accounts on a subsequent call to `accounts.list`. If there are no more accounts, this field is not present in the response.",
"type": "string"
}
}
},
"GenerateAccountNumberRequest": {
"id": "GenerateAccountNumberRequest",
"description": "Request message for Accounts.GenerateAccountNumber.",
"type": "object",
"properties": {
}
},
"Notifications": {
"id": "Notifications",
"description": "A Google Cloud Pub\/Sub topic where notifications can be published when a location is updated or has a new review. There will be only one notification settings resource per-account.",
"type": "object",
"properties": {
"name": {
"description": "Output only. The notifications resource name.",
"type": "string"
},
"topicName": {
"description": "The Google Cloud Pub\/Sub topic that will receive notifications when locations managed by this account are updated. If unset, no notifications will be posted. The account [email protected] must have at least Publish permissions on the Cloud Pub\/Sub topic.",
"type": "string"
},
"notificationTypes": {
"description": "The types of notifications that will be sent to the Cloud Pub\/Sub topic. At least one must be specified. To stop receiving notifications entirely, use DeleteNotifications.",
"type": "array",
"items": {
"type": "string",
"enumDescriptions": [
"No notification type. Will not match any notifications.",
"The location has Google updates for review. The location_name field on the notification will provide the resource name of the location with Google updates.",
"A new review has been added to the location. The review_name field on the notification will provide the resource name of the review that was added, and location_name will have the location's resource name.",
"A review on the location has been updated. The review_name field on the notification will provide the resource name of the review that was added, and location_name will have the location's resource name.",
"A new media item has been added to the location by a Google Maps user. The notification will provide the resource name of the new media item.",
"A new question is added to the location. The notification will provide the resource name of question.",
"A question of the location is updated. The notification will provide the resource name of question.",
"A new answer is added to the location. The notification will provide the resource name of question and answer.",
"An answer of the location is updated. The notification will provide the resource name of question and answer.",
"The LocationState of the Location was updated. The Notification will contain the field mask of the updated LocationState fields."
],
"enum": [
"NOTIFICATION_TYPE_UNSPECIFIED",
"GOOGLE_UPDATE",
"NEW_REVIEW",
"UPDATED_REVIEW",
"NEW_CUSTOMER_MEDIA",
"NEW_QUESTION",
"UPDATED_QUESTION",
"NEW_ANSWER",
"UPDATED_ANSWER",
"UPDATED_LOCATION_STATE"
]
}
}
}
},
"ListBusinessCategoriesResponse": {
"id": "ListBusinessCategoriesResponse",
"type": "object",
"properties": {
"categories": {
"description": "The categories. Categories are BASIC view. They don't contain any ServiceType information.",
"type": "array",
"items": {
"$ref": "Category"
}
},
"totalCategoryCount": {
"description": "The total number of categories for the request parameters.",
"type": "integer",
"format": "int32"
},
"nextPageToken": {
"description": "If the number of categories exceeded the requested page size, this field will be populated with a token to fetch the next page of categories on a subsequent call to `ListBusinessCategories`.",
"type": "string"
}
}
},
"Category": {
"id": "Category",
"description": "A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see [categories.list](https:\/\/developers.google.com\/my-business\/reference\/rest\/v4\/categories\/list).",
"type": "object",
"properties": {
"displayName": {
"description": "@OutputOnly. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.",
"type": "string"
},
"categoryId": {
"description": "@OutputOnly. A stable ID (provided by Google) for this category. The `category_id` must be specified when modifying the category (when creating or updating a location).",
"type": "string"
},
"serviceTypes": {
"description": "@OutputOnly. A list of all the service types that are available for this business category.",
"type": "array",
"items": {
"$ref": "ServiceType"
}
}
}
},
"ServiceType": {
"id": "ServiceType",
"description": "A message describing a service type that the business offers.",
"type": "object",
"properties": {
"serviceTypeId": {
"description": "Output only. A stable ID (provided by Google) for this service type.",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Output only. The human-readable display name for the service type.",
"readOnly": true,
"type": "string"
}
}
},
"BatchGetBusinessCategoriesResponse": {
"id": "BatchGetBusinessCategoriesResponse",
"description": "Response message for BusinessCategories.BatchGetBusinessCategories.",
"type": "object",
"properties": {
"categories": {
"description": "Categories that match the GConcept ids provided in the request. They will not come in the same order as category ids in the request.",
"type": "array",
"items": {
"$ref": "Category"
}
}
}
},
"FollowersMetadata": {
"id": "FollowersMetadata",
"description": "Follower metadata for a location.",
"type": "object",
"properties": {
"name": {
"description": "The resource name for this. accounts\/{account_id}\/locations\/{location_id}\/followers\/metadata",
"type": "string"
},
"count": {
"description": "Total number of followers for the location.",
"type": "string",
"format": "uint64"
}
}
},
"FoodMenus": {
"id": "FoodMenus",
"description": "Menus of a business that serve food dishes.",
"type": "object",
"properties": {
"name": {
"description": "Required. Google identifier for this location in the form: `accounts\/{account_id}\/locations\/{location_id}\/foodMenus`",
"type": "string"
},
"menus": {
"description": "Optional. A collection of food menus.",
"type": "array",
"items": {
"$ref": "FoodMenu"
}
}
}
},
"FoodMenu": {
"id": "FoodMenu",
"description": "Menu of a business that serves food dishes.",
"type": "object",
"properties": {
"labels": {
"description": "Required. Language-tagged labels for the menu. E.g. \"menu\", \"lunch special\". Display names should be 140 characters or less, with descriptions 1,000 characters or less. At least one set of labels is required.",
"type": "array",
"items": {
"$ref": "MenuLabel"
}
},
"sourceUrl": {
"description": "Optional. Source URL of menu if there is a webpage to go to.",
"type": "string"
},
"sections": {
"description": "Required. Sections of the menu.",
"type": "array",
"items": {
"$ref": "FoodMenuSection"
}
},
"cuisines": {
"description": "Optional. Cuisine information for the food menu. It is highly recommended to provide this field.",
"type": "array",
"items": {
"type": "string",
"enumDescriptions": [
"Cuisine unspecified",
"American food",
"Asian food",
"Brazilian food",
"Breakfast",
"Brunch",
"Chicken",
"Chinese food",
"Family style cuisine",
"Fast food",
"French food",
"Greek food",
"German food",
"Hamburger",
"Indian food",
"Indonesian food",
"Italian food",
"Japanese food",
"Korean food",
"Latin American food",
"Mediterranean food",
"Mexican food",
"Pakistani food",
"Pizza",
"Seafood",
"Spanish food",
"Sushi",
"Thai food",
"Turkish food",
"Vegetarian Food",
"Vietnamese food",
"Other cuisine"
],
"enum": [
"CUISINE_UNSPECIFIED",
"AMERICAN",
"ASIAN",
"BRAZILIAN",
"BREAK_FAST",
"BRUNCH",
"CHICKEN",
"CHINESE",
"FAMILY",
"FAST_FOOD",
"FRENCH",
"GREEK",
"GERMAN",
"HAMBURGER",
"INDIAN",
"INDONESIAN",
"ITALIAN",
"JAPANESE",
"KOREAN",
"LATIN_AMERICAN",
"MEDITERRANEAN",
"MEXICAN",
"PAKISTANI",
"PIZZA",
"SEAFOOD",
"SPANISH",
"SUSHI",
"THAI",
"TURKISH",
"VEGETARIAN",
"VIETNAMESE",
"OTHER_CUISINE"
]
}
}
}
},
"MenuLabel": {
"id": "MenuLabel",
"description": "Label to be used when displaying the menu and its various sub-components.",
"type": "object",
"properties": {
"displayName": {
"description": "Required. Display name of the component.",
"type": "string"
},
"description": {
"description": "Optional. Supplementary information of the component.",
"type": "string"
},
"languageCode": {
"description": "Optional. The BCP 47 code of language. If the language is not available, it will default to English.",
"type": "string"
}
}
},
"FoodMenuSection": {
"id": "FoodMenuSection",
"description": "Section of a menu. It can contain multiple items\/dishes.",
"type": "object",
"properties": {
"labels": {
"description": "Required. Language tagged labels for this menu section. Display names should be 140 characters or less, with descriptions 1,000 characters or less. At least one set of labels is required.",
"type": "array",
"items": {
"$ref": "MenuLabel"
}
},
"items": {
"description": "Required. Items of the section. Each Section must have at least an item.",
"type": "array",
"items": {
"$ref": "FoodMenuItem"
}
}
}
},
"FoodMenuItem": {
"id": "FoodMenuItem",
"description": "Item of a Section. It can be the dish itself, or can contain multiple FoodMenuItemOption.",
"type": "object",
"properties": {
"labels": {
"description": "Required. Language tagged labels for this menu item. Display names should be 140 characters or less, with descriptions 1,000 characters or less. At least one set of labels is required.",
"type": "array",
"items": {
"$ref": "MenuLabel"
}
},
"attributes": {
"description": "Required. Detailed attributes of the item. When item options are specified, this is considered as the base attributes and populate to each options.",
"$ref": "FoodMenuItemAttributes"
},
"options": {
"description": "Optional. This is for an item that comes in multiple different options, and users are required to make choices. E.g. \"regular\" vs. \"large\" pizza. When options are specified, labels and attributes at item level will automatically become the first option's labels and attributes. Clients only need to specify other additional food options in this field.",
"type": "array",
"items": {
"$ref": "FoodMenuItemOption"
}
}
}
},
"FoodMenuItemAttributes": {
"id": "FoodMenuItemAttributes",
"description": "Attributes of a food item\/dish.",
"type": "object",
"properties": {
"price": {
"description": "Required. Price of the food dish.",
"$ref": "Money"
},
"spiciness": {
"description": "Optional. Spiciness level of the food dish.",
"type": "string",
"enumDescriptions": [
"Level unspecified",
"Denotion of mild spicy.",
"Denotion of medium spicy.",
"Denotion of hot spicy. The most spiciest level."
],
"enum": [
"SPICINESS_UNSPECIFIED",
"MILD",
"MEDIUM",
"HOT"
]
},
"allergen": {
"description": "Optional. Allergens associated with the food dish. It is highly recommended to provide this field.",
"type": "array",
"items": {
"type": "string",
"enumDescriptions": [
"Allergen unspecified",
"Dairy related allergen",
"Egg related allergen",
"Fish related allergen",
"Peanut related allergen",
"Shellfish related allergen",
"Soy related allergen",
"Tree nut related allergen",
"Wheat related allergen"
],
"enum": [
"ALLERGEN_UNSPECIFIED",
"DAIRY",
"EGG",
"FISH",
"PEANUT",
"SHELLFISH",
"SOY",
"TREE_NUT",
"WHEAT"
]
}
},
"dietaryRestriction": {
"description": "Optional. Dietary information of the food dish. It is highly recommended to provide this field.",
"type": "array",
"items": {
"type": "string",
"enumDescriptions": [
"Dietary type unspecified",
"Denotion of the food as a halal dish.",
"Denotion of the food as a kosher dish.",
"Denotion of the food as an organic dish.",
"Denotion of the food as a vegan dish.",
"Denotion of the food as a vegetarian dish."
],
"enum": [
"DIETARY_RESTRICTION_UNSPECIFIED",
"HALAL",
"KOSHER",
"ORGANIC",
"VEGAN",
"VEGETARIAN"
]
}
},
"nutritionFacts": {
"description": "Optional. Nutrition facts of the food dish option. It is highly recommended to provide this field.",
"$ref": "NutritionFacts"
},
"ingredients": {
"description": "Optional. Ingredients of the food dish option.",
"type": "array",
"items": {
"$ref": "Ingredient"
}
},
"servesNumPeople": {
"description": "Optional. Number of people can be served by this food dish option.",
"type": "integer",
"format": "int32"
},
"preparationMethods": {
"description": "Optional. Methods on how the food dish option is prepared.",
"type": "array",
"items": {
"type": "string",
"enumDescriptions": [
"Preparation method unspecified",
"Baked method",
"Barbecued method",
"Basted method",
"Blanched method",
"Boiled method",
"Braised method",
"Coddled method",
"Fermented method",
"Fried method",
"Grilled method",
"Kneaded method",
"Marinated method",
"Pan fried method",
"Pickled method",
"Pressure cooked method",
"Roasted method",
"Sauteed method",
"Seared method",
"Simmered method",
"Smoked method",
"Steamed method",
"Steeped method",
"Stir fried method",
"Other method"
],
"enum": [
"PREPARATION_METHOD_UNSPECIFIED",
"BAKED",
"BARBECUED",
"BASTED",
"BLANCHED",
"BOILED",
"BRAISED",
"CODDLED",
"FERMENTED",
"FRIED",
"GRILLED",
"KNEADED",
"MARINATED",
"PAN_FRIED",
"PICKLED",
"PRESSURE_COOKED",
"ROASTED",
"SAUTEED",
"SEARED",
"SIMMERED",
"SMOKED",
"STEAMED",
"STEEPED",
"STIR_FRIED",
"OTHER_METHOD"
]
}
},
"portionSize": {
"description": "Optional. Size of the order, represented in units of items. (e.g. 4 \"skewers\", 6 \"pieces\")",
"$ref": "PortionSize"
},
"mediaKeys": {
"description": "Optional. The media keys of the media associated with the dish. Only photo media is supported. When there are multiple photos associated, the first photo is considered as the preferred photo.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Money": {
"id": "Money",
"description": "Represents an amount of money with its currency type.",
"type": "object",
"properties": {
"currencyCode": {
"description": "The three-letter currency code defined in ISO 4217.",
"type": "string"
},
"units": {
"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
"type": "string",
"format": "int64"
},
"nanos": {
"description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
"type": "integer",
"format": "int32"
}
}
},
"NutritionFacts": {
"id": "NutritionFacts",
"description": "This message represents nutrition facts for a food dish.",
"type": "object",
"properties": {
"calories": {
"description": "Optional. Calories of the dish.",
"$ref": "CaloriesFact"
},
"totalFat": {
"description": "Optional. Fat information for a given food dish.",
"$ref": "NutritionFact"
},
"cholesterol": {
"description": "Optional. Cholesterol information for a given food dish.",
"$ref": "NutritionFact"
},
"sodium": {
"description": "Optional. Sodium information for a given food dish.",
"$ref": "NutritionFact"
},
"totalCarbohydrate": {
"description": "Optional. Carbohydrate information for a given food dish.",
"$ref": "NutritionFact"
},
"protein": {
"description": "Optional. Protein information for a given food dish.",
"$ref": "NutritionFact"
}
}
},
"CaloriesFact": {
"id": "CaloriesFact",
"description": "This message denotes calories information with an upper bound and lower bound range. Lower amount must be specified. Both lower and upper amounts are non-negative numbers.",
"type": "object",