google-api-client 0.23.7 → 0.23.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (89) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +32 -0
  3. data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
  4. data/generated/google/apis/androidpublisher_v2.rb +1 -1
  5. data/generated/google/apis/androidpublisher_v2/classes.rb +1 -0
  6. data/generated/google/apis/androidpublisher_v3.rb +1 -1
  7. data/generated/google/apis/androidpublisher_v3/classes.rb +1 -0
  8. data/generated/google/apis/appengine_v1.rb +1 -1
  9. data/generated/google/apis/appengine_v1/classes.rb +5 -3
  10. data/generated/google/apis/appengine_v1beta.rb +1 -1
  11. data/generated/google/apis/appengine_v1beta/classes.rb +31 -3
  12. data/generated/google/apis/appengine_v1beta/representations.rb +15 -0
  13. data/generated/google/apis/appengine_v1beta4.rb +1 -1
  14. data/generated/google/apis/appengine_v1beta4/classes.rb +5 -3
  15. data/generated/google/apis/appengine_v1beta5.rb +1 -1
  16. data/generated/google/apis/appengine_v1beta5/classes.rb +5 -3
  17. data/generated/google/apis/bigquery_v2.rb +1 -1
  18. data/generated/google/apis/bigquery_v2/classes.rb +27 -22
  19. data/generated/google/apis/bigquery_v2/representations.rb +1 -0
  20. data/generated/google/apis/cloudkms_v1.rb +1 -1
  21. data/generated/google/apis/{mybusiness_v3.rb → cloudtasks_v2beta3.rb} +12 -10
  22. data/generated/google/apis/cloudtasks_v2beta3/classes.rb +1405 -0
  23. data/generated/google/apis/cloudtasks_v2beta3/representations.rb +421 -0
  24. data/generated/google/apis/cloudtasks_v2beta3/service.rb +855 -0
  25. data/generated/google/apis/compute_alpha/classes.rb +178 -135
  26. data/generated/google/apis/compute_alpha/representations.rb +82 -52
  27. data/generated/google/apis/compute_alpha/service.rb +57 -4
  28. data/generated/google/apis/compute_beta/classes.rb +125 -125
  29. data/generated/google/apis/compute_beta/representations.rb +51 -51
  30. data/generated/google/apis/compute_beta/service.rb +4 -4
  31. data/generated/google/apis/content_v2.rb +1 -1
  32. data/generated/google/apis/content_v2/classes.rb +152 -0
  33. data/generated/google/apis/content_v2/representations.rb +77 -0
  34. data/generated/google/apis/content_v2/service.rb +40 -0
  35. data/generated/google/apis/content_v2sandbox.rb +1 -1
  36. data/generated/google/apis/content_v2sandbox/classes.rb +39 -0
  37. data/generated/google/apis/content_v2sandbox/representations.rb +26 -0
  38. data/generated/google/apis/content_v2sandbox/service.rb +40 -0
  39. data/generated/google/apis/dataflow_v1b3.rb +1 -1
  40. data/generated/google/apis/dataproc_v1.rb +1 -1
  41. data/generated/google/apis/dataproc_v1/classes.rb +299 -0
  42. data/generated/google/apis/dataproc_v1/representations.rb +115 -0
  43. data/generated/google/apis/dataproc_v1/service.rb +540 -0
  44. data/generated/google/apis/dataproc_v1beta2.rb +1 -1
  45. data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
  46. data/generated/google/apis/dialogflow_v2beta1/classes.rb +0 -3
  47. data/generated/google/apis/dialogflow_v2beta1/service.rb +226 -0
  48. data/generated/google/apis/dlp_v2.rb +1 -1
  49. data/generated/google/apis/dlp_v2/service.rb +54 -6
  50. data/generated/google/apis/firebasedynamiclinks_v1.rb +1 -1
  51. data/generated/google/apis/firebasedynamiclinks_v1/classes.rb +85 -0
  52. data/generated/google/apis/firebasedynamiclinks_v1/representations.rb +32 -0
  53. data/generated/google/apis/firebasedynamiclinks_v1/service.rb +30 -0
  54. data/generated/google/apis/iamcredentials_v1.rb +1 -1
  55. data/generated/google/apis/iamcredentials_v1/classes.rb +97 -0
  56. data/generated/google/apis/iamcredentials_v1/representations.rb +28 -0
  57. data/generated/google/apis/iamcredentials_v1/service.rb +37 -0
  58. data/generated/google/apis/language_v1beta2.rb +1 -1
  59. data/generated/google/apis/language_v1beta2/classes.rb +8 -0
  60. data/generated/google/apis/redis_v1beta1.rb +1 -1
  61. data/generated/google/apis/redis_v1beta1/classes.rb +9 -0
  62. data/generated/google/apis/redis_v1beta1/representations.rb +1 -0
  63. data/generated/google/apis/servicecontrol_v1.rb +1 -1
  64. data/generated/google/apis/servicecontrol_v1/classes.rb +12 -0
  65. data/generated/google/apis/servicecontrol_v1/representations.rb +1 -0
  66. data/generated/google/apis/servicemanagement_v1.rb +1 -1
  67. data/generated/google/apis/servicemanagement_v1/classes.rb +1 -1
  68. data/generated/google/apis/servicemanagement_v1/service.rb +4 -0
  69. data/generated/google/apis/serviceuser_v1.rb +1 -1
  70. data/generated/google/apis/serviceuser_v1/classes.rb +1 -1
  71. data/generated/google/apis/spanner_v1.rb +1 -1
  72. data/generated/google/apis/spanner_v1/classes.rb +56 -1
  73. data/generated/google/apis/spanner_v1/representations.rb +18 -0
  74. data/generated/google/apis/spanner_v1/service.rb +9 -3
  75. data/generated/google/apis/speech_v1.rb +1 -1
  76. data/generated/google/apis/speech_v1/classes.rb +11 -8
  77. data/generated/google/apis/storage_v1.rb +1 -1
  78. data/generated/google/apis/storage_v1/classes.rb +11 -1
  79. data/generated/google/apis/storage_v1/representations.rb +1 -0
  80. data/generated/google/apis/storage_v1/service.rb +1 -2
  81. data/generated/google/apis/testing_v1.rb +1 -1
  82. data/generated/google/apis/toolresults_v1beta3.rb +1 -1
  83. data/generated/google/apis/toolresults_v1beta3/classes.rb +14 -14
  84. data/generated/google/apis/youtube_partner_v1.rb +1 -1
  85. data/lib/google/apis/version.rb +1 -1
  86. metadata +6 -6
  87. data/generated/google/apis/mybusiness_v3/classes.rb +0 -1864
  88. data/generated/google/apis/mybusiness_v3/representations.rb +0 -741
  89. data/generated/google/apis/mybusiness_v3/service.rb +0 -961
@@ -1,961 +0,0 @@
1
- # Copyright 2015 Google Inc.
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # http://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
- require 'google/apis/core/base_service'
16
- require 'google/apis/core/json_representation'
17
- require 'google/apis/core/hashable'
18
- require 'google/apis/errors'
19
-
20
- module Google
21
- module Apis
22
- module MybusinessV3
23
- # Google My Business API
24
- #
25
- # The Google My Business API provides an interface for managing business
26
- # location information on Google.
27
- #
28
- # @example
29
- # require 'google/apis/mybusiness_v3'
30
- #
31
- # Mybusiness = Google::Apis::MybusinessV3 # Alias the module
32
- # service = Mybusiness::MybusinessService.new
33
- #
34
- # @see https://developers.google.com/my-business/
35
- class MybusinessService < Google::Apis::Core::BaseService
36
- # @return [String]
37
- # API key. Your API key identifies your project and provides you with API access,
38
- # quota, and reports. Required unless you provide an OAuth 2.0 token.
39
- attr_accessor :key
40
-
41
- # @return [String]
42
- # Available to use for quota purposes for server-side applications. Can be any
43
- # arbitrary string assigned to a user, but should not exceed 40 characters.
44
- attr_accessor :quota_user
45
-
46
- def initialize
47
- super('https://mybusiness.googleapis.com/', '')
48
- @batch_path = 'batch'
49
- end
50
-
51
- # Gets the specified account. Returns `NOT_FOUND` if the
52
- # account does not exist or if the caller does not have access rights to it.
53
- # @param [String] name
54
- # The name of the account to fetch.
55
- # @param [String] fields
56
- # Selector specifying which fields to include in a partial response.
57
- # @param [String] quota_user
58
- # Available to use for quota purposes for server-side applications. Can be any
59
- # arbitrary string assigned to a user, but should not exceed 40 characters.
60
- # @param [Google::Apis::RequestOptions] options
61
- # Request-specific options
62
- #
63
- # @yield [result, err] Result & error if block supplied
64
- # @yieldparam result [Google::Apis::MybusinessV3::Account] parsed result object
65
- # @yieldparam err [StandardError] error object if request failed
66
- #
67
- # @return [Google::Apis::MybusinessV3::Account]
68
- #
69
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
70
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
71
- # @raise [Google::Apis::AuthorizationError] Authorization is required
72
- def get_account(name, fields: nil, quota_user: nil, options: nil, &block)
73
- command = make_simple_command(:get, 'v3/{+name}', options)
74
- command.response_representation = Google::Apis::MybusinessV3::Account::Representation
75
- command.response_class = Google::Apis::MybusinessV3::Account
76
- command.params['name'] = name unless name.nil?
77
- command.query['fields'] = fields unless fields.nil?
78
- command.query['quotaUser'] = quota_user unless quota_user.nil?
79
- execute_or_queue_command(command, &block)
80
- end
81
-
82
- # Lists all of the accounts for the authenticated user. This includes all
83
- # accounts that the user owns, as well as any accounts for which the user
84
- # has management rights.
85
- # @param [Fixnum] page_size
86
- # How many accounts to fetch per page. Default is 50,
87
- # minimum is 1, and maximum page size is 50.
88
- # @param [String] page_token
89
- # If specified, the next page of accounts is retrieved. The `pageToken` is
90
- # returned when a call to `accounts.list` returns more results than can fit
91
- # into the requested page size.
92
- # @param [String] fields
93
- # Selector specifying which fields to include in a partial response.
94
- # @param [String] quota_user
95
- # Available to use for quota purposes for server-side applications. Can be any
96
- # arbitrary string assigned to a user, but should not exceed 40 characters.
97
- # @param [Google::Apis::RequestOptions] options
98
- # Request-specific options
99
- #
100
- # @yield [result, err] Result & error if block supplied
101
- # @yieldparam result [Google::Apis::MybusinessV3::ListAccountsResponse] parsed result object
102
- # @yieldparam err [StandardError] error object if request failed
103
- #
104
- # @return [Google::Apis::MybusinessV3::ListAccountsResponse]
105
- #
106
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
107
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
108
- # @raise [Google::Apis::AuthorizationError] Authorization is required
109
- def list_accounts(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
110
- command = make_simple_command(:get, 'v3/accounts', options)
111
- command.response_representation = Google::Apis::MybusinessV3::ListAccountsResponse::Representation
112
- command.response_class = Google::Apis::MybusinessV3::ListAccountsResponse
113
- command.query['pageSize'] = page_size unless page_size.nil?
114
- command.query['pageToken'] = page_token unless page_token.nil?
115
- command.query['fields'] = fields unless fields.nil?
116
- command.query['quotaUser'] = quota_user unless quota_user.nil?
117
- execute_or_queue_command(command, &block)
118
- end
119
-
120
- # Updates the specified business account. Personal accounts cannot be
121
- # updated using this method.
122
- # Note: At this time the only editable field for an account is
123
- # `account_name`.
124
- # Any other fields passed in (such as `type`, `role`, and `verified`) is
125
- # ignored.
126
- # @param [String] name
127
- # The name of the account to update.
128
- # @param [Google::Apis::MybusinessV3::Account] account_object
129
- # @param [String] language_code
130
- # The language of the account update.
131
- # @param [Boolean] validate_only
132
- # If true, the request is validated without actually updating the account.
133
- # @param [String] fields
134
- # Selector specifying which fields to include in a partial response.
135
- # @param [String] quota_user
136
- # Available to use for quota purposes for server-side applications. Can be any
137
- # arbitrary string assigned to a user, but should not exceed 40 characters.
138
- # @param [Google::Apis::RequestOptions] options
139
- # Request-specific options
140
- #
141
- # @yield [result, err] Result & error if block supplied
142
- # @yieldparam result [Google::Apis::MybusinessV3::Account] parsed result object
143
- # @yieldparam err [StandardError] error object if request failed
144
- #
145
- # @return [Google::Apis::MybusinessV3::Account]
146
- #
147
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
148
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
149
- # @raise [Google::Apis::AuthorizationError] Authorization is required
150
- def update_account(name, account_object = nil, language_code: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
151
- command = make_simple_command(:put, 'v3/{+name}', options)
152
- command.request_representation = Google::Apis::MybusinessV3::Account::Representation
153
- command.request_object = account_object
154
- command.response_representation = Google::Apis::MybusinessV3::Account::Representation
155
- command.response_class = Google::Apis::MybusinessV3::Account
156
- command.params['name'] = name unless name.nil?
157
- command.query['languageCode'] = language_code unless language_code.nil?
158
- command.query['validateOnly'] = validate_only unless validate_only.nil?
159
- command.query['fields'] = fields unless fields.nil?
160
- command.query['quotaUser'] = quota_user unless quota_user.nil?
161
- execute_or_queue_command(command, &block)
162
- end
163
-
164
- # Invites the specified user to become an administrator on the specified
165
- # account. The invitee must accept the invitation in order to be granted
166
- # access to the account.
167
- # @param [String] name
168
- # The resource name. For account admins, this is in the form:
169
- # `accounts/`account_id`/admins/`admin_id``
170
- # For location admins, this is in the form:
171
- # `accounts/`account_id`/locations/`location_id`/admins/`admin_id``
172
- # @param [Google::Apis::MybusinessV3::Admin] admin_object
173
- # @param [String] fields
174
- # Selector specifying which fields to include in a partial response.
175
- # @param [String] quota_user
176
- # Available to use for quota purposes for server-side applications. Can be any
177
- # arbitrary string assigned to a user, but should not exceed 40 characters.
178
- # @param [Google::Apis::RequestOptions] options
179
- # Request-specific options
180
- #
181
- # @yield [result, err] Result & error if block supplied
182
- # @yieldparam result [Google::Apis::MybusinessV3::Admin] parsed result object
183
- # @yieldparam err [StandardError] error object if request failed
184
- #
185
- # @return [Google::Apis::MybusinessV3::Admin]
186
- #
187
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
188
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
189
- # @raise [Google::Apis::AuthorizationError] Authorization is required
190
- def create_account_admin(name, admin_object = nil, fields: nil, quota_user: nil, options: nil, &block)
191
- command = make_simple_command(:post, 'v3/{+name}/admins', options)
192
- command.request_representation = Google::Apis::MybusinessV3::Admin::Representation
193
- command.request_object = admin_object
194
- command.response_representation = Google::Apis::MybusinessV3::Admin::Representation
195
- command.response_class = Google::Apis::MybusinessV3::Admin
196
- command.params['name'] = name unless name.nil?
197
- command.query['fields'] = fields unless fields.nil?
198
- command.query['quotaUser'] = quota_user unless quota_user.nil?
199
- execute_or_queue_command(command, &block)
200
- end
201
-
202
- # Removes the specified admin from the specified account.
203
- # @param [String] name
204
- # The resource name of the admin to remove from the account.
205
- # @param [String] fields
206
- # Selector specifying which fields to include in a partial response.
207
- # @param [String] quota_user
208
- # Available to use for quota purposes for server-side applications. Can be any
209
- # arbitrary string assigned to a user, but should not exceed 40 characters.
210
- # @param [Google::Apis::RequestOptions] options
211
- # Request-specific options
212
- #
213
- # @yield [result, err] Result & error if block supplied
214
- # @yieldparam result [Google::Apis::MybusinessV3::Empty] parsed result object
215
- # @yieldparam err [StandardError] error object if request failed
216
- #
217
- # @return [Google::Apis::MybusinessV3::Empty]
218
- #
219
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
220
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
221
- # @raise [Google::Apis::AuthorizationError] Authorization is required
222
- def delete_account_admin(name, fields: nil, quota_user: nil, options: nil, &block)
223
- command = make_simple_command(:delete, 'v3/{+name}', options)
224
- command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
225
- command.response_class = Google::Apis::MybusinessV3::Empty
226
- command.params['name'] = name unless name.nil?
227
- command.query['fields'] = fields unless fields.nil?
228
- command.query['quotaUser'] = quota_user unless quota_user.nil?
229
- execute_or_queue_command(command, &block)
230
- end
231
-
232
- # Lists the admins for the specified account.
233
- # @param [String] name
234
- # The name of the account from which to retrieve a list of admins.
235
- # @param [String] fields
236
- # Selector specifying which fields to include in a partial response.
237
- # @param [String] quota_user
238
- # Available to use for quota purposes for server-side applications. Can be any
239
- # arbitrary string assigned to a user, but should not exceed 40 characters.
240
- # @param [Google::Apis::RequestOptions] options
241
- # Request-specific options
242
- #
243
- # @yield [result, err] Result & error if block supplied
244
- # @yieldparam result [Google::Apis::MybusinessV3::ListAccountAdminsResponse] parsed result object
245
- # @yieldparam err [StandardError] error object if request failed
246
- #
247
- # @return [Google::Apis::MybusinessV3::ListAccountAdminsResponse]
248
- #
249
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
250
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
251
- # @raise [Google::Apis::AuthorizationError] Authorization is required
252
- def list_account_admins(name, fields: nil, quota_user: nil, options: nil, &block)
253
- command = make_simple_command(:get, 'v3/{+name}/admins', options)
254
- command.response_representation = Google::Apis::MybusinessV3::ListAccountAdminsResponse::Representation
255
- command.response_class = Google::Apis::MybusinessV3::ListAccountAdminsResponse
256
- command.params['name'] = name unless name.nil?
257
- command.query['fields'] = fields unless fields.nil?
258
- command.query['quotaUser'] = quota_user unless quota_user.nil?
259
- execute_or_queue_command(command, &block)
260
- end
261
-
262
- # Associates a location to a place ID. Any previous association is
263
- # overwritten. This operation is only valid if the location is unverified.
264
- # The association must be valid, i.e. appear in the list of
265
- # FindMatchingLocations.
266
- # @param [String] name
267
- # The resource name of the location to associate.
268
- # @param [Google::Apis::MybusinessV3::AssociateLocationRequest] associate_location_request_object
269
- # @param [String] fields
270
- # Selector specifying which fields to include in a partial response.
271
- # @param [String] quota_user
272
- # Available to use for quota purposes for server-side applications. Can be any
273
- # arbitrary string assigned to a user, but should not exceed 40 characters.
274
- # @param [Google::Apis::RequestOptions] options
275
- # Request-specific options
276
- #
277
- # @yield [result, err] Result & error if block supplied
278
- # @yieldparam result [Google::Apis::MybusinessV3::Empty] parsed result object
279
- # @yieldparam err [StandardError] error object if request failed
280
- #
281
- # @return [Google::Apis::MybusinessV3::Empty]
282
- #
283
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
284
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
285
- # @raise [Google::Apis::AuthorizationError] Authorization is required
286
- def associate_location(name, associate_location_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
287
- command = make_simple_command(:post, 'v3/{+name}:associate', options)
288
- command.request_representation = Google::Apis::MybusinessV3::AssociateLocationRequest::Representation
289
- command.request_object = associate_location_request_object
290
- command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
291
- command.response_class = Google::Apis::MybusinessV3::Empty
292
- command.params['name'] = name unless name.nil?
293
- command.query['fields'] = fields unless fields.nil?
294
- command.query['quotaUser'] = quota_user unless quota_user.nil?
295
- execute_or_queue_command(command, &block)
296
- end
297
-
298
- # Gets all of the specified locations in the given account.
299
- # @param [String] name
300
- # The name of the account from which to fetch locations.
301
- # @param [Google::Apis::MybusinessV3::BatchGetLocationsRequest] batch_get_locations_request_object
302
- # @param [String] fields
303
- # Selector specifying which fields to include in a partial response.
304
- # @param [String] quota_user
305
- # Available to use for quota purposes for server-side applications. Can be any
306
- # arbitrary string assigned to a user, but should not exceed 40 characters.
307
- # @param [Google::Apis::RequestOptions] options
308
- # Request-specific options
309
- #
310
- # @yield [result, err] Result & error if block supplied
311
- # @yieldparam result [Google::Apis::MybusinessV3::BatchGetLocationsResponse] parsed result object
312
- # @yieldparam err [StandardError] error object if request failed
313
- #
314
- # @return [Google::Apis::MybusinessV3::BatchGetLocationsResponse]
315
- #
316
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
317
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
318
- # @raise [Google::Apis::AuthorizationError] Authorization is required
319
- def batch_get_locations(name, batch_get_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
320
- command = make_simple_command(:post, 'v3/{+name}/locations:batchGet', options)
321
- command.request_representation = Google::Apis::MybusinessV3::BatchGetLocationsRequest::Representation
322
- command.request_object = batch_get_locations_request_object
323
- command.response_representation = Google::Apis::MybusinessV3::BatchGetLocationsResponse::Representation
324
- command.response_class = Google::Apis::MybusinessV3::BatchGetLocationsResponse
325
- command.params['name'] = name unless name.nil?
326
- command.query['fields'] = fields unless fields.nil?
327
- command.query['quotaUser'] = quota_user unless quota_user.nil?
328
- execute_or_queue_command(command, &block)
329
- end
330
-
331
- # Clears an assocation between a location and its place ID. This
332
- # operation is only valid if the location is unverified.
333
- # @param [String] name
334
- # The resource name of the location to disassociate.
335
- # @param [Google::Apis::MybusinessV3::ClearLocationAssociationRequest] clear_location_association_request_object
336
- # @param [String] fields
337
- # Selector specifying which fields to include in a partial response.
338
- # @param [String] quota_user
339
- # Available to use for quota purposes for server-side applications. Can be any
340
- # arbitrary string assigned to a user, but should not exceed 40 characters.
341
- # @param [Google::Apis::RequestOptions] options
342
- # Request-specific options
343
- #
344
- # @yield [result, err] Result & error if block supplied
345
- # @yieldparam result [Google::Apis::MybusinessV3::Empty] parsed result object
346
- # @yieldparam err [StandardError] error object if request failed
347
- #
348
- # @return [Google::Apis::MybusinessV3::Empty]
349
- #
350
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
351
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
352
- # @raise [Google::Apis::AuthorizationError] Authorization is required
353
- def clear_account_location_association(name, clear_location_association_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
354
- command = make_simple_command(:post, 'v3/{+name}:clearAssociation', options)
355
- command.request_representation = Google::Apis::MybusinessV3::ClearLocationAssociationRequest::Representation
356
- command.request_object = clear_location_association_request_object
357
- command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
358
- command.response_class = Google::Apis::MybusinessV3::Empty
359
- command.params['name'] = name unless name.nil?
360
- command.query['fields'] = fields unless fields.nil?
361
- command.query['quotaUser'] = quota_user unless quota_user.nil?
362
- execute_or_queue_command(command, &block)
363
- end
364
-
365
- # Creates a new location owned by the
366
- # specified account, and returns it.
367
- # @param [String] name
368
- # The name of the account in which to create this location.
369
- # @param [Google::Apis::MybusinessV3::Location] location_object
370
- # @param [String] language_code
371
- # The language of the location update. Currently this is used to disambiguate
372
- # what localized categories are valid for this create request.
373
- # @param [String] request_id
374
- # A unique request ID for the server to detect duplicated requests. UUIDs are
375
- # recommended. Max length is 50 characters.
376
- # @param [Boolean] validate_only
377
- # If true, the request is validated without actually creating the location.
378
- # @param [String] fields
379
- # Selector specifying which fields to include in a partial response.
380
- # @param [String] quota_user
381
- # Available to use for quota purposes for server-side applications. Can be any
382
- # arbitrary string assigned to a user, but should not exceed 40 characters.
383
- # @param [Google::Apis::RequestOptions] options
384
- # Request-specific options
385
- #
386
- # @yield [result, err] Result & error if block supplied
387
- # @yieldparam result [Google::Apis::MybusinessV3::Location] parsed result object
388
- # @yieldparam err [StandardError] error object if request failed
389
- #
390
- # @return [Google::Apis::MybusinessV3::Location]
391
- #
392
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
393
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
394
- # @raise [Google::Apis::AuthorizationError] Authorization is required
395
- def create_account_location(name, location_object = nil, language_code: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
396
- command = make_simple_command(:post, 'v3/{+name}/locations', options)
397
- command.request_representation = Google::Apis::MybusinessV3::Location::Representation
398
- command.request_object = location_object
399
- command.response_representation = Google::Apis::MybusinessV3::Location::Representation
400
- command.response_class = Google::Apis::MybusinessV3::Location
401
- command.params['name'] = name unless name.nil?
402
- command.query['languageCode'] = language_code unless language_code.nil?
403
- command.query['requestId'] = request_id unless request_id.nil?
404
- command.query['validateOnly'] = validate_only unless validate_only.nil?
405
- command.query['fields'] = fields unless fields.nil?
406
- command.query['quotaUser'] = quota_user unless quota_user.nil?
407
- execute_or_queue_command(command, &block)
408
- end
409
-
410
- # Deletes a location. Note: If this location has an associated Google+ page, as
411
- # indicated by a `plus_page_id` in the LocationKey, it cannot be deleted using
412
- # the API, it
413
- # must be done using the [Google My Business]
414
- # (https://www.google.com/local/manage/) website.
415
- # Returns `NOT_FOUND` if the location does not exist.
416
- # @param [String] name
417
- # The name of the location to delete.
418
- # @param [String] fields
419
- # Selector specifying which fields to include in a partial response.
420
- # @param [String] quota_user
421
- # Available to use for quota purposes for server-side applications. Can be any
422
- # arbitrary string assigned to a user, but should not exceed 40 characters.
423
- # @param [Google::Apis::RequestOptions] options
424
- # Request-specific options
425
- #
426
- # @yield [result, err] Result & error if block supplied
427
- # @yieldparam result [Google::Apis::MybusinessV3::Empty] parsed result object
428
- # @yieldparam err [StandardError] error object if request failed
429
- #
430
- # @return [Google::Apis::MybusinessV3::Empty]
431
- #
432
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
433
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
434
- # @raise [Google::Apis::AuthorizationError] Authorization is required
435
- def delete_account_location(name, fields: nil, quota_user: nil, options: nil, &block)
436
- command = make_simple_command(:delete, 'v3/{+name}', options)
437
- command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
438
- command.response_class = Google::Apis::MybusinessV3::Empty
439
- command.params['name'] = name unless name.nil?
440
- command.query['fields'] = fields unless fields.nil?
441
- command.query['quotaUser'] = quota_user unless quota_user.nil?
442
- execute_or_queue_command(command, &block)
443
- end
444
-
445
- # Finds all of the possible locations that are a match to the specified
446
- # location. This operation is only valid if the location is unverified.
447
- # @param [String] name
448
- # The resource name of the location to find matches for.
449
- # @param [Google::Apis::MybusinessV3::FindMatchingLocationsRequest] find_matching_locations_request_object
450
- # @param [String] fields
451
- # Selector specifying which fields to include in a partial response.
452
- # @param [String] quota_user
453
- # Available to use for quota purposes for server-side applications. Can be any
454
- # arbitrary string assigned to a user, but should not exceed 40 characters.
455
- # @param [Google::Apis::RequestOptions] options
456
- # Request-specific options
457
- #
458
- # @yield [result, err] Result & error if block supplied
459
- # @yieldparam result [Google::Apis::MybusinessV3::FindMatchingLocationsResponse] parsed result object
460
- # @yieldparam err [StandardError] error object if request failed
461
- #
462
- # @return [Google::Apis::MybusinessV3::FindMatchingLocationsResponse]
463
- #
464
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
465
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
466
- # @raise [Google::Apis::AuthorizationError] Authorization is required
467
- def find_account_location_matches(name, find_matching_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
468
- command = make_simple_command(:post, 'v3/{+name}:findMatches', options)
469
- command.request_representation = Google::Apis::MybusinessV3::FindMatchingLocationsRequest::Representation
470
- command.request_object = find_matching_locations_request_object
471
- command.response_representation = Google::Apis::MybusinessV3::FindMatchingLocationsResponse::Representation
472
- command.response_class = Google::Apis::MybusinessV3::FindMatchingLocationsResponse
473
- command.params['name'] = name unless name.nil?
474
- command.query['fields'] = fields unless fields.nil?
475
- command.query['quotaUser'] = quota_user unless quota_user.nil?
476
- execute_or_queue_command(command, &block)
477
- end
478
-
479
- # Gets the specified location. Returns `NOT_FOUND` if the
480
- # location does not exist.
481
- # @param [String] name
482
- # The name of the location to fetch.
483
- # @param [String] fields
484
- # Selector specifying which fields to include in a partial response.
485
- # @param [String] quota_user
486
- # Available to use for quota purposes for server-side applications. Can be any
487
- # arbitrary string assigned to a user, but should not exceed 40 characters.
488
- # @param [Google::Apis::RequestOptions] options
489
- # Request-specific options
490
- #
491
- # @yield [result, err] Result & error if block supplied
492
- # @yieldparam result [Google::Apis::MybusinessV3::Location] parsed result object
493
- # @yieldparam err [StandardError] error object if request failed
494
- #
495
- # @return [Google::Apis::MybusinessV3::Location]
496
- #
497
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
498
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
499
- # @raise [Google::Apis::AuthorizationError] Authorization is required
500
- def get_account_location(name, fields: nil, quota_user: nil, options: nil, &block)
501
- command = make_simple_command(:get, 'v3/{+name}', options)
502
- command.response_representation = Google::Apis::MybusinessV3::Location::Representation
503
- command.response_class = Google::Apis::MybusinessV3::Location
504
- command.params['name'] = name unless name.nil?
505
- command.query['fields'] = fields unless fields.nil?
506
- command.query['quotaUser'] = quota_user unless quota_user.nil?
507
- execute_or_queue_command(command, &block)
508
- end
509
-
510
- # Gets the Google updated version of the specified location.
511
- # Returns `NOT_FOUND` if the location does not exist.
512
- # @param [String] name
513
- # The name of the location to fetch.
514
- # @param [String] fields
515
- # Selector specifying which fields to include in a partial response.
516
- # @param [String] quota_user
517
- # Available to use for quota purposes for server-side applications. Can be any
518
- # arbitrary string assigned to a user, but should not exceed 40 characters.
519
- # @param [Google::Apis::RequestOptions] options
520
- # Request-specific options
521
- #
522
- # @yield [result, err] Result & error if block supplied
523
- # @yieldparam result [Google::Apis::MybusinessV3::GoogleUpdatedLocation] parsed result object
524
- # @yieldparam err [StandardError] error object if request failed
525
- #
526
- # @return [Google::Apis::MybusinessV3::GoogleUpdatedLocation]
527
- #
528
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
529
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
530
- # @raise [Google::Apis::AuthorizationError] Authorization is required
531
- def get_google_updated_account_location(name, fields: nil, quota_user: nil, options: nil, &block)
532
- command = make_simple_command(:get, 'v3/{+name}:googleUpdated', options)
533
- command.response_representation = Google::Apis::MybusinessV3::GoogleUpdatedLocation::Representation
534
- command.response_class = Google::Apis::MybusinessV3::GoogleUpdatedLocation
535
- command.params['name'] = name unless name.nil?
536
- command.query['fields'] = fields unless fields.nil?
537
- command.query['quotaUser'] = quota_user unless quota_user.nil?
538
- execute_or_queue_command(command, &block)
539
- end
540
-
541
- # Lists the locations for the specified account.
542
- # @param [String] name
543
- # The name of the account to fetch locations from.
544
- # @param [String] filter
545
- # A filter constraining the locations to return. The response includes
546
- # only entries that match the filter. If `filter` is empty, then
547
- # constraints are applied and all locations (paginated) are retrieved for
548
- # the requested account.
549
- # Further information on valid filter fields and example usage is available
550
- # [here](https://developers.google.com/my-business/content/location-data#
551
- # filter_results_when_listing_locations)
552
- # .
553
- # @param [Fixnum] page_size
554
- # How many locations to fetch per page. Default is 100,
555
- # minimum is 1, and maximum page size is 100.
556
- # @param [String] page_token
557
- # If specified, it fetches the next `page` of locations. The page token
558
- # is returned by previous calls to ListLocations when there were more
559
- # locations than could fit in the requested page size.
560
- # @param [String] fields
561
- # Selector specifying which fields to include in a partial response.
562
- # @param [String] quota_user
563
- # Available to use for quota purposes for server-side applications. Can be any
564
- # arbitrary string assigned to a user, but should not exceed 40 characters.
565
- # @param [Google::Apis::RequestOptions] options
566
- # Request-specific options
567
- #
568
- # @yield [result, err] Result & error if block supplied
569
- # @yieldparam result [Google::Apis::MybusinessV3::ListLocationsResponse] parsed result object
570
- # @yieldparam err [StandardError] error object if request failed
571
- #
572
- # @return [Google::Apis::MybusinessV3::ListLocationsResponse]
573
- #
574
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
575
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
576
- # @raise [Google::Apis::AuthorizationError] Authorization is required
577
- def list_account_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
578
- command = make_simple_command(:get, 'v3/{+name}/locations', options)
579
- command.response_representation = Google::Apis::MybusinessV3::ListLocationsResponse::Representation
580
- command.response_class = Google::Apis::MybusinessV3::ListLocationsResponse
581
- command.params['name'] = name unless name.nil?
582
- command.query['filter'] = filter unless filter.nil?
583
- command.query['pageSize'] = page_size unless page_size.nil?
584
- command.query['pageToken'] = page_token unless page_token.nil?
585
- command.query['fields'] = fields unless fields.nil?
586
- command.query['quotaUser'] = quota_user unless quota_user.nil?
587
- execute_or_queue_command(command, &block)
588
- end
589
-
590
- # Updates the specified location.
591
- # Photos are only allowed on a location that has a Google+ page.
592
- # Returns `NOT_FOUND` if the location does not exist.
593
- # @param [String] name
594
- # The name of the location to update.
595
- # @param [Google::Apis::MybusinessV3::Location] location_object
596
- # @param [String] field_mask
597
- # The specific fields to update. If no mask is specified, then this is
598
- # treated as a full update and all fields are set to the values passed
599
- # in, which may include unsetting empty fields in the request.
600
- # @param [String] language_code
601
- # The language of the location update. Currently this is used to disambiguate
602
- # what localized categories are valid for this update request.
603
- # @param [Boolean] validate_only
604
- # If true, the request is validated without actually updating the location.
605
- # @param [String] fields
606
- # Selector specifying which fields to include in a partial response.
607
- # @param [String] quota_user
608
- # Available to use for quota purposes for server-side applications. Can be any
609
- # arbitrary string assigned to a user, but should not exceed 40 characters.
610
- # @param [Google::Apis::RequestOptions] options
611
- # Request-specific options
612
- #
613
- # @yield [result, err] Result & error if block supplied
614
- # @yieldparam result [Google::Apis::MybusinessV3::Location] parsed result object
615
- # @yieldparam err [StandardError] error object if request failed
616
- #
617
- # @return [Google::Apis::MybusinessV3::Location]
618
- #
619
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
620
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
621
- # @raise [Google::Apis::AuthorizationError] Authorization is required
622
- def patch_account_location(name, location_object = nil, field_mask: nil, language_code: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
623
- command = make_simple_command(:patch, 'v3/{+name}', options)
624
- command.request_representation = Google::Apis::MybusinessV3::Location::Representation
625
- command.request_object = location_object
626
- command.response_representation = Google::Apis::MybusinessV3::Location::Representation
627
- command.response_class = Google::Apis::MybusinessV3::Location
628
- command.params['name'] = name unless name.nil?
629
- command.query['fieldMask'] = field_mask unless field_mask.nil?
630
- command.query['languageCode'] = language_code unless language_code.nil?
631
- command.query['validateOnly'] = validate_only unless validate_only.nil?
632
- command.query['fields'] = fields unless fields.nil?
633
- command.query['quotaUser'] = quota_user unless quota_user.nil?
634
- execute_or_queue_command(command, &block)
635
- end
636
-
637
- # Transfer a location from one account to another. The current account that
638
- # the location is associated with and the destination account must have the
639
- # same ultimate owner. Returns the Location with its new resource name.
640
- # @param [String] name
641
- # The name of the location to transfer.
642
- # @param [Google::Apis::MybusinessV3::TransferLocationRequest] transfer_location_request_object
643
- # @param [String] fields
644
- # Selector specifying which fields to include in a partial response.
645
- # @param [String] quota_user
646
- # Available to use for quota purposes for server-side applications. Can be any
647
- # arbitrary string assigned to a user, but should not exceed 40 characters.
648
- # @param [Google::Apis::RequestOptions] options
649
- # Request-specific options
650
- #
651
- # @yield [result, err] Result & error if block supplied
652
- # @yieldparam result [Google::Apis::MybusinessV3::Location] parsed result object
653
- # @yieldparam err [StandardError] error object if request failed
654
- #
655
- # @return [Google::Apis::MybusinessV3::Location]
656
- #
657
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
658
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
659
- # @raise [Google::Apis::AuthorizationError] Authorization is required
660
- def transfer_location(name, transfer_location_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
661
- command = make_simple_command(:post, 'v3/{+name}:transfer', options)
662
- command.request_representation = Google::Apis::MybusinessV3::TransferLocationRequest::Representation
663
- command.request_object = transfer_location_request_object
664
- command.response_representation = Google::Apis::MybusinessV3::Location::Representation
665
- command.response_class = Google::Apis::MybusinessV3::Location
666
- command.params['name'] = name unless name.nil?
667
- command.query['fields'] = fields unless fields.nil?
668
- command.query['quotaUser'] = quota_user unless quota_user.nil?
669
- execute_or_queue_command(command, &block)
670
- end
671
-
672
- # Invites the specified user to become an administrator on the specified
673
- # location. The invitee must accept the invitation in order to be granted
674
- # access to the location.
675
- # @param [String] name
676
- # The resource name. For account admins, this is in the form:
677
- # `accounts/`account_id`/admins/`admin_id``
678
- # For location admins, this is in the form:
679
- # `accounts/`account_id`/locations/`location_id`/admins/`admin_id``
680
- # @param [Google::Apis::MybusinessV3::Admin] admin_object
681
- # @param [String] fields
682
- # Selector specifying which fields to include in a partial response.
683
- # @param [String] quota_user
684
- # Available to use for quota purposes for server-side applications. Can be any
685
- # arbitrary string assigned to a user, but should not exceed 40 characters.
686
- # @param [Google::Apis::RequestOptions] options
687
- # Request-specific options
688
- #
689
- # @yield [result, err] Result & error if block supplied
690
- # @yieldparam result [Google::Apis::MybusinessV3::Admin] parsed result object
691
- # @yieldparam err [StandardError] error object if request failed
692
- #
693
- # @return [Google::Apis::MybusinessV3::Admin]
694
- #
695
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
696
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
697
- # @raise [Google::Apis::AuthorizationError] Authorization is required
698
- def create_account_location_admin(name, admin_object = nil, fields: nil, quota_user: nil, options: nil, &block)
699
- command = make_simple_command(:post, 'v3/{+name}/admins', options)
700
- command.request_representation = Google::Apis::MybusinessV3::Admin::Representation
701
- command.request_object = admin_object
702
- command.response_representation = Google::Apis::MybusinessV3::Admin::Representation
703
- command.response_class = Google::Apis::MybusinessV3::Admin
704
- command.params['name'] = name unless name.nil?
705
- command.query['fields'] = fields unless fields.nil?
706
- command.query['quotaUser'] = quota_user unless quota_user.nil?
707
- execute_or_queue_command(command, &block)
708
- end
709
-
710
- # Removes the specified admin as a manager of the specified location.
711
- # @param [String] name
712
- # The resource name of the admin to remove from the location.
713
- # @param [String] fields
714
- # Selector specifying which fields to include in a partial response.
715
- # @param [String] quota_user
716
- # Available to use for quota purposes for server-side applications. Can be any
717
- # arbitrary string assigned to a user, but should not exceed 40 characters.
718
- # @param [Google::Apis::RequestOptions] options
719
- # Request-specific options
720
- #
721
- # @yield [result, err] Result & error if block supplied
722
- # @yieldparam result [Google::Apis::MybusinessV3::Empty] parsed result object
723
- # @yieldparam err [StandardError] error object if request failed
724
- #
725
- # @return [Google::Apis::MybusinessV3::Empty]
726
- #
727
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
728
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
729
- # @raise [Google::Apis::AuthorizationError] Authorization is required
730
- def delete_account_location_admin(name, fields: nil, quota_user: nil, options: nil, &block)
731
- command = make_simple_command(:delete, 'v3/{+name}', options)
732
- command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
733
- command.response_class = Google::Apis::MybusinessV3::Empty
734
- command.params['name'] = name unless name.nil?
735
- command.query['fields'] = fields unless fields.nil?
736
- command.query['quotaUser'] = quota_user unless quota_user.nil?
737
- execute_or_queue_command(command, &block)
738
- end
739
-
740
- # Lists all of the admins for the specified location.
741
- # @param [String] name
742
- # The name of the location to list admins of.
743
- # @param [String] fields
744
- # Selector specifying which fields to include in a partial response.
745
- # @param [String] quota_user
746
- # Available to use for quota purposes for server-side applications. Can be any
747
- # arbitrary string assigned to a user, but should not exceed 40 characters.
748
- # @param [Google::Apis::RequestOptions] options
749
- # Request-specific options
750
- #
751
- # @yield [result, err] Result & error if block supplied
752
- # @yieldparam result [Google::Apis::MybusinessV3::ListLocationAdminsResponse] parsed result object
753
- # @yieldparam err [StandardError] error object if request failed
754
- #
755
- # @return [Google::Apis::MybusinessV3::ListLocationAdminsResponse]
756
- #
757
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
758
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
759
- # @raise [Google::Apis::AuthorizationError] Authorization is required
760
- def list_account_location_admins(name, fields: nil, quota_user: nil, options: nil, &block)
761
- command = make_simple_command(:get, 'v3/{+name}/admins', options)
762
- command.response_representation = Google::Apis::MybusinessV3::ListLocationAdminsResponse::Representation
763
- command.response_class = Google::Apis::MybusinessV3::ListLocationAdminsResponse
764
- command.params['name'] = name unless name.nil?
765
- command.query['fields'] = fields unless fields.nil?
766
- command.query['quotaUser'] = quota_user unless quota_user.nil?
767
- execute_or_queue_command(command, &block)
768
- end
769
-
770
- # Deletes the response to the specified review.
771
- # This operation is only valid if the specified location is verified.
772
- # @param [String] name
773
- # The name of the review reply to delete.
774
- # @param [String] fields
775
- # Selector specifying which fields to include in a partial response.
776
- # @param [String] quota_user
777
- # Available to use for quota purposes for server-side applications. Can be any
778
- # arbitrary string assigned to a user, but should not exceed 40 characters.
779
- # @param [Google::Apis::RequestOptions] options
780
- # Request-specific options
781
- #
782
- # @yield [result, err] Result & error if block supplied
783
- # @yieldparam result [Google::Apis::MybusinessV3::Empty] parsed result object
784
- # @yieldparam err [StandardError] error object if request failed
785
- #
786
- # @return [Google::Apis::MybusinessV3::Empty]
787
- #
788
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
789
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
790
- # @raise [Google::Apis::AuthorizationError] Authorization is required
791
- def delete_reply(name, fields: nil, quota_user: nil, options: nil, &block)
792
- command = make_simple_command(:delete, 'v3/{+name}/reply', options)
793
- command.response_representation = Google::Apis::MybusinessV3::Empty::Representation
794
- command.response_class = Google::Apis::MybusinessV3::Empty
795
- command.params['name'] = name unless name.nil?
796
- command.query['fields'] = fields unless fields.nil?
797
- command.query['quotaUser'] = quota_user unless quota_user.nil?
798
- execute_or_queue_command(command, &block)
799
- end
800
-
801
- # Returns the specified review.
802
- # This operation is only valid if the specified location is verified.
803
- # Returns `NOT_FOUND` if the review does not exist, or has been deleted.
804
- # @param [String] name
805
- # The name of the review to fetch.
806
- # @param [String] fields
807
- # Selector specifying which fields to include in a partial response.
808
- # @param [String] quota_user
809
- # Available to use for quota purposes for server-side applications. Can be any
810
- # arbitrary string assigned to a user, but should not exceed 40 characters.
811
- # @param [Google::Apis::RequestOptions] options
812
- # Request-specific options
813
- #
814
- # @yield [result, err] Result & error if block supplied
815
- # @yieldparam result [Google::Apis::MybusinessV3::Review] parsed result object
816
- # @yieldparam err [StandardError] error object if request failed
817
- #
818
- # @return [Google::Apis::MybusinessV3::Review]
819
- #
820
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
821
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
822
- # @raise [Google::Apis::AuthorizationError] Authorization is required
823
- def get_review(name, fields: nil, quota_user: nil, options: nil, &block)
824
- command = make_simple_command(:get, 'v3/{+name}', options)
825
- command.response_representation = Google::Apis::MybusinessV3::Review::Representation
826
- command.response_class = Google::Apis::MybusinessV3::Review
827
- command.params['name'] = name unless name.nil?
828
- command.query['fields'] = fields unless fields.nil?
829
- command.query['quotaUser'] = quota_user unless quota_user.nil?
830
- execute_or_queue_command(command, &block)
831
- end
832
-
833
- # Returns the paginated list of reviews for the specified location.
834
- # This operation is only valid if the specified location is verified.
835
- # @param [String] name
836
- # The name of the location to fetch reviews for.
837
- # @param [String] order_by
838
- # Specifies the field to sort reviews by.
839
- # If unspecified, the order of reviews returned will
840
- # default to "update_timedesc".
841
- # Valid orders to sort by are `rating` and `ratingdesc` and `update_timedesc`.
842
- # @param [Fixnum] page_size
843
- # How many reviews to fetch per page. The maximum page_size is 200.
844
- # @param [String] page_token
845
- # If specified, it fetches the next ‘page’ of reviews.
846
- # @param [String] fields
847
- # Selector specifying which fields to include in a partial response.
848
- # @param [String] quota_user
849
- # Available to use for quota purposes for server-side applications. Can be any
850
- # arbitrary string assigned to a user, but should not exceed 40 characters.
851
- # @param [Google::Apis::RequestOptions] options
852
- # Request-specific options
853
- #
854
- # @yield [result, err] Result & error if block supplied
855
- # @yieldparam result [Google::Apis::MybusinessV3::ListReviewsResponse] parsed result object
856
- # @yieldparam err [StandardError] error object if request failed
857
- #
858
- # @return [Google::Apis::MybusinessV3::ListReviewsResponse]
859
- #
860
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
861
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
862
- # @raise [Google::Apis::AuthorizationError] Authorization is required
863
- def list_reviews(name, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
864
- command = make_simple_command(:get, 'v3/{+name}/reviews', options)
865
- command.response_representation = Google::Apis::MybusinessV3::ListReviewsResponse::Representation
866
- command.response_class = Google::Apis::MybusinessV3::ListReviewsResponse
867
- command.params['name'] = name unless name.nil?
868
- command.query['orderBy'] = order_by unless order_by.nil?
869
- command.query['pageSize'] = page_size unless page_size.nil?
870
- command.query['pageToken'] = page_token unless page_token.nil?
871
- command.query['fields'] = fields unless fields.nil?
872
- command.query['quotaUser'] = quota_user unless quota_user.nil?
873
- execute_or_queue_command(command, &block)
874
- end
875
-
876
- # Updates the reply to the specified review.
877
- # A reply is created if one does not exist.
878
- # This operation is only valid if the specified location is verified.
879
- # @param [String] name
880
- # The name of the review to respond to.
881
- # @param [Google::Apis::MybusinessV3::ReviewReply] review_reply_object
882
- # @param [String] fields
883
- # Selector specifying which fields to include in a partial response.
884
- # @param [String] quota_user
885
- # Available to use for quota purposes for server-side applications. Can be any
886
- # arbitrary string assigned to a user, but should not exceed 40 characters.
887
- # @param [Google::Apis::RequestOptions] options
888
- # Request-specific options
889
- #
890
- # @yield [result, err] Result & error if block supplied
891
- # @yieldparam result [Google::Apis::MybusinessV3::ReviewReply] parsed result object
892
- # @yieldparam err [StandardError] error object if request failed
893
- #
894
- # @return [Google::Apis::MybusinessV3::ReviewReply]
895
- #
896
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
897
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
898
- # @raise [Google::Apis::AuthorizationError] Authorization is required
899
- def reply_to_review(name, review_reply_object = nil, fields: nil, quota_user: nil, options: nil, &block)
900
- command = make_simple_command(:post, 'v3/{+name}/reply', options)
901
- command.request_representation = Google::Apis::MybusinessV3::ReviewReply::Representation
902
- command.request_object = review_reply_object
903
- command.response_representation = Google::Apis::MybusinessV3::ReviewReply::Representation
904
- command.response_class = Google::Apis::MybusinessV3::ReviewReply
905
- command.params['name'] = name unless name.nil?
906
- command.query['fields'] = fields unless fields.nil?
907
- command.query['quotaUser'] = quota_user unless quota_user.nil?
908
- execute_or_queue_command(command, &block)
909
- end
910
-
911
- # Returns the list of available attributes that would be available for a
912
- # location with the given primary category and country.
913
- # @param [String] category_id
914
- # The primary category stable id to find available attributes.
915
- # @param [String] country
916
- # The ISO 3166-1 alpha-2 country code to find available attributes.
917
- # @param [String] language_code
918
- # The BCP 47 code of language to get attribute display names in. If this
919
- # language is not available, they will be provided in English.
920
- # @param [String] name
921
- # Resource name of the location to lookup available attributes.
922
- # @param [String] fields
923
- # Selector specifying which fields to include in a partial response.
924
- # @param [String] quota_user
925
- # Available to use for quota purposes for server-side applications. Can be any
926
- # arbitrary string assigned to a user, but should not exceed 40 characters.
927
- # @param [Google::Apis::RequestOptions] options
928
- # Request-specific options
929
- #
930
- # @yield [result, err] Result & error if block supplied
931
- # @yieldparam result [Google::Apis::MybusinessV3::ListLocationAttributeMetadataResponse] parsed result object
932
- # @yieldparam err [StandardError] error object if request failed
933
- #
934
- # @return [Google::Apis::MybusinessV3::ListLocationAttributeMetadataResponse]
935
- #
936
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
937
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
938
- # @raise [Google::Apis::AuthorizationError] Authorization is required
939
- def list_attributes(category_id: nil, country: nil, language_code: nil, name: nil, fields: nil, quota_user: nil, options: nil, &block)
940
- command = make_simple_command(:get, 'v3/attributes', options)
941
- command.response_representation = Google::Apis::MybusinessV3::ListLocationAttributeMetadataResponse::Representation
942
- command.response_class = Google::Apis::MybusinessV3::ListLocationAttributeMetadataResponse
943
- command.query['categoryId'] = category_id unless category_id.nil?
944
- command.query['country'] = country unless country.nil?
945
- command.query['languageCode'] = language_code unless language_code.nil?
946
- command.query['name'] = name unless name.nil?
947
- command.query['fields'] = fields unless fields.nil?
948
- command.query['quotaUser'] = quota_user unless quota_user.nil?
949
- execute_or_queue_command(command, &block)
950
- end
951
-
952
- protected
953
-
954
- def apply_command_defaults(command)
955
- command.query['key'] = key unless key.nil?
956
- command.query['quotaUser'] = quota_user unless quota_user.nil?
957
- end
958
- end
959
- end
960
- end
961
- end