-
Notifications
You must be signed in to change notification settings - Fork 21
/
Copy pathmybusiness_google_rest_v4p4.json
5266 lines (5266 loc) · 221 KB
/
mybusiness_google_rest_v4p4.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/",
"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": {
"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\naccount of the user doing the query will always be the first item of the\nresult, 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\npopulated with a token to fetch the next page of accounts on a\nsubsequent call to `accounts.list`. If there are no more accounts, this\nfield is not present in the response.",
"type": "string"
}
}
},
"Account": {
"id": "Account",
"description": "An account is a container for your business's locations. If you are the only\nuser who manages locations for your business, you can use your personal\nGoogle Account. To share management of locations with multiple users,\n[create a business account]\n(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. <aside class=\"note\"><b>Note:<\/b> For an account\nwith AccountType `PERSONAL`,\nthis is the first and last name of the user account.<\/aside>",
"type": "string"
},
"type": {
"description": "Output only. Specifies the AccountType\nof this account.",
"enumDescriptions": [
"Not specified.",
"An end-user account.",
"A group of Locations.",
"A User Group for segregating organization staff in groups.",
"An organization representing a company."
],
"type": "string",
"enum": [
"ACCOUNT_TYPE_UNSPECIFIED",
"PERSONAL",
"LOCATION_GROUP",
"USER_GROUP",
"ORGANIZATION"
]
},
"role": {
"description": "Output only. Specifies the AccountRole\nthe caller has for this account.",
"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.\n(Displays as 'Site Manager' in UI)."
],
"type": "string",
"enum": [
"ACCOUNT_ROLE_UNSPECIFIED",
"OWNER",
"CO_OWNER",
"MANAGER",
"COMMUNITY_MANAGER"
]
},
"state": {
"description": "Output only. Indicates the AccountState of this account.",
"$ref": "AccountState"
},
"profilePhotoUrl": {
"description": "Profile photo for the account. This is populated only for the personal\naccount.",
"type": "string"
},
"accountNumber": {
"description": "Account reference number if provisioned.",
"type": "string"
},
"permissionLevel": {
"description": "Output only. Specifies the PermissionLevel the caller has for this account.",
"enumDescriptions": [
"Not specified.",
"The user has owner level permission.",
"The user has member level permission."
],
"type": "string",
"enum": [
"PERMISSION_LEVEL_UNSPECIFIED",
"OWNER_LEVEL",
"MEMBER_LEVEL"
]
},
"organizationInfo": {
"description": "Additional info for an organization. This is populated only for an\norganization account.",
"$ref": "OrganizationInfo"
}
}
},
"AccountState": {
"id": "AccountState",
"description": "Indicates status of the account, such as whether the account\nhas been verified by Google.",
"type": "object",
"properties": {
"status": {
"description": "If verified, future locations that are created are automatically\nconnected to Google Maps, and have Google+ pages created, without requiring\nmoderation.",
"enumDescriptions": [
"Not specified.",
"Verified account.",
"Account that is not verified, and verification has not",
"Account that is not verified, but"
],
"type": "string",
"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.\nGiven a postal address, a postal service can deliver items to a premise, P.O.\nBox or similar.\nIt is not intended to model geographical locations (roads, towns,\nmountains).\n\nIn typical usage an address would be created via user input or from importing\nexisting data, depending on the type of process.\n\nAdvice on address input \/ editing:\n - Use an i18n-ready address widget such as\n https:\/\/github.com\/googlei18n\/libaddressinput)\n- Users should not be presented with UI elements for input or editing of\n fields outside countries where that field is used.\n\nFor more guidance on how to use this schema, please see:\nhttps:\/\/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\nthe latest revision.\n\nAll 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\nis never inferred and it is up to the user to ensure the value is\ncorrect. See http:\/\/cldr.unicode.org\/ and\nhttp:\/\/www.unicode.org\/cldr\/charts\/30\/supplemental\/territory_information.html\nfor details. Example: \"CH\" for Switzerland.",
"type": "string"
},
"languageCode": {
"description": "Optional. BCP-47 language code of the contents of this address (if\nknown). This is often the UI language of the input form or is expected\nto match one of the languages used in the address' country\/region, or their\ntransliterated equivalents.\nThis can affect formatting in certain countries, but is not critical\nto the correctness of the data and will never affect any validation or\nother non-formatting related operations.\n\nIf this value is not known, it should be omitted (rather than specifying a\npossibly incorrect default).\n\nExamples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".",
"type": "string"
},
"postalCode": {
"description": "Optional. Postal code of the address. Not all countries use or require\npostal codes to be present, but where they are used, they may trigger\nadditional validation with other parts of the address (e.g. state\/zip\nvalidation in the U.S.A.).",
"type": "string"
},
"sortingCode": {
"description": "Optional. Additional, country-specific, sorting code. This is not used\nin most regions. Where it is used, the value is either a string like\n\"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number\nalone, representing the \"sector code\" (Jamaica), \"delivery area indicator\"\n(Malawi) or \"post office indicator\" (e.g. C\u00F4te d'Ivoire).",
"type": "string"
},
"administrativeArea": {
"description": "Optional. Highest administrative subdivision which is used for postal\naddresses of a country or region.\nFor example, this can be a state, a province, an oblast, or a prefecture.\nSpecifically, for Spain this is the province and not the autonomous\ncommunity (e.g. \"Barcelona\" and not \"Catalonia\").\nMany countries don't use an administrative area in postal addresses. E.g.\nin Switzerland this should be left unpopulated.",
"type": "string"
},
"locality": {
"description": "Optional. Generally refers to the city\/town portion of the address.\nExamples: US city, IT comune, UK post town.\nIn regions of the world where localities are not well defined or do not fit\ninto this structure well, leave locality empty and use address_lines.",
"type": "string"
},
"sublocality": {
"description": "Optional. Sublocality of the address.\nFor example, this can be neighborhoods, boroughs, districts.",
"type": "string"
},
"addressLines": {
"description": "Unstructured address lines describing the lower levels of an address.\n\nBecause values in address_lines do not have type information and may\nsometimes contain multiple values in a single field (e.g.\n\"Austin, TX\"), it is important that the line order is clear. The order of\naddress lines should be \"envelope order\" for the country\/region of the\naddress. In places where this can vary (e.g. Japan), address_language is\nused to make it explicit (e.g. \"ja\" for large-to-small ordering and\n\"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of\nan address can be selected based on the language.\n\nThe minimum permitted structural representation of an address consists\nof a region_code with all remaining information placed in the\naddress_lines. It would be possible to format such an address very\napproximately without geocoding, but no semantic reasoning could be\nmade about any of the address components until it was at least\npartially resolved.\n\nCreating an address only containing a region_code and address_lines, and\nthen geocoding is the recommended way to handle completely unstructured\naddresses (as opposed to guessing which parts of the address should be\nlocalities or administrative areas).",
"type": "array",
"items": {
"type": "string"
}
},
"recipients": {
"description": "Optional. The recipient at the address.\nThis field may, under certain circumstances, contain multiline information.\nFor 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"
}
}
},
"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\nlocation is updated or has a new review. There will be only one notification\nsettings 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\nlocations managed by this account are updated. If unset, no notifications\nwill be posted.\n\nThe account [email protected] must have at\nleast 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.\nAt least one must be specified. To stop receiving notifications entirely,\nuse DeleteNotifications.",
"enumDescriptions": [
"No notification type. Will not match any notifications.",
"The location has Google updates for review. The location_name field on the\nnotification will provide the resource name of the location with Google\nupdates.",
"A new review has been added to the location. The review_name field on the\nnotification will provide the resource name of the review that was added,\nand location_name will have the location's resource name.",
"A review on the location has been updated. The review_name field on the\nnotification will provide the resource name of the review that was added,\nand location_name will have the location's resource name.",
"A new media item has been added to the location by a Google Maps user.\nThe notification will provide the resource name of the new media item."
],
"type": "array",
"items": {
"type": "string",
"enum": [
"NOTIFICATION_TYPE_UNSPECIFIED",
"GOOGLE_UPDATE",
"NEW_REVIEW",
"UPDATED_REVIEW",
"NEW_CUSTOMER_MEDIA"
]
}
}
}
},
"Empty": {
"id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {
}
},
"AcceptInvitationRequest": {
"id": "AcceptInvitationRequest",
"description": "Request message for MyBusiness.AcceptInvitation.",
"type": "object",
"properties": {
}
},
"DeclineInvitationRequest": {
"id": "DeclineInvitationRequest",
"description": "Request message for MyBusiness.DeclineInvitation.",
"type": "object",
"properties": {
}
},
"ListInvitationsResponse": {
"id": "ListInvitationsResponse",
"description": "Response message for MyBusiness.ListInvitations.",
"type": "object",
"properties": {
"invitations": {
"description": "A collection of location invitations that are pending for the account. The\nnumber 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.",
"enumDescriptions": [
"Not specified.",
"The admin has owner-level access and is the primary owner.",
"The admin has owner-level access.",
"The admin has managerial access.",
"The admin can manage social (Google+) pages."
],
"type": "string",
"enum": [
"ADMIN_ROLE_UNSPECIFIED",
"OWNER",
"CO_OWNER",
"MANAGER",
"COMMUNITY_MANAGER"
]
}
}
},
"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 MyBusiness.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\nLocation.",
"type": "object",
"properties": {
"name": {
"description": "The resource name. For account admins, this is in the form:\n`accounts\/{account_id}\/admins\/{admin_id}`\n\nFor location admins, this is in the form:\n`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\ninvitee's email address. On `GET` calls, the user's email address is\nreturned if the invitation is still pending. Otherwise, it contains\nthe user's first and last names.",
"type": "string"
},
"role": {
"description": "Specifies the AdminRole that this\nadmin uses with the specified Account\nor Location resource.",
"enumDescriptions": [
"Not specified.",
"The admin has owner-level access and is the primary owner.",
"The admin has owner-level access.",
"The admin has managerial access.",
"The admin can manage social (Google+) pages."
],
"type": "string",
"enum": [
"ADMIN_ROLE_UNSPECIFIED",
"OWNER",
"CO_OWNER",
"MANAGER",
"COMMUNITY_MANAGER"
]
},
"pendingInvitation": {
"description": "Output only. Indicates whether this admin has a pending invitation for the\nspecified resource.",
"type": "boolean"
}
}
},
"ListLocationAdminsResponse": {
"id": "ListLocationAdminsResponse",
"description": "Response message for MyBusiness.ListLocationAdmins.",
"type": "object",
"properties": {
"admins": {
"description": "A collection of Admin instances.",
"type": "array",
"items": {
"$ref": "Admin"
}
}
}
},
"ListBusinessCategoriesResponse": {
"id": "ListBusinessCategoriesResponse",
"type": "object",
"properties": {
"categories": {
"description": "The categories.",
"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\nwill be populated with a token to fetch the next page of categories\non 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\nvalid category IDs, and the mappings to their human-readable names, see\n[categories.list](\/my-business\/reference\/rest\/v4\/categories\/list).",
"type": "object",
"properties": {
"displayName": {
"description": "Output only. The human-readable name of the category. This is set when\nreading the location. When modifying the location, `category_id` must be\nset.",
"type": "string"
},
"categoryId": {
"description": "A stable ID (provided by Google) for this category.\nThe `category_id` must be specified when modifying the category (when\ncreating or updating a location).",
"type": "string"
}
}
},
"FollowersMetadata": {
"id": "FollowersMetadata",
"description": "Follower metadata for a location.",
"type": "object",
"properties": {
"name": {
"description": "The resource name for this.\naccounts\/{account_id}\/locations\/{location_id}\/followers\/metadata",
"type": "string"
},
"count": {
"description": "Total number of followers for the location.",
"type": "string",
"format": "uint64"
}
}
},
"SearchGoogleLocationsRequest": {
"id": "SearchGoogleLocationsRequest",
"description": "Request message for GoogleLocations.SearchGoogleLocations.",
"type": "object",
"properties": {
"location": {
"description": "Location to search for. If provided, will find locations which match the\nprovided location details.",
"$ref": "Location"
},
"query": {
"description": "Text query to search for. The search results from a query string will be\nless accurate than if providing an exact location, but can provide more\ninexact matches.",
"type": "string"
},
"resultCount": {
"description": "The number of matches to return. The default value is 3, with a maximum\nof 10. Note that latency may increase if more are requested. There is no\npagination.",
"type": "integer",
"format": "int32"
}
}
},
"Location": {
"id": "Location",
"description": "A location.\nSee the [help center article]\n(https:\/\/support.google.com\/business\/answer\/3038177) for a detailed\ndescription of these fields, or the [category\nendpoint](\/my-business\/reference\/rest\/v4\/categories) for a list of valid\nbusiness categories.",
"type": "object",
"properties": {
"name": {
"description": "Google identifier for this location in the form:\n `accounts\/{account_id}\/locations\/{location_id}`\n\nIn the context of matches, this field will not be populated.",
"type": "string"
},
"languageCode": {
"description": "The language of the location. Set during creation and not updateable.",
"type": "string"
},
"storeCode": {
"description": "External identifier for this location, which must be unique inside a given\naccount. This is a means of associating the location with your own records.",
"type": "string"
},
"locationName": {
"description": "Location name should reflect your business's real-world name, as used\nconsistently on your storefront, website, and stationery, and as known to\ncustomers.\nAny additional information, when relevant, can be included in other\nfields of the resource (for example, `Address`, `Categories`).\nDon't add unnecessary information to your name (for example, prefer\n\"Google\" over \"Google Inc. - Mountain View Corporate Headquarters\"). Don't\ninclude marketing taglines, store codes, special characters, hours or\nclosed\/open status, phone numbers, website URLs, service\/product\ninformation, location\/address or directions, or containment information\n(for example, \"Chase ATM in Duane Reade\").",
"type": "string"
},
"primaryPhone": {
"description": "A phone number that connects to your individual business location\nas directly as possible. Use a local phone number instead of a central,\ncall center helpline number whenever possible.",
"type": "string"
},
"additionalPhones": {
"description": "Up to two phone numbers (mobile or landline, no fax) at which your business\ncan be called, in addition to your primary phone number.",
"type": "array",
"items": {
"type": "string"
}
},
"address": {
"description": "A precise, accurate address to describe your business location.\nPO boxes or mailboxes located at remote locations are not acceptable.\nAt this time, you can specify a maximum of five `address_lines` values in\nthe address.",
"$ref": "PostalAddress"
},
"primaryCategory": {
"description": "Category that best describes the core business this location engages in.",
"$ref": "Category"
},
"additionalCategories": {
"description": "Additional categories to describe your business.\nCategories help your customers find accurate, specific results for services\nthey're interested in. To keep your business information accurate\nand live, make sure that you use as few categories as possible to describe\nyour overall core business.\nChoose categories that are as specific as possible, but representative of\nyour main business.",
"type": "array",
"items": {
"$ref": "Category"
}
},
"websiteUrl": {
"description": "A URL for this business. If possible, use a URL that represents this\nindividual business location instead of a generic website\/URL that\nrepresents all locations, or the brand.",
"type": "string"
},
"regularHours": {
"description": "Operating hours for the business.",
"$ref": "BusinessHours"
},
"specialHours": {
"description": "Special hours for the business. This typically includes holiday hours,\nand other times outside of regular operating hours.\nThese override regular business hours.",
"$ref": "SpecialHours"
},
"serviceArea": {
"description": "Service area businesses provide their service at the customer's location.\nIf this business is a service area business, this field describes the\narea(s) serviced by the business.",
"$ref": "ServiceAreaBusiness"
},
"locationKey": {
"description": "A collection of keys that link this business to\nother Google properties, such as a Google+ page and Google Maps Places.",
"$ref": "LocationKey"
},
"labels": {
"description": "A collection of free-form strings to allow you to tag your business. These\nlabels are NOT user facing; only you can see them.\nLimited to 255 characters (per label).",
"type": "array",
"items": {
"type": "string"
}
},
"adWordsLocationExtensions": {
"description": "Additional information that is surfaced in AdWords.",
"$ref": "AdWordsLocationExtensions"
},
"latlng": {
"description": "User-provided latitude and longitude.\nWhen creating a location, this field is ignored if the provided\naddress geocodes successfully.\nThis field is only returned on get requests if the user-provided\n`latlng`\nvalue was accepted during create, or the `latlng` value was updated through\nthe Google My Business website.\nThis field cannot be updated.",
"$ref": "LatLng"
},
"openInfo": {
"description": "A flag that indicates whether the location is currently open for\nbusiness.",
"$ref": "OpenInfo"
},
"locationState": {
"description": "Output only. A set of booleans that reflects the state of a location.",
"$ref": "LocationState"
},
"attributes": {
"description": "Attributes for this location.",
"type": "array",
"items": {
"$ref": "Attribute"
}
},
"metadata": {
"description": "Output Only. Additional non-user-editable information.",
"$ref": "Metadata"
},
"priceLists": {
"description": "Price list information for this location.",
"type": "array",
"items": {
"$ref": "PriceList"
}
},
"profile": {
"description": "Describes your business in your own voice and shares with users the unique\nstory of your business and offerings.",
"$ref": "Profile"
},
"relationshipData": {
"description": "All locations and chain related to this one.",
"$ref": "RelationshipData"
}
}
},
"BusinessHours": {
"id": "BusinessHours",
"description": "Represents the time periods that this location is open for business.\nHolds a collection of TimePeriod\ninstances.",
"type": "object",
"properties": {
"periods": {
"description": "A collection of times that this location is open for business. Each period\nrepresents a range of hours when the location is open during the week.",
"type": "array",
"items": {
"$ref": "TimePeriod"
}
}
}
},
"TimePeriod": {
"id": "TimePeriod",
"description": "Represents a span of time that the business is open, starting on the\nspecified open\nday\/time and closing on the specified close day\/time.\nThe closing time must occur after the opening time, for example later in the\nsame day, or on a subsequent day.",
"type": "object",
"properties": {
"openDay": {
"description": "Indicates the day of the week this period starts\non.",
"enumDescriptions": [
"The unspecified day-of-week.",
"The day-of-week of Monday.",
"The day-of-week of Tuesday.",
"The day-of-week of Wednesday.",
"The day-of-week of Thursday.",
"The day-of-week of Friday.",
"The day-of-week of Saturday.",
"The day-of-week of Sunday."
],
"type": "string",
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"openTime": {
"description": "Time in 24hr ISO 8601 extended format (hh:mm). Valid values are\n00:00-24:00, where 24:00 represents midnight at the end of the specified\nday field.",
"type": "string"
},
"closeDay": {
"description": "Indicates the day of the week this period ends\non.",
"enumDescriptions": [
"The unspecified day-of-week.",
"The day-of-week of Monday.",
"The day-of-week of Tuesday.",
"The day-of-week of Wednesday.",
"The day-of-week of Thursday.",
"The day-of-week of Friday.",
"The day-of-week of Saturday.",
"The day-of-week of Sunday."
],
"type": "string",
"enum": [
"DAY_OF_WEEK_UNSPECIFIED",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
},
"closeTime": {
"description": "Time in 24hr ISO 8601 extended format (hh:mm). Valid values are\n00:00-24:00, where 24:00 represents midnight at the end of the specified\nday field.",
"type": "string"
}
}
},
"SpecialHours": {
"id": "SpecialHours",
"description": "Represents a set of time periods when a location's operational hours differ\nfrom its normal business hours.",
"type": "object",
"properties": {
"specialHourPeriods": {
"description": "A list of exceptions to the business's regular hours.",
"type": "array",
"items": {
"$ref": "SpecialHourPeriod"
}
}
}
},
"SpecialHourPeriod": {
"id": "SpecialHourPeriod",
"description": "Represents a single time period when a location's operational hours differ\nfrom its normal business hours.\nA special hour period must represent a range of less than 24 hours.\nThe `open_time` and `start_date` must predate the `close_time` and\n`end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the\nday after the specified `start_date`. For example, the following inputs are\nvalid:\n\n start_date=2015-11-23, open_time=08:00, close_time=18:00\n start_date=2015-11-23, end_date=2015-11-23, open_time=08:00,\n close_time=18:00 start_date=2015-11-23, end_date=2015-11-24,\n open_time=13:00, close_time=11:59\n\nThe following inputs are not valid:\n\n start_date=2015-11-23, open_time=13:00, close_time=11:59\n start_date=2015-11-23, end_date=2015-11-24, open_time=13:00,\n close_time=12:00 start_date=2015-11-23, end_date=2015-11-25,\n open_time=08:00, close_time=18:00",
"type": "object",
"properties": {
"startDate": {
"description": "The calendar date this special hour period starts on.",
"$ref": "Date"
},
"openTime": {
"description": "The wall time on `start_date` when a location opens, expressed in\n24hr ISO 8601 extended format. (hh:mm) Valid values are 00:00-24:00,\nwhere 24:00 represents midnight at the end of the specified day field.\nMust be specified if `is_closed` is false.",
"type": "string"
},
"endDate": {
"description": "The calendar date this special hour period ends on.\nIf `end_date` field is not set, default to the date specified in\n`start_date`.\nIf set, this field must be equal to or at most 1 day after `start_date`.",
"$ref": "Date"
},
"closeTime": {
"description": "The wall time on `end_date` when a location closes, expressed in\n24hr ISO 8601 extended format. (hh:mm) Valid values are 00:00-24:00,\nwhere 24:00 represents midnight at the end of the specified day field.\nMust be specified if `is_closed` is false.",
"type": "string"
},
"isClosed": {
"description": "If true, `end_date`, `open_time`, and `close_time` are ignored,\nand the date specified in `start_date` is treated as the location being\nclosed for the entire day.",
"type": "boolean"
}
}
},
"Date": {
"id": "Date",
"description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day\nand time zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. This can represent:\n\n* A full date, with non-zero year, month and day values\n* A month and day value, with a zero year, e.g. an anniversary\n* A year on its own, with zero month and day values\n* A year and month value, with a zero day, e.g. a credit card expiration date\n\nRelated types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
"type": "object",
"properties": {
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"type": "integer",
"format": "int32"
},
"month": {
"description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a\nmonth and day.",
"type": "integer",
"format": "int32"
},
"day": {
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year by itself or a year and month where the day is not\nsignificant.",
"type": "integer",
"format": "int32"
}
}
},
"ServiceAreaBusiness": {
"id": "ServiceAreaBusiness",
"description": "Service area businesses provide their service at the customer's location (for\nexample, a locksmith or plumber).",
"type": "object",
"properties": {
"businessType": {
"description": "Indicates the type of the service area\nbusiness.",
"enumDescriptions": [
"Output only. Not specified.",
"Offers service only in the surrounding area (not at the business\naddress).",
"Offers service at the business address and the surrounding area."
],
"type": "string",
"enum": [
"BUSINESS_TYPE_UNSPECIFIED",
"CUSTOMER_LOCATION_ONLY",
"CUSTOMER_AND_BUSINESS_LOCATION"
]
},
"radius": {
"description": "The area that this business serves centered around a point.",
"$ref": "PointRadius"
},
"places": {
"description": "The area that this business serves defined through a set of places.",
"$ref": "Places"
}
}
},
"PointRadius": {
"id": "PointRadius",
"description": "A radius around a particular point (latitude\/longitude).",
"type": "object",
"properties": {
"latlng": {
"description": "The latitude\/longitude that specifies the center of an area defined by the\nradius.",
"$ref": "LatLng"
},
"radiusKm": {
"description": "The distance in kilometers of the area around the point.",
"type": "number",
"format": "float"
}
}
},
"LatLng": {
"id": "LatLng",
"description": "An object representing a latitude\/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n<a href=\"http:\/\/www.unoosa.org\/pdf\/icg\/2012\/template\/WGS_84.pdf\">WGS84\nstandard<\/a>. Values must be within normalized ranges.",
"type": "object",
"properties": {
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"type": "number",
"format": "double"
},
"longitude": {
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"type": "number",
"format": "double"
}
}
},
"Places": {
"id": "Places",
"description": "Defines the union of areas represented by a set of places.",
"type": "object",
"properties": {
"placeInfos": {
"description": "The areas represented by place IDs.",
"type": "array",
"items": {
"$ref": "PlaceInfo"
}
}
}
},
"PlaceInfo": {
"id": "PlaceInfo",
"description": "Defines an area that's represented by a place ID.",
"type": "object",
"properties": {
"name": {
"description": "The localized name of the place. For example, `Scottsdale, AZ`.",
"type": "string"
},
"placeId": {
"description": "The ID of the place.",
"type": "string"
}
}
},
"LocationKey": {
"id": "LocationKey",
"description": "Alternate\/surrogate key references for a location.",
"type": "object",
"properties": {
"plusPageId": {
"description": "Output only. If this location has a Google+ page associated with it, this\nis populated with the Google+ page ID for this location.",
"type": "string"
},
"placeId": {
"description": "If this location has been verified and is connected to\/appears on Google\nMaps, this field is populated with the place ID for the location.\nThis ID can be used in various Places APIs.\n\nIf this location is unverified, this field may be populated if the location\nhas been associated with a place that appears on Google Maps.\n\nThis field can be set during Create calls, but not for Update.\n\nThe additional `explicit_no_place_id` bool qualifies whether an unset\nplace ID is deliberate or not.",
"type": "string"
},
"explicitNoPlaceId": {
"description": "Output only. A value of true indicates that an unset place ID is\ndeliberate, which is different from no association being made yet.",
"type": "boolean"
},
"requestId": {
"description": "Output only. The `request_id` used to create this location. May be empty if\nthis location was created outside of the GMB API or Google My Business\nLocations.",
"type": "string"
}
}
},
"AdWordsLocationExtensions": {
"id": "AdWordsLocationExtensions",
"description": "Additional information that is surfaced in AdWords.",
"type": "object",
"properties": {
"adPhone": {
"description": "An alternate phone number to display on AdWords location extensions\ninstead of the location's primary phone number.",
"type": "string"
}
}
},
"OpenInfo": {
"id": "OpenInfo",
"description": "Information related to the opening state of the business.",
"type": "object",
"properties": {
"status": {
"description": "Indicates whether or not the Location is currently open for business.\nAll locations are open by default, unless updated to be closed.",
"enumDescriptions": [
"Not specified.",
"Indicates that the location is open.",
"Indicates that the location has been permanently closed."
],
"type": "string",
"enum": [
"OPEN_FOR_BUSINESS_UNSPECIFIED",
"OPEN",
"CLOSED_PERMANENTLY"
]
},
"canReopen": {
"description": "Output only. Indicates whether this business is eligible for re-open.",
"type": "boolean"
},
"openingDate": {
"description": "The date on which the location first opened. If the exact day is not known,\nmonth and year only can be provided. The date must be in the past or be\nno more than one year in the future.",
"$ref": "Date"
}
}
},
"LocationState": {
"id": "LocationState",
"description": "Contains a set of booleans that reflect the state of a Location.",
"type": "object",
"properties": {
"isGoogleUpdated": {
"description": "Output only. Indicates whether the place ID associated with this location\nhas updates.",
"type": "boolean"
},
"isDuplicate": {
"description": "Output only. Indicates whether the location is a duplicate of another\nlocation. For more information, see\n[metadata.duplicate](\/my-business\/reference\/rest\/v4\/accounts.locations#Duplicate).",
"type": "boolean"
},
"isSuspended": {
"description": "Output only. Indicates whether the location is suspended.\nSuspended locations are not visible to end users in Google products.\nIf you believe this was a mistake, see the [help center article]\n(https:\/\/support.google.com\/business\/answer\/4569145).",
"type": "boolean"
},
"canUpdate": {
"description": "Output only. Indicates whether the location can be updated.",