google-apis-analyticsadmin_v1beta 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1744 @@
1
+ # Copyright 2020 Google LLC
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 AnalyticsadminV1beta
23
+ # Google Analytics Admin API
24
+ #
25
+ #
26
+ #
27
+ # @example
28
+ # require 'google/apis/analyticsadmin_v1beta'
29
+ #
30
+ # Analyticsadmin = Google::Apis::AnalyticsadminV1beta # Alias the module
31
+ # service = Analyticsadmin::GoogleAnalyticsAdminService.new
32
+ #
33
+ # @see http://code.google.com/apis/analytics/docs/mgmt/home.html
34
+ class GoogleAnalyticsAdminService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ attr_accessor :quota_user
44
+
45
+ def initialize
46
+ super('https://analyticsadmin.googleapis.com/', '',
47
+ client_name: 'google-apis-analyticsadmin_v1beta',
48
+ client_version: Google::Apis::AnalyticsadminV1beta::GEM_VERSION)
49
+ @batch_path = 'batch'
50
+ end
51
+
52
+ # Returns summaries of all accounts accessible by the caller.
53
+ # @param [Fixnum] page_size
54
+ # The maximum number of AccountSummary resources to return. The service may
55
+ # return fewer than this value, even if there are additional pages. If
56
+ # unspecified, at most 50 resources will be returned. The maximum value is 200; (
57
+ # higher values will be coerced to the maximum)
58
+ # @param [String] page_token
59
+ # A page token, received from a previous `ListAccountSummaries` call. Provide
60
+ # this to retrieve the subsequent page. When paginating, all other parameters
61
+ # provided to `ListAccountSummaries` must match the call that provided the page
62
+ # token.
63
+ # @param [String] fields
64
+ # Selector specifying which fields to include in a partial response.
65
+ # @param [String] quota_user
66
+ # Available to use for quota purposes for server-side applications. Can be any
67
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
68
+ # @param [Google::Apis::RequestOptions] options
69
+ # Request-specific options
70
+ #
71
+ # @yield [result, err] Result & error if block supplied
72
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountSummariesResponse] parsed result object
73
+ # @yieldparam err [StandardError] error object if request failed
74
+ #
75
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountSummariesResponse]
76
+ #
77
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
78
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
79
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
80
+ def list_account_summaries(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
81
+ command = make_simple_command(:get, 'v1beta/accountSummaries', options)
82
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountSummariesResponse::Representation
83
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountSummariesResponse
84
+ command.query['pageSize'] = page_size unless page_size.nil?
85
+ command.query['pageToken'] = page_token unless page_token.nil?
86
+ command.query['fields'] = fields unless fields.nil?
87
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
88
+ execute_or_queue_command(command, &block)
89
+ end
90
+
91
+ # Marks target Account as soft-deleted (ie: "trashed") and returns it. This API
92
+ # does not have a method to restore soft-deleted accounts. However, they can be
93
+ # restored using the Trash Can UI. If the accounts are not restored before the
94
+ # expiration time, the account and all child resources (eg: Properties,
95
+ # GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://
96
+ # support.google.com/analytics/answer/6154772 Returns an error if the target is
97
+ # not found.
98
+ # @param [String] name
99
+ # Required. The name of the Account to soft-delete. Format: accounts/`account`
100
+ # Example: "accounts/100"
101
+ # @param [String] fields
102
+ # Selector specifying which fields to include in a partial response.
103
+ # @param [String] quota_user
104
+ # Available to use for quota purposes for server-side applications. Can be any
105
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
106
+ # @param [Google::Apis::RequestOptions] options
107
+ # Request-specific options
108
+ #
109
+ # @yield [result, err] Result & error if block supplied
110
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty] parsed result object
111
+ # @yieldparam err [StandardError] error object if request failed
112
+ #
113
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty]
114
+ #
115
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
116
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
117
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
118
+ def delete_account(name, fields: nil, quota_user: nil, options: nil, &block)
119
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
120
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
121
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
122
+ command.params['name'] = name unless name.nil?
123
+ command.query['fields'] = fields unless fields.nil?
124
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
125
+ execute_or_queue_command(command, &block)
126
+ end
127
+
128
+ # Lookup for a single Account.
129
+ # @param [String] name
130
+ # Required. The name of the account to lookup. Format: accounts/`account`
131
+ # Example: "accounts/100"
132
+ # @param [String] fields
133
+ # Selector specifying which fields to include in a partial response.
134
+ # @param [String] quota_user
135
+ # Available to use for quota purposes for server-side applications. Can be any
136
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
137
+ # @param [Google::Apis::RequestOptions] options
138
+ # Request-specific options
139
+ #
140
+ # @yield [result, err] Result & error if block supplied
141
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount] parsed result object
142
+ # @yieldparam err [StandardError] error object if request failed
143
+ #
144
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount]
145
+ #
146
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
147
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
148
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
149
+ def get_account(name, fields: nil, quota_user: nil, options: nil, &block)
150
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
151
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount::Representation
152
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount
153
+ command.params['name'] = name unless name.nil?
154
+ command.query['fields'] = fields unless fields.nil?
155
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
156
+ execute_or_queue_command(command, &block)
157
+ end
158
+
159
+ # Get data sharing settings on an account. Data sharing settings are singletons.
160
+ # @param [String] name
161
+ # Required. The name of the settings to lookup. Format: accounts/`account`/
162
+ # dataSharingSettings Example: "accounts/1000/dataSharingSettings"
163
+ # @param [String] fields
164
+ # Selector specifying which fields to include in a partial response.
165
+ # @param [String] quota_user
166
+ # Available to use for quota purposes for server-side applications. Can be any
167
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
168
+ # @param [Google::Apis::RequestOptions] options
169
+ # Request-specific options
170
+ #
171
+ # @yield [result, err] Result & error if block supplied
172
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataSharingSettings] parsed result object
173
+ # @yieldparam err [StandardError] error object if request failed
174
+ #
175
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataSharingSettings]
176
+ #
177
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
178
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
179
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
180
+ def get_account_data_sharing_settings(name, fields: nil, quota_user: nil, options: nil, &block)
181
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
182
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataSharingSettings::Representation
183
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataSharingSettings
184
+ command.params['name'] = name unless name.nil?
185
+ command.query['fields'] = fields unless fields.nil?
186
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
187
+ execute_or_queue_command(command, &block)
188
+ end
189
+
190
+ # Returns all accounts accessible by the caller. Note that these accounts might
191
+ # not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are
192
+ # excluded by default. Returns an empty list if no relevant accounts are found.
193
+ # @param [Fixnum] page_size
194
+ # The maximum number of resources to return. The service may return fewer than
195
+ # this value, even if there are additional pages. If unspecified, at most 50
196
+ # resources will be returned. The maximum value is 200; (higher values will be
197
+ # coerced to the maximum)
198
+ # @param [String] page_token
199
+ # A page token, received from a previous `ListAccounts` call. Provide this to
200
+ # retrieve the subsequent page. When paginating, all other parameters provided
201
+ # to `ListAccounts` must match the call that provided the page token.
202
+ # @param [Boolean] show_deleted
203
+ # Whether to include soft-deleted (ie: "trashed") Accounts in the results.
204
+ # Accounts can be inspected to determine whether they are deleted or not.
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::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountsResponse] parsed result object
215
+ # @yieldparam err [StandardError] error object if request failed
216
+ #
217
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountsResponse]
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 list_accounts(page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
223
+ command = make_simple_command(:get, 'v1beta/accounts', options)
224
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountsResponse::Representation
225
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListAccountsResponse
226
+ command.query['pageSize'] = page_size unless page_size.nil?
227
+ command.query['pageToken'] = page_token unless page_token.nil?
228
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
229
+ command.query['fields'] = fields unless fields.nil?
230
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
231
+ execute_or_queue_command(command, &block)
232
+ end
233
+
234
+ # Updates an account.
235
+ # @param [String] name
236
+ # Output only. Resource name of this account. Format: accounts/`account` Example:
237
+ # "accounts/100"
238
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount] google_analytics_admin_v1beta_account_object
239
+ # @param [String] update_mask
240
+ # Required. The list of fields to be updated. Field names must be in snake case (
241
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
242
+ # entire entity, use one path with the string "*" to match all fields.
243
+ # @param [String] fields
244
+ # Selector specifying which fields to include in a partial response.
245
+ # @param [String] quota_user
246
+ # Available to use for quota purposes for server-side applications. Can be any
247
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
248
+ # @param [Google::Apis::RequestOptions] options
249
+ # Request-specific options
250
+ #
251
+ # @yield [result, err] Result & error if block supplied
252
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount] parsed result object
253
+ # @yieldparam err [StandardError] error object if request failed
254
+ #
255
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount]
256
+ #
257
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
258
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
259
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
260
+ def patch_account(name, google_analytics_admin_v1beta_account_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
261
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
262
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount::Representation
263
+ command.request_object = google_analytics_admin_v1beta_account_object
264
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount::Representation
265
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAccount
266
+ command.params['name'] = name unless name.nil?
267
+ command.query['updateMask'] = update_mask unless update_mask.nil?
268
+ command.query['fields'] = fields unless fields.nil?
269
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
270
+ execute_or_queue_command(command, &block)
271
+ end
272
+
273
+ # Requests a ticket for creating an account.
274
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest] google_analytics_admin_v1beta_provision_account_ticket_request_object
275
+ # @param [String] fields
276
+ # Selector specifying which fields to include in a partial response.
277
+ # @param [String] quota_user
278
+ # Available to use for quota purposes for server-side applications. Can be any
279
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
280
+ # @param [Google::Apis::RequestOptions] options
281
+ # Request-specific options
282
+ #
283
+ # @yield [result, err] Result & error if block supplied
284
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse] parsed result object
285
+ # @yieldparam err [StandardError] error object if request failed
286
+ #
287
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse]
288
+ #
289
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
290
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
291
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
292
+ def provision_account_account_ticket(google_analytics_admin_v1beta_provision_account_ticket_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
293
+ command = make_simple_command(:post, 'v1beta/accounts:provisionAccountTicket', options)
294
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest::Representation
295
+ command.request_object = google_analytics_admin_v1beta_provision_account_ticket_request_object
296
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse::Representation
297
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse
298
+ command.query['fields'] = fields unless fields.nil?
299
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
300
+ execute_or_queue_command(command, &block)
301
+ end
302
+
303
+ # Searches through all changes to an account or its children given the specified
304
+ # set of filters.
305
+ # @param [String] account
306
+ # Required. The account resource for which to return change history resources.
307
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest] google_analytics_admin_v1beta_search_change_history_events_request_object
308
+ # @param [String] fields
309
+ # Selector specifying which fields to include in a partial response.
310
+ # @param [String] quota_user
311
+ # Available to use for quota purposes for server-side applications. Can be any
312
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
313
+ # @param [Google::Apis::RequestOptions] options
314
+ # Request-specific options
315
+ #
316
+ # @yield [result, err] Result & error if block supplied
317
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse] parsed result object
318
+ # @yieldparam err [StandardError] error object if request failed
319
+ #
320
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse]
321
+ #
322
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
323
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
324
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
325
+ def search_account_change_history_events(account, google_analytics_admin_v1beta_search_change_history_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
326
+ command = make_simple_command(:post, 'v1beta/{+account}:searchChangeHistoryEvents', options)
327
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest::Representation
328
+ command.request_object = google_analytics_admin_v1beta_search_change_history_events_request_object
329
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse::Representation
330
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse
331
+ command.params['account'] = account unless account.nil?
332
+ command.query['fields'] = fields unless fields.nil?
333
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
334
+ execute_or_queue_command(command, &block)
335
+ end
336
+
337
+ # Acknowledges the terms of user data collection for the specified property.
338
+ # This acknowledgement must be completed (either in the Google Analytics UI or
339
+ # via this API) before MeasurementProtocolSecret resources may be created.
340
+ # @param [String] property
341
+ # Required. The property for which to acknowledge user data collection.
342
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest] google_analytics_admin_v1beta_acknowledge_user_data_collection_request_object
343
+ # @param [String] fields
344
+ # Selector specifying which fields to include in a partial response.
345
+ # @param [String] quota_user
346
+ # Available to use for quota purposes for server-side applications. Can be any
347
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
348
+ # @param [Google::Apis::RequestOptions] options
349
+ # Request-specific options
350
+ #
351
+ # @yield [result, err] Result & error if block supplied
352
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse] parsed result object
353
+ # @yieldparam err [StandardError] error object if request failed
354
+ #
355
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse]
356
+ #
357
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
358
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
359
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
360
+ def acknowledge_property_user_data_collection(property, google_analytics_admin_v1beta_acknowledge_user_data_collection_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
361
+ command = make_simple_command(:post, 'v1beta/{+property}:acknowledgeUserDataCollection', options)
362
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest::Representation
363
+ command.request_object = google_analytics_admin_v1beta_acknowledge_user_data_collection_request_object
364
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse::Representation
365
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse
366
+ command.params['property'] = property unless property.nil?
367
+ command.query['fields'] = fields unless fields.nil?
368
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
369
+ execute_or_queue_command(command, &block)
370
+ end
371
+
372
+ # Creates an "GA4" property with the specified location and attributes.
373
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty] google_analytics_admin_v1beta_property_object
374
+ # @param [String] fields
375
+ # Selector specifying which fields to include in a partial response.
376
+ # @param [String] quota_user
377
+ # Available to use for quota purposes for server-side applications. Can be any
378
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
379
+ # @param [Google::Apis::RequestOptions] options
380
+ # Request-specific options
381
+ #
382
+ # @yield [result, err] Result & error if block supplied
383
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty] parsed result object
384
+ # @yieldparam err [StandardError] error object if request failed
385
+ #
386
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty]
387
+ #
388
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
389
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
390
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
391
+ def create_property(google_analytics_admin_v1beta_property_object = nil, fields: nil, quota_user: nil, options: nil, &block)
392
+ command = make_simple_command(:post, 'v1beta/properties', options)
393
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
394
+ command.request_object = google_analytics_admin_v1beta_property_object
395
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
396
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty
397
+ command.query['fields'] = fields unless fields.nil?
398
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
399
+ execute_or_queue_command(command, &block)
400
+ end
401
+
402
+ # Marks target Property as soft-deleted (ie: "trashed") and returns it. This API
403
+ # does not have a method to restore soft-deleted properties. However, they can
404
+ # be restored using the Trash Can UI. If the properties are not restored before
405
+ # the expiration time, the Property and all child resources (eg: GoogleAdsLinks,
406
+ # Streams, UserLinks) will be permanently purged. https://support.google.com/
407
+ # analytics/answer/6154772 Returns an error if the target is not found, or is
408
+ # not a GA4 Property.
409
+ # @param [String] name
410
+ # Required. The name of the Property to soft-delete. Format: properties/`
411
+ # property_id` Example: "properties/1000"
412
+ # @param [String] fields
413
+ # Selector specifying which fields to include in a partial response.
414
+ # @param [String] quota_user
415
+ # Available to use for quota purposes for server-side applications. Can be any
416
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
417
+ # @param [Google::Apis::RequestOptions] options
418
+ # Request-specific options
419
+ #
420
+ # @yield [result, err] Result & error if block supplied
421
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty] parsed result object
422
+ # @yieldparam err [StandardError] error object if request failed
423
+ #
424
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty]
425
+ #
426
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
427
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
428
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
429
+ def delete_property(name, fields: nil, quota_user: nil, options: nil, &block)
430
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
431
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
432
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty
433
+ command.params['name'] = name unless name.nil?
434
+ command.query['fields'] = fields unless fields.nil?
435
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
436
+ execute_or_queue_command(command, &block)
437
+ end
438
+
439
+ # Lookup for a single "GA4" Property.
440
+ # @param [String] name
441
+ # Required. The name of the property to lookup. Format: properties/`property_id`
442
+ # Example: "properties/1000"
443
+ # @param [String] fields
444
+ # Selector specifying which fields to include in a partial response.
445
+ # @param [String] quota_user
446
+ # Available to use for quota purposes for server-side applications. Can be any
447
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
448
+ # @param [Google::Apis::RequestOptions] options
449
+ # Request-specific options
450
+ #
451
+ # @yield [result, err] Result & error if block supplied
452
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty] parsed result object
453
+ # @yieldparam err [StandardError] error object if request failed
454
+ #
455
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty]
456
+ #
457
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
458
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
459
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
460
+ def get_property(name, fields: nil, quota_user: nil, options: nil, &block)
461
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
462
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
463
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty
464
+ command.params['name'] = name unless name.nil?
465
+ command.query['fields'] = fields unless fields.nil?
466
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
467
+ execute_or_queue_command(command, &block)
468
+ end
469
+
470
+ # Returns the singleton data retention settings for this property.
471
+ # @param [String] name
472
+ # Required. The name of the settings to lookup. Format: properties/`property`/
473
+ # dataRetentionSettings Example: "properties/1000/dataRetentionSettings"
474
+ # @param [String] fields
475
+ # Selector specifying which fields to include in a partial response.
476
+ # @param [String] quota_user
477
+ # Available to use for quota purposes for server-side applications. Can be any
478
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
479
+ # @param [Google::Apis::RequestOptions] options
480
+ # Request-specific options
481
+ #
482
+ # @yield [result, err] Result & error if block supplied
483
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings] parsed result object
484
+ # @yieldparam err [StandardError] error object if request failed
485
+ #
486
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings]
487
+ #
488
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
489
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
490
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
491
+ def get_property_data_retention_settings(name, fields: nil, quota_user: nil, options: nil, &block)
492
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
493
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings::Representation
494
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings
495
+ command.params['name'] = name unless name.nil?
496
+ command.query['fields'] = fields unless fields.nil?
497
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
498
+ execute_or_queue_command(command, &block)
499
+ end
500
+
501
+ # Returns child Properties under the specified parent Account. Only "GA4"
502
+ # properties will be returned. Properties will be excluded if the caller does
503
+ # not have access. Soft-deleted (ie: "trashed") properties are excluded by
504
+ # default. Returns an empty list if no relevant properties are found.
505
+ # @param [String] filter
506
+ # Required. An expression for filtering the results of the request. Fields
507
+ # eligible for filtering are: `parent:`(The resource name of the parent account/
508
+ # property) or `ancestor:`(The resource name of the parent account) or `
509
+ # firebase_project:`(The id or number of the linked firebase project). Some
510
+ # examples of filters: ``` | Filter | Description | |----------------------------
511
+ # -|-------------------------------------------| | parent:accounts/123 | The
512
+ # account with account id: 123. | | parent:properties/123 | The property with
513
+ # property id: 123. | | ancestor:accounts/123 | The account with account id: 123.
514
+ # | | firebase_project:project-id | The firebase project with id: project-id. |
515
+ # | firebase_project:123 | The firebase project with number: 123. | ```
516
+ # @param [Fixnum] page_size
517
+ # The maximum number of resources to return. The service may return fewer than
518
+ # this value, even if there are additional pages. If unspecified, at most 50
519
+ # resources will be returned. The maximum value is 200; (higher values will be
520
+ # coerced to the maximum)
521
+ # @param [String] page_token
522
+ # A page token, received from a previous `ListProperties` call. Provide this to
523
+ # retrieve the subsequent page. When paginating, all other parameters provided
524
+ # to `ListProperties` must match the call that provided the page token.
525
+ # @param [Boolean] show_deleted
526
+ # Whether to include soft-deleted (ie: "trashed") Properties in the results.
527
+ # Properties can be inspected to determine whether they are deleted or not.
528
+ # @param [String] fields
529
+ # Selector specifying which fields to include in a partial response.
530
+ # @param [String] quota_user
531
+ # Available to use for quota purposes for server-side applications. Can be any
532
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
533
+ # @param [Google::Apis::RequestOptions] options
534
+ # Request-specific options
535
+ #
536
+ # @yield [result, err] Result & error if block supplied
537
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListPropertiesResponse] parsed result object
538
+ # @yieldparam err [StandardError] error object if request failed
539
+ #
540
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListPropertiesResponse]
541
+ #
542
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
543
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
544
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
545
+ def list_properties(filter: nil, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
546
+ command = make_simple_command(:get, 'v1beta/properties', options)
547
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListPropertiesResponse::Representation
548
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListPropertiesResponse
549
+ command.query['filter'] = filter unless filter.nil?
550
+ command.query['pageSize'] = page_size unless page_size.nil?
551
+ command.query['pageToken'] = page_token unless page_token.nil?
552
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
553
+ command.query['fields'] = fields unless fields.nil?
554
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
555
+ execute_or_queue_command(command, &block)
556
+ end
557
+
558
+ # Updates a property.
559
+ # @param [String] name
560
+ # Output only. Resource name of this property. Format: properties/`property_id`
561
+ # Example: "properties/1000"
562
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty] google_analytics_admin_v1beta_property_object
563
+ # @param [String] update_mask
564
+ # Required. The list of fields to be updated. Field names must be in snake case (
565
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
566
+ # entire entity, use one path with the string "*" to match all fields.
567
+ # @param [String] fields
568
+ # Selector specifying which fields to include in a partial response.
569
+ # @param [String] quota_user
570
+ # Available to use for quota purposes for server-side applications. Can be any
571
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
572
+ # @param [Google::Apis::RequestOptions] options
573
+ # Request-specific options
574
+ #
575
+ # @yield [result, err] Result & error if block supplied
576
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty] parsed result object
577
+ # @yieldparam err [StandardError] error object if request failed
578
+ #
579
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty]
580
+ #
581
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
582
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
583
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
584
+ def patch_property(name, google_analytics_admin_v1beta_property_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
585
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
586
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
587
+ command.request_object = google_analytics_admin_v1beta_property_object
588
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty::Representation
589
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaProperty
590
+ command.params['name'] = name unless name.nil?
591
+ command.query['updateMask'] = update_mask unless update_mask.nil?
592
+ command.query['fields'] = fields unless fields.nil?
593
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
594
+ execute_or_queue_command(command, &block)
595
+ end
596
+
597
+ # Updates the singleton data retention settings for this property.
598
+ # @param [String] name
599
+ # Output only. Resource name for this DataRetentionSetting resource. Format:
600
+ # properties/`property`/dataRetentionSettings
601
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings] google_analytics_admin_v1beta_data_retention_settings_object
602
+ # @param [String] update_mask
603
+ # Required. The list of fields to be updated. Field names must be in snake case (
604
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
605
+ # entire entity, use one path with the string "*" to match all fields.
606
+ # @param [String] fields
607
+ # Selector specifying which fields to include in a partial response.
608
+ # @param [String] quota_user
609
+ # Available to use for quota purposes for server-side applications. Can be any
610
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
611
+ # @param [Google::Apis::RequestOptions] options
612
+ # Request-specific options
613
+ #
614
+ # @yield [result, err] Result & error if block supplied
615
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings] parsed result object
616
+ # @yieldparam err [StandardError] error object if request failed
617
+ #
618
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings]
619
+ #
620
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
621
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
622
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
623
+ def update_property_data_retention_settings(name, google_analytics_admin_v1beta_data_retention_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
624
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
625
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings::Representation
626
+ command.request_object = google_analytics_admin_v1beta_data_retention_settings_object
627
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings::Representation
628
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataRetentionSettings
629
+ command.params['name'] = name unless name.nil?
630
+ command.query['updateMask'] = update_mask unless update_mask.nil?
631
+ command.query['fields'] = fields unless fields.nil?
632
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
633
+ execute_or_queue_command(command, &block)
634
+ end
635
+
636
+ # Creates a conversion event with the specified attributes.
637
+ # @param [String] parent
638
+ # Required. The resource name of the parent property where this conversion event
639
+ # will be created. Format: properties/123
640
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent] google_analytics_admin_v1beta_conversion_event_object
641
+ # @param [String] fields
642
+ # Selector specifying which fields to include in a partial response.
643
+ # @param [String] quota_user
644
+ # Available to use for quota purposes for server-side applications. Can be any
645
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
646
+ # @param [Google::Apis::RequestOptions] options
647
+ # Request-specific options
648
+ #
649
+ # @yield [result, err] Result & error if block supplied
650
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent] parsed result object
651
+ # @yieldparam err [StandardError] error object if request failed
652
+ #
653
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent]
654
+ #
655
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
656
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
657
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
658
+ def create_property_conversion_event(parent, google_analytics_admin_v1beta_conversion_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
659
+ command = make_simple_command(:post, 'v1beta/{+parent}/conversionEvents', options)
660
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent::Representation
661
+ command.request_object = google_analytics_admin_v1beta_conversion_event_object
662
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent::Representation
663
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent
664
+ command.params['parent'] = parent unless parent.nil?
665
+ command.query['fields'] = fields unless fields.nil?
666
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
667
+ execute_or_queue_command(command, &block)
668
+ end
669
+
670
+ # Deletes a conversion event in a property.
671
+ # @param [String] name
672
+ # Required. The resource name of the conversion event to delete. Format:
673
+ # properties/`property`/conversionEvents/`conversion_event` Example: "properties/
674
+ # 123/conversionEvents/456"
675
+ # @param [String] fields
676
+ # Selector specifying which fields to include in a partial response.
677
+ # @param [String] quota_user
678
+ # Available to use for quota purposes for server-side applications. Can be any
679
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
680
+ # @param [Google::Apis::RequestOptions] options
681
+ # Request-specific options
682
+ #
683
+ # @yield [result, err] Result & error if block supplied
684
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty] parsed result object
685
+ # @yieldparam err [StandardError] error object if request failed
686
+ #
687
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty]
688
+ #
689
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
690
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
691
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
692
+ def delete_property_conversion_event(name, fields: nil, quota_user: nil, options: nil, &block)
693
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
694
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
695
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
696
+ command.params['name'] = name unless name.nil?
697
+ command.query['fields'] = fields unless fields.nil?
698
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
699
+ execute_or_queue_command(command, &block)
700
+ end
701
+
702
+ # Retrieve a single conversion event.
703
+ # @param [String] name
704
+ # Required. The resource name of the conversion event to retrieve. Format:
705
+ # properties/`property`/conversionEvents/`conversion_event` Example: "properties/
706
+ # 123/conversionEvents/456"
707
+ # @param [String] fields
708
+ # Selector specifying which fields to include in a partial response.
709
+ # @param [String] quota_user
710
+ # Available to use for quota purposes for server-side applications. Can be any
711
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
712
+ # @param [Google::Apis::RequestOptions] options
713
+ # Request-specific options
714
+ #
715
+ # @yield [result, err] Result & error if block supplied
716
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent] parsed result object
717
+ # @yieldparam err [StandardError] error object if request failed
718
+ #
719
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent]
720
+ #
721
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
722
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
723
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
724
+ def get_property_conversion_event(name, fields: nil, quota_user: nil, options: nil, &block)
725
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
726
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent::Representation
727
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent
728
+ command.params['name'] = name unless name.nil?
729
+ command.query['fields'] = fields unless fields.nil?
730
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
731
+ execute_or_queue_command(command, &block)
732
+ end
733
+
734
+ # Returns a list of conversion events in the specified parent property. Returns
735
+ # an empty list if no conversion events are found.
736
+ # @param [String] parent
737
+ # Required. The resource name of the parent property. Example: 'properties/123'
738
+ # @param [Fixnum] page_size
739
+ # The maximum number of resources to return. If unspecified, at most 50
740
+ # resources will be returned. The maximum value is 200; (higher values will be
741
+ # coerced to the maximum)
742
+ # @param [String] page_token
743
+ # A page token, received from a previous `ListConversionEvents` call. Provide
744
+ # this to retrieve the subsequent page. When paginating, all other parameters
745
+ # provided to `ListConversionEvents` must match the call that provided the page
746
+ # token.
747
+ # @param [String] fields
748
+ # Selector specifying which fields to include in a partial response.
749
+ # @param [String] quota_user
750
+ # Available to use for quota purposes for server-side applications. Can be any
751
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
752
+ # @param [Google::Apis::RequestOptions] options
753
+ # Request-specific options
754
+ #
755
+ # @yield [result, err] Result & error if block supplied
756
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListConversionEventsResponse] parsed result object
757
+ # @yieldparam err [StandardError] error object if request failed
758
+ #
759
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListConversionEventsResponse]
760
+ #
761
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
762
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
763
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
764
+ def list_property_conversion_events(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
765
+ command = make_simple_command(:get, 'v1beta/{+parent}/conversionEvents', options)
766
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListConversionEventsResponse::Representation
767
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListConversionEventsResponse
768
+ command.params['parent'] = parent unless parent.nil?
769
+ command.query['pageSize'] = page_size unless page_size.nil?
770
+ command.query['pageToken'] = page_token unless page_token.nil?
771
+ command.query['fields'] = fields unless fields.nil?
772
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
773
+ execute_or_queue_command(command, &block)
774
+ end
775
+
776
+ # Archives a CustomDimension on a property.
777
+ # @param [String] name
778
+ # Required. The name of the CustomDimension to archive. Example format:
779
+ # properties/1234/customDimensions/5678
780
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest] google_analytics_admin_v1beta_archive_custom_dimension_request_object
781
+ # @param [String] fields
782
+ # Selector specifying which fields to include in a partial response.
783
+ # @param [String] quota_user
784
+ # Available to use for quota purposes for server-side applications. Can be any
785
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
786
+ # @param [Google::Apis::RequestOptions] options
787
+ # Request-specific options
788
+ #
789
+ # @yield [result, err] Result & error if block supplied
790
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty] parsed result object
791
+ # @yieldparam err [StandardError] error object if request failed
792
+ #
793
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty]
794
+ #
795
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
796
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
797
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
798
+ def archive_property_custom_dimension(name, google_analytics_admin_v1beta_archive_custom_dimension_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
799
+ command = make_simple_command(:post, 'v1beta/{+name}:archive', options)
800
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest::Representation
801
+ command.request_object = google_analytics_admin_v1beta_archive_custom_dimension_request_object
802
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
803
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
804
+ command.params['name'] = name unless name.nil?
805
+ command.query['fields'] = fields unless fields.nil?
806
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
807
+ execute_or_queue_command(command, &block)
808
+ end
809
+
810
+ # Creates a CustomDimension.
811
+ # @param [String] parent
812
+ # Required. Example format: properties/1234
813
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension] google_analytics_admin_v1beta_custom_dimension_object
814
+ # @param [String] fields
815
+ # Selector specifying which fields to include in a partial response.
816
+ # @param [String] quota_user
817
+ # Available to use for quota purposes for server-side applications. Can be any
818
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
819
+ # @param [Google::Apis::RequestOptions] options
820
+ # Request-specific options
821
+ #
822
+ # @yield [result, err] Result & error if block supplied
823
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension] parsed result object
824
+ # @yieldparam err [StandardError] error object if request failed
825
+ #
826
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension]
827
+ #
828
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
829
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
830
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
831
+ def create_property_custom_dimension(parent, google_analytics_admin_v1beta_custom_dimension_object = nil, fields: nil, quota_user: nil, options: nil, &block)
832
+ command = make_simple_command(:post, 'v1beta/{+parent}/customDimensions', options)
833
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension::Representation
834
+ command.request_object = google_analytics_admin_v1beta_custom_dimension_object
835
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension::Representation
836
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension
837
+ command.params['parent'] = parent unless parent.nil?
838
+ command.query['fields'] = fields unless fields.nil?
839
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
840
+ execute_or_queue_command(command, &block)
841
+ end
842
+
843
+ # Lookup for a single CustomDimension.
844
+ # @param [String] name
845
+ # Required. The name of the CustomDimension to get. Example format: properties/
846
+ # 1234/customDimensions/5678
847
+ # @param [String] fields
848
+ # Selector specifying which fields to include in a partial response.
849
+ # @param [String] quota_user
850
+ # Available to use for quota purposes for server-side applications. Can be any
851
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
852
+ # @param [Google::Apis::RequestOptions] options
853
+ # Request-specific options
854
+ #
855
+ # @yield [result, err] Result & error if block supplied
856
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension] parsed result object
857
+ # @yieldparam err [StandardError] error object if request failed
858
+ #
859
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension]
860
+ #
861
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
862
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
863
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
864
+ def get_property_custom_dimension(name, fields: nil, quota_user: nil, options: nil, &block)
865
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
866
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension::Representation
867
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension
868
+ command.params['name'] = name unless name.nil?
869
+ command.query['fields'] = fields unless fields.nil?
870
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
871
+ execute_or_queue_command(command, &block)
872
+ end
873
+
874
+ # Lists CustomDimensions on a property.
875
+ # @param [String] parent
876
+ # Required. Example format: properties/1234
877
+ # @param [Fixnum] page_size
878
+ # The maximum number of resources to return. If unspecified, at most 50
879
+ # resources will be returned. The maximum value is 200 (higher values will be
880
+ # coerced to the maximum).
881
+ # @param [String] page_token
882
+ # A page token, received from a previous `ListCustomDimensions` call. Provide
883
+ # this to retrieve the subsequent page. When paginating, all other parameters
884
+ # provided to `ListCustomDimensions` must match the call that provided the page
885
+ # token.
886
+ # @param [String] fields
887
+ # Selector specifying which fields to include in a partial response.
888
+ # @param [String] quota_user
889
+ # Available to use for quota purposes for server-side applications. Can be any
890
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
891
+ # @param [Google::Apis::RequestOptions] options
892
+ # Request-specific options
893
+ #
894
+ # @yield [result, err] Result & error if block supplied
895
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomDimensionsResponse] parsed result object
896
+ # @yieldparam err [StandardError] error object if request failed
897
+ #
898
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomDimensionsResponse]
899
+ #
900
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
901
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
902
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
903
+ def list_property_custom_dimensions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
904
+ command = make_simple_command(:get, 'v1beta/{+parent}/customDimensions', options)
905
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomDimensionsResponse::Representation
906
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomDimensionsResponse
907
+ command.params['parent'] = parent unless parent.nil?
908
+ command.query['pageSize'] = page_size unless page_size.nil?
909
+ command.query['pageToken'] = page_token unless page_token.nil?
910
+ command.query['fields'] = fields unless fields.nil?
911
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
912
+ execute_or_queue_command(command, &block)
913
+ end
914
+
915
+ # Updates a CustomDimension on a property.
916
+ # @param [String] name
917
+ # Output only. Resource name for this CustomDimension resource. Format:
918
+ # properties/`property`/customDimensions/`customDimension`
919
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension] google_analytics_admin_v1beta_custom_dimension_object
920
+ # @param [String] update_mask
921
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
922
+ # To replace the entire entity, use one path with the string "*" to match all
923
+ # fields.
924
+ # @param [String] fields
925
+ # Selector specifying which fields to include in a partial response.
926
+ # @param [String] quota_user
927
+ # Available to use for quota purposes for server-side applications. Can be any
928
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
929
+ # @param [Google::Apis::RequestOptions] options
930
+ # Request-specific options
931
+ #
932
+ # @yield [result, err] Result & error if block supplied
933
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension] parsed result object
934
+ # @yieldparam err [StandardError] error object if request failed
935
+ #
936
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension]
937
+ #
938
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
939
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
940
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
941
+ def patch_property_custom_dimension(name, google_analytics_admin_v1beta_custom_dimension_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
942
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
943
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension::Representation
944
+ command.request_object = google_analytics_admin_v1beta_custom_dimension_object
945
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension::Representation
946
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomDimension
947
+ command.params['name'] = name unless name.nil?
948
+ command.query['updateMask'] = update_mask unless update_mask.nil?
949
+ command.query['fields'] = fields unless fields.nil?
950
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
951
+ execute_or_queue_command(command, &block)
952
+ end
953
+
954
+ # Archives a CustomMetric on a property.
955
+ # @param [String] name
956
+ # Required. The name of the CustomMetric to archive. Example format: properties/
957
+ # 1234/customMetrics/5678
958
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest] google_analytics_admin_v1beta_archive_custom_metric_request_object
959
+ # @param [String] fields
960
+ # Selector specifying which fields to include in a partial response.
961
+ # @param [String] quota_user
962
+ # Available to use for quota purposes for server-side applications. Can be any
963
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
964
+ # @param [Google::Apis::RequestOptions] options
965
+ # Request-specific options
966
+ #
967
+ # @yield [result, err] Result & error if block supplied
968
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty] parsed result object
969
+ # @yieldparam err [StandardError] error object if request failed
970
+ #
971
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty]
972
+ #
973
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
974
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
975
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
976
+ def archive_property_custom_metric(name, google_analytics_admin_v1beta_archive_custom_metric_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
977
+ command = make_simple_command(:post, 'v1beta/{+name}:archive', options)
978
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest::Representation
979
+ command.request_object = google_analytics_admin_v1beta_archive_custom_metric_request_object
980
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
981
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
982
+ command.params['name'] = name unless name.nil?
983
+ command.query['fields'] = fields unless fields.nil?
984
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
985
+ execute_or_queue_command(command, &block)
986
+ end
987
+
988
+ # Creates a CustomMetric.
989
+ # @param [String] parent
990
+ # Required. Example format: properties/1234
991
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric] google_analytics_admin_v1beta_custom_metric_object
992
+ # @param [String] fields
993
+ # Selector specifying which fields to include in a partial response.
994
+ # @param [String] quota_user
995
+ # Available to use for quota purposes for server-side applications. Can be any
996
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
997
+ # @param [Google::Apis::RequestOptions] options
998
+ # Request-specific options
999
+ #
1000
+ # @yield [result, err] Result & error if block supplied
1001
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric] parsed result object
1002
+ # @yieldparam err [StandardError] error object if request failed
1003
+ #
1004
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric]
1005
+ #
1006
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1007
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1008
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1009
+ def create_property_custom_metric(parent, google_analytics_admin_v1beta_custom_metric_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1010
+ command = make_simple_command(:post, 'v1beta/{+parent}/customMetrics', options)
1011
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric::Representation
1012
+ command.request_object = google_analytics_admin_v1beta_custom_metric_object
1013
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric::Representation
1014
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric
1015
+ command.params['parent'] = parent unless parent.nil?
1016
+ command.query['fields'] = fields unless fields.nil?
1017
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1018
+ execute_or_queue_command(command, &block)
1019
+ end
1020
+
1021
+ # Lookup for a single CustomMetric.
1022
+ # @param [String] name
1023
+ # Required. The name of the CustomMetric to get. Example format: properties/1234/
1024
+ # customMetrics/5678
1025
+ # @param [String] fields
1026
+ # Selector specifying which fields to include in a partial response.
1027
+ # @param [String] quota_user
1028
+ # Available to use for quota purposes for server-side applications. Can be any
1029
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1030
+ # @param [Google::Apis::RequestOptions] options
1031
+ # Request-specific options
1032
+ #
1033
+ # @yield [result, err] Result & error if block supplied
1034
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric] parsed result object
1035
+ # @yieldparam err [StandardError] error object if request failed
1036
+ #
1037
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric]
1038
+ #
1039
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1040
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1041
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1042
+ def get_property_custom_metric(name, fields: nil, quota_user: nil, options: nil, &block)
1043
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1044
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric::Representation
1045
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric
1046
+ command.params['name'] = name unless name.nil?
1047
+ command.query['fields'] = fields unless fields.nil?
1048
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1049
+ execute_or_queue_command(command, &block)
1050
+ end
1051
+
1052
+ # Lists CustomMetrics on a property.
1053
+ # @param [String] parent
1054
+ # Required. Example format: properties/1234
1055
+ # @param [Fixnum] page_size
1056
+ # The maximum number of resources to return. If unspecified, at most 50
1057
+ # resources will be returned. The maximum value is 200 (higher values will be
1058
+ # coerced to the maximum).
1059
+ # @param [String] page_token
1060
+ # A page token, received from a previous `ListCustomMetrics` call. Provide this
1061
+ # to retrieve the subsequent page. When paginating, all other parameters
1062
+ # provided to `ListCustomMetrics` must match the call that provided the page
1063
+ # token.
1064
+ # @param [String] fields
1065
+ # Selector specifying which fields to include in a partial response.
1066
+ # @param [String] quota_user
1067
+ # Available to use for quota purposes for server-side applications. Can be any
1068
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1069
+ # @param [Google::Apis::RequestOptions] options
1070
+ # Request-specific options
1071
+ #
1072
+ # @yield [result, err] Result & error if block supplied
1073
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomMetricsResponse] parsed result object
1074
+ # @yieldparam err [StandardError] error object if request failed
1075
+ #
1076
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomMetricsResponse]
1077
+ #
1078
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1079
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1080
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1081
+ def list_property_custom_metrics(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1082
+ command = make_simple_command(:get, 'v1beta/{+parent}/customMetrics', options)
1083
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomMetricsResponse::Representation
1084
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListCustomMetricsResponse
1085
+ command.params['parent'] = parent unless parent.nil?
1086
+ command.query['pageSize'] = page_size unless page_size.nil?
1087
+ command.query['pageToken'] = page_token unless page_token.nil?
1088
+ command.query['fields'] = fields unless fields.nil?
1089
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1090
+ execute_or_queue_command(command, &block)
1091
+ end
1092
+
1093
+ # Updates a CustomMetric on a property.
1094
+ # @param [String] name
1095
+ # Output only. Resource name for this CustomMetric resource. Format: properties/`
1096
+ # property`/customMetrics/`customMetric`
1097
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric] google_analytics_admin_v1beta_custom_metric_object
1098
+ # @param [String] update_mask
1099
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
1100
+ # To replace the entire entity, use one path with the string "*" to match all
1101
+ # fields.
1102
+ # @param [String] fields
1103
+ # Selector specifying which fields to include in a partial response.
1104
+ # @param [String] quota_user
1105
+ # Available to use for quota purposes for server-side applications. Can be any
1106
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1107
+ # @param [Google::Apis::RequestOptions] options
1108
+ # Request-specific options
1109
+ #
1110
+ # @yield [result, err] Result & error if block supplied
1111
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric] parsed result object
1112
+ # @yieldparam err [StandardError] error object if request failed
1113
+ #
1114
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric]
1115
+ #
1116
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1117
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1118
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1119
+ def patch_property_custom_metric(name, google_analytics_admin_v1beta_custom_metric_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1120
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1121
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric::Representation
1122
+ command.request_object = google_analytics_admin_v1beta_custom_metric_object
1123
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric::Representation
1124
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaCustomMetric
1125
+ command.params['name'] = name unless name.nil?
1126
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1127
+ command.query['fields'] = fields unless fields.nil?
1128
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1129
+ execute_or_queue_command(command, &block)
1130
+ end
1131
+
1132
+ # Creates a DataStream.
1133
+ # @param [String] parent
1134
+ # Required. Example format: properties/1234
1135
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream] google_analytics_admin_v1beta_data_stream_object
1136
+ # @param [String] fields
1137
+ # Selector specifying which fields to include in a partial response.
1138
+ # @param [String] quota_user
1139
+ # Available to use for quota purposes for server-side applications. Can be any
1140
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1141
+ # @param [Google::Apis::RequestOptions] options
1142
+ # Request-specific options
1143
+ #
1144
+ # @yield [result, err] Result & error if block supplied
1145
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream] parsed result object
1146
+ # @yieldparam err [StandardError] error object if request failed
1147
+ #
1148
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream]
1149
+ #
1150
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1151
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1152
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1153
+ def create_property_data_stream(parent, google_analytics_admin_v1beta_data_stream_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1154
+ command = make_simple_command(:post, 'v1beta/{+parent}/dataStreams', options)
1155
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream::Representation
1156
+ command.request_object = google_analytics_admin_v1beta_data_stream_object
1157
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream::Representation
1158
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream
1159
+ command.params['parent'] = parent unless parent.nil?
1160
+ command.query['fields'] = fields unless fields.nil?
1161
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1162
+ execute_or_queue_command(command, &block)
1163
+ end
1164
+
1165
+ # Deletes a DataStream on a property.
1166
+ # @param [String] name
1167
+ # Required. The name of the DataStream to delete. Example format: properties/
1168
+ # 1234/dataStreams/5678
1169
+ # @param [String] fields
1170
+ # Selector specifying which fields to include in a partial response.
1171
+ # @param [String] quota_user
1172
+ # Available to use for quota purposes for server-side applications. Can be any
1173
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1174
+ # @param [Google::Apis::RequestOptions] options
1175
+ # Request-specific options
1176
+ #
1177
+ # @yield [result, err] Result & error if block supplied
1178
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty] parsed result object
1179
+ # @yieldparam err [StandardError] error object if request failed
1180
+ #
1181
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty]
1182
+ #
1183
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1184
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1185
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1186
+ def delete_property_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
1187
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
1188
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
1189
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
1190
+ command.params['name'] = name unless name.nil?
1191
+ command.query['fields'] = fields unless fields.nil?
1192
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1193
+ execute_or_queue_command(command, &block)
1194
+ end
1195
+
1196
+ # Lookup for a single DataStream.
1197
+ # @param [String] name
1198
+ # Required. The name of the DataStream to get. Example format: properties/1234/
1199
+ # dataStreams/5678
1200
+ # @param [String] fields
1201
+ # Selector specifying which fields to include in a partial response.
1202
+ # @param [String] quota_user
1203
+ # Available to use for quota purposes for server-side applications. Can be any
1204
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1205
+ # @param [Google::Apis::RequestOptions] options
1206
+ # Request-specific options
1207
+ #
1208
+ # @yield [result, err] Result & error if block supplied
1209
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream] parsed result object
1210
+ # @yieldparam err [StandardError] error object if request failed
1211
+ #
1212
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream]
1213
+ #
1214
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1215
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1216
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1217
+ def get_property_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
1218
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1219
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream::Representation
1220
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream
1221
+ command.params['name'] = name unless name.nil?
1222
+ command.query['fields'] = fields unless fields.nil?
1223
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1224
+ execute_or_queue_command(command, &block)
1225
+ end
1226
+
1227
+ # Lists DataStreams on a property.
1228
+ # @param [String] parent
1229
+ # Required. Example format: properties/1234
1230
+ # @param [Fixnum] page_size
1231
+ # The maximum number of resources to return. If unspecified, at most 50
1232
+ # resources will be returned. The maximum value is 200 (higher values will be
1233
+ # coerced to the maximum).
1234
+ # @param [String] page_token
1235
+ # A page token, received from a previous `ListDataStreams` call. Provide this to
1236
+ # retrieve the subsequent page. When paginating, all other parameters provided
1237
+ # to `ListDataStreams` must match the call that provided the page token.
1238
+ # @param [String] fields
1239
+ # Selector specifying which fields to include in a partial response.
1240
+ # @param [String] quota_user
1241
+ # Available to use for quota purposes for server-side applications. Can be any
1242
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1243
+ # @param [Google::Apis::RequestOptions] options
1244
+ # Request-specific options
1245
+ #
1246
+ # @yield [result, err] Result & error if block supplied
1247
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListDataStreamsResponse] parsed result object
1248
+ # @yieldparam err [StandardError] error object if request failed
1249
+ #
1250
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListDataStreamsResponse]
1251
+ #
1252
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1253
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1254
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1255
+ def list_property_data_streams(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1256
+ command = make_simple_command(:get, 'v1beta/{+parent}/dataStreams', options)
1257
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListDataStreamsResponse::Representation
1258
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListDataStreamsResponse
1259
+ command.params['parent'] = parent unless parent.nil?
1260
+ command.query['pageSize'] = page_size unless page_size.nil?
1261
+ command.query['pageToken'] = page_token unless page_token.nil?
1262
+ command.query['fields'] = fields unless fields.nil?
1263
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1264
+ execute_or_queue_command(command, &block)
1265
+ end
1266
+
1267
+ # Updates a DataStream on a property.
1268
+ # @param [String] name
1269
+ # Output only. Resource name of this Data Stream. Format: properties/`
1270
+ # property_id`/dataStreams/`stream_id` Example: "properties/1000/dataStreams/
1271
+ # 2000"
1272
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream] google_analytics_admin_v1beta_data_stream_object
1273
+ # @param [String] update_mask
1274
+ # Required. The list of fields to be updated. Omitted fields will not be updated.
1275
+ # To replace the entire entity, use one path with the string "*" to match all
1276
+ # fields.
1277
+ # @param [String] fields
1278
+ # Selector specifying which fields to include in a partial response.
1279
+ # @param [String] quota_user
1280
+ # Available to use for quota purposes for server-side applications. Can be any
1281
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1282
+ # @param [Google::Apis::RequestOptions] options
1283
+ # Request-specific options
1284
+ #
1285
+ # @yield [result, err] Result & error if block supplied
1286
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream] parsed result object
1287
+ # @yieldparam err [StandardError] error object if request failed
1288
+ #
1289
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream]
1290
+ #
1291
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1292
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1293
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1294
+ def patch_property_data_stream(name, google_analytics_admin_v1beta_data_stream_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1295
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1296
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream::Representation
1297
+ command.request_object = google_analytics_admin_v1beta_data_stream_object
1298
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream::Representation
1299
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaDataStream
1300
+ command.params['name'] = name unless name.nil?
1301
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1302
+ command.query['fields'] = fields unless fields.nil?
1303
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1304
+ execute_or_queue_command(command, &block)
1305
+ end
1306
+
1307
+ # Creates a measurement protocol secret.
1308
+ # @param [String] parent
1309
+ # Required. The parent resource where this secret will be created. Format:
1310
+ # properties/`property`/dataStreams/`dataStream`
1311
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret] google_analytics_admin_v1beta_measurement_protocol_secret_object
1312
+ # @param [String] fields
1313
+ # Selector specifying which fields to include in a partial response.
1314
+ # @param [String] quota_user
1315
+ # Available to use for quota purposes for server-side applications. Can be any
1316
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1317
+ # @param [Google::Apis::RequestOptions] options
1318
+ # Request-specific options
1319
+ #
1320
+ # @yield [result, err] Result & error if block supplied
1321
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret] parsed result object
1322
+ # @yieldparam err [StandardError] error object if request failed
1323
+ #
1324
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret]
1325
+ #
1326
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1327
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1328
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1329
+ def create_property_data_stream_measurement_protocol_secret(parent, google_analytics_admin_v1beta_measurement_protocol_secret_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1330
+ command = make_simple_command(:post, 'v1beta/{+parent}/measurementProtocolSecrets', options)
1331
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret::Representation
1332
+ command.request_object = google_analytics_admin_v1beta_measurement_protocol_secret_object
1333
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret::Representation
1334
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
1335
+ command.params['parent'] = parent unless parent.nil?
1336
+ command.query['fields'] = fields unless fields.nil?
1337
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1338
+ execute_or_queue_command(command, &block)
1339
+ end
1340
+
1341
+ # Deletes target MeasurementProtocolSecret.
1342
+ # @param [String] name
1343
+ # Required. The name of the MeasurementProtocolSecret to delete. Format:
1344
+ # properties/`property`/dataStreams/`dataStream`/measurementProtocolSecrets/`
1345
+ # measurementProtocolSecret`
1346
+ # @param [String] fields
1347
+ # Selector specifying which fields to include in a partial response.
1348
+ # @param [String] quota_user
1349
+ # Available to use for quota purposes for server-side applications. Can be any
1350
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1351
+ # @param [Google::Apis::RequestOptions] options
1352
+ # Request-specific options
1353
+ #
1354
+ # @yield [result, err] Result & error if block supplied
1355
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty] parsed result object
1356
+ # @yieldparam err [StandardError] error object if request failed
1357
+ #
1358
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty]
1359
+ #
1360
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1361
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1362
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1363
+ def delete_property_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
1364
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
1365
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
1366
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
1367
+ command.params['name'] = name unless name.nil?
1368
+ command.query['fields'] = fields unless fields.nil?
1369
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1370
+ execute_or_queue_command(command, &block)
1371
+ end
1372
+
1373
+ # Lookup for a single "GA4" MeasurementProtocolSecret.
1374
+ # @param [String] name
1375
+ # Required. The name of the measurement protocol secret to lookup. Format:
1376
+ # properties/`property`/dataStreams/`dataStream`/measurementProtocolSecrets/`
1377
+ # measurementProtocolSecret`
1378
+ # @param [String] fields
1379
+ # Selector specifying which fields to include in a partial response.
1380
+ # @param [String] quota_user
1381
+ # Available to use for quota purposes for server-side applications. Can be any
1382
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1383
+ # @param [Google::Apis::RequestOptions] options
1384
+ # Request-specific options
1385
+ #
1386
+ # @yield [result, err] Result & error if block supplied
1387
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret] parsed result object
1388
+ # @yieldparam err [StandardError] error object if request failed
1389
+ #
1390
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret]
1391
+ #
1392
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1393
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1394
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1395
+ def get_property_data_stream_measurement_protocol_secret(name, fields: nil, quota_user: nil, options: nil, &block)
1396
+ command = make_simple_command(:get, 'v1beta/{+name}', options)
1397
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret::Representation
1398
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
1399
+ command.params['name'] = name unless name.nil?
1400
+ command.query['fields'] = fields unless fields.nil?
1401
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1402
+ execute_or_queue_command(command, &block)
1403
+ end
1404
+
1405
+ # Returns child MeasurementProtocolSecrets under the specified parent Property.
1406
+ # @param [String] parent
1407
+ # Required. The resource name of the parent stream. Format: properties/`property`
1408
+ # /dataStreams/`dataStream`/measurementProtocolSecrets
1409
+ # @param [Fixnum] page_size
1410
+ # The maximum number of resources to return. If unspecified, at most 10
1411
+ # resources will be returned. The maximum value is 10. Higher values will be
1412
+ # coerced to the maximum.
1413
+ # @param [String] page_token
1414
+ # A page token, received from a previous `ListMeasurementProtocolSecrets` call.
1415
+ # Provide this to retrieve the subsequent page. When paginating, all other
1416
+ # parameters provided to `ListMeasurementProtocolSecrets` must match the call
1417
+ # that provided the page token.
1418
+ # @param [String] fields
1419
+ # Selector specifying which fields to include in a partial response.
1420
+ # @param [String] quota_user
1421
+ # Available to use for quota purposes for server-side applications. Can be any
1422
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1423
+ # @param [Google::Apis::RequestOptions] options
1424
+ # Request-specific options
1425
+ #
1426
+ # @yield [result, err] Result & error if block supplied
1427
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse] parsed result object
1428
+ # @yieldparam err [StandardError] error object if request failed
1429
+ #
1430
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse]
1431
+ #
1432
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1433
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1434
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1435
+ def list_property_data_stream_measurement_protocol_secrets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1436
+ command = make_simple_command(:get, 'v1beta/{+parent}/measurementProtocolSecrets', options)
1437
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse::Representation
1438
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse
1439
+ command.params['parent'] = parent unless parent.nil?
1440
+ command.query['pageSize'] = page_size unless page_size.nil?
1441
+ command.query['pageToken'] = page_token unless page_token.nil?
1442
+ command.query['fields'] = fields unless fields.nil?
1443
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1444
+ execute_or_queue_command(command, &block)
1445
+ end
1446
+
1447
+ # Updates a measurement protocol secret.
1448
+ # @param [String] name
1449
+ # Output only. Resource name of this secret. This secret may be a child of any
1450
+ # type of stream. Format: properties/`property`/dataStreams/`dataStream`/
1451
+ # measurementProtocolSecrets/`measurementProtocolSecret`
1452
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret] google_analytics_admin_v1beta_measurement_protocol_secret_object
1453
+ # @param [String] update_mask
1454
+ # The list of fields to be updated. Omitted fields will not be updated.
1455
+ # @param [String] fields
1456
+ # Selector specifying which fields to include in a partial response.
1457
+ # @param [String] quota_user
1458
+ # Available to use for quota purposes for server-side applications. Can be any
1459
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1460
+ # @param [Google::Apis::RequestOptions] options
1461
+ # Request-specific options
1462
+ #
1463
+ # @yield [result, err] Result & error if block supplied
1464
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret] parsed result object
1465
+ # @yieldparam err [StandardError] error object if request failed
1466
+ #
1467
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret]
1468
+ #
1469
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1470
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1471
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1472
+ def patch_property_data_stream_measurement_protocol_secret(name, google_analytics_admin_v1beta_measurement_protocol_secret_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1473
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1474
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret::Representation
1475
+ command.request_object = google_analytics_admin_v1beta_measurement_protocol_secret_object
1476
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret::Representation
1477
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaMeasurementProtocolSecret
1478
+ command.params['name'] = name unless name.nil?
1479
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1480
+ command.query['fields'] = fields unless fields.nil?
1481
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1482
+ execute_or_queue_command(command, &block)
1483
+ end
1484
+
1485
+ # Creates a FirebaseLink. Properties can have at most one FirebaseLink.
1486
+ # @param [String] parent
1487
+ # Required. Format: properties/`property_id` Example: properties/1234
1488
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink] google_analytics_admin_v1beta_firebase_link_object
1489
+ # @param [String] fields
1490
+ # Selector specifying which fields to include in a partial response.
1491
+ # @param [String] quota_user
1492
+ # Available to use for quota purposes for server-side applications. Can be any
1493
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1494
+ # @param [Google::Apis::RequestOptions] options
1495
+ # Request-specific options
1496
+ #
1497
+ # @yield [result, err] Result & error if block supplied
1498
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink] parsed result object
1499
+ # @yieldparam err [StandardError] error object if request failed
1500
+ #
1501
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink]
1502
+ #
1503
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1504
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1505
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1506
+ def create_property_firebase_link(parent, google_analytics_admin_v1beta_firebase_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1507
+ command = make_simple_command(:post, 'v1beta/{+parent}/firebaseLinks', options)
1508
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink::Representation
1509
+ command.request_object = google_analytics_admin_v1beta_firebase_link_object
1510
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink::Representation
1511
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaFirebaseLink
1512
+ command.params['parent'] = parent unless parent.nil?
1513
+ command.query['fields'] = fields unless fields.nil?
1514
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1515
+ execute_or_queue_command(command, &block)
1516
+ end
1517
+
1518
+ # Deletes a FirebaseLink on a property
1519
+ # @param [String] name
1520
+ # Required. Format: properties/`property_id`/firebaseLinks/`firebase_link_id`
1521
+ # Example: properties/1234/firebaseLinks/5678
1522
+ # @param [String] fields
1523
+ # Selector specifying which fields to include in a partial response.
1524
+ # @param [String] quota_user
1525
+ # Available to use for quota purposes for server-side applications. Can be any
1526
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1527
+ # @param [Google::Apis::RequestOptions] options
1528
+ # Request-specific options
1529
+ #
1530
+ # @yield [result, err] Result & error if block supplied
1531
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty] parsed result object
1532
+ # @yieldparam err [StandardError] error object if request failed
1533
+ #
1534
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty]
1535
+ #
1536
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1537
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1538
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1539
+ def delete_property_firebase_link(name, fields: nil, quota_user: nil, options: nil, &block)
1540
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
1541
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
1542
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
1543
+ command.params['name'] = name unless name.nil?
1544
+ command.query['fields'] = fields unless fields.nil?
1545
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1546
+ execute_or_queue_command(command, &block)
1547
+ end
1548
+
1549
+ # Lists FirebaseLinks on a property. Properties can have at most one
1550
+ # FirebaseLink.
1551
+ # @param [String] parent
1552
+ # Required. Format: properties/`property_id` Example: properties/1234
1553
+ # @param [Fixnum] page_size
1554
+ # The maximum number of resources to return. The service may return fewer than
1555
+ # this value, even if there are additional pages. If unspecified, at most 50
1556
+ # resources will be returned. The maximum value is 200; (higher values will be
1557
+ # coerced to the maximum)
1558
+ # @param [String] page_token
1559
+ # A page token, received from a previous `ListFirebaseLinks` call. Provide this
1560
+ # to retrieve the subsequent page. When paginating, all other parameters
1561
+ # provided to `ListFirebaseLinks` must match the call that provided the page
1562
+ # token.
1563
+ # @param [String] fields
1564
+ # Selector specifying which fields to include in a partial response.
1565
+ # @param [String] quota_user
1566
+ # Available to use for quota purposes for server-side applications. Can be any
1567
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1568
+ # @param [Google::Apis::RequestOptions] options
1569
+ # Request-specific options
1570
+ #
1571
+ # @yield [result, err] Result & error if block supplied
1572
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListFirebaseLinksResponse] parsed result object
1573
+ # @yieldparam err [StandardError] error object if request failed
1574
+ #
1575
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListFirebaseLinksResponse]
1576
+ #
1577
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1578
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1579
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1580
+ def list_property_firebase_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1581
+ command = make_simple_command(:get, 'v1beta/{+parent}/firebaseLinks', options)
1582
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListFirebaseLinksResponse::Representation
1583
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListFirebaseLinksResponse
1584
+ command.params['parent'] = parent unless parent.nil?
1585
+ command.query['pageSize'] = page_size unless page_size.nil?
1586
+ command.query['pageToken'] = page_token unless page_token.nil?
1587
+ command.query['fields'] = fields unless fields.nil?
1588
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1589
+ execute_or_queue_command(command, &block)
1590
+ end
1591
+
1592
+ # Creates a GoogleAdsLink.
1593
+ # @param [String] parent
1594
+ # Required. Example format: properties/1234
1595
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink] google_analytics_admin_v1beta_google_ads_link_object
1596
+ # @param [String] fields
1597
+ # Selector specifying which fields to include in a partial response.
1598
+ # @param [String] quota_user
1599
+ # Available to use for quota purposes for server-side applications. Can be any
1600
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1601
+ # @param [Google::Apis::RequestOptions] options
1602
+ # Request-specific options
1603
+ #
1604
+ # @yield [result, err] Result & error if block supplied
1605
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink] parsed result object
1606
+ # @yieldparam err [StandardError] error object if request failed
1607
+ #
1608
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink]
1609
+ #
1610
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1611
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1612
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1613
+ def create_property_google_ads_link(parent, google_analytics_admin_v1beta_google_ads_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1614
+ command = make_simple_command(:post, 'v1beta/{+parent}/googleAdsLinks', options)
1615
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink::Representation
1616
+ command.request_object = google_analytics_admin_v1beta_google_ads_link_object
1617
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink::Representation
1618
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink
1619
+ command.params['parent'] = parent unless parent.nil?
1620
+ command.query['fields'] = fields unless fields.nil?
1621
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1622
+ execute_or_queue_command(command, &block)
1623
+ end
1624
+
1625
+ # Deletes a GoogleAdsLink on a property
1626
+ # @param [String] name
1627
+ # Required. Example format: properties/1234/googleAdsLinks/5678
1628
+ # @param [String] fields
1629
+ # Selector specifying which fields to include in a partial response.
1630
+ # @param [String] quota_user
1631
+ # Available to use for quota purposes for server-side applications. Can be any
1632
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1633
+ # @param [Google::Apis::RequestOptions] options
1634
+ # Request-specific options
1635
+ #
1636
+ # @yield [result, err] Result & error if block supplied
1637
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty] parsed result object
1638
+ # @yieldparam err [StandardError] error object if request failed
1639
+ #
1640
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty]
1641
+ #
1642
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1643
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1644
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1645
+ def delete_property_google_ads_link(name, fields: nil, quota_user: nil, options: nil, &block)
1646
+ command = make_simple_command(:delete, 'v1beta/{+name}', options)
1647
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty::Representation
1648
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleProtobufEmpty
1649
+ command.params['name'] = name unless name.nil?
1650
+ command.query['fields'] = fields unless fields.nil?
1651
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1652
+ execute_or_queue_command(command, &block)
1653
+ end
1654
+
1655
+ # Lists GoogleAdsLinks on a property.
1656
+ # @param [String] parent
1657
+ # Required. Example format: properties/1234
1658
+ # @param [Fixnum] page_size
1659
+ # The maximum number of resources to return. If unspecified, at most 50
1660
+ # resources will be returned. The maximum value is 200 (higher values will be
1661
+ # coerced to the maximum).
1662
+ # @param [String] page_token
1663
+ # A page token, received from a previous `ListGoogleAdsLinks` call. Provide this
1664
+ # to retrieve the subsequent page. When paginating, all other parameters
1665
+ # provided to `ListGoogleAdsLinks` must match the call that provided the page
1666
+ # token.
1667
+ # @param [String] fields
1668
+ # Selector specifying which fields to include in a partial response.
1669
+ # @param [String] quota_user
1670
+ # Available to use for quota purposes for server-side applications. Can be any
1671
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1672
+ # @param [Google::Apis::RequestOptions] options
1673
+ # Request-specific options
1674
+ #
1675
+ # @yield [result, err] Result & error if block supplied
1676
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse] parsed result object
1677
+ # @yieldparam err [StandardError] error object if request failed
1678
+ #
1679
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse]
1680
+ #
1681
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1682
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1683
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1684
+ def list_property_google_ads_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1685
+ command = make_simple_command(:get, 'v1beta/{+parent}/googleAdsLinks', options)
1686
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse::Representation
1687
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse
1688
+ command.params['parent'] = parent unless parent.nil?
1689
+ command.query['pageSize'] = page_size unless page_size.nil?
1690
+ command.query['pageToken'] = page_token unless page_token.nil?
1691
+ command.query['fields'] = fields unless fields.nil?
1692
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1693
+ execute_or_queue_command(command, &block)
1694
+ end
1695
+
1696
+ # Updates a GoogleAdsLink on a property
1697
+ # @param [String] name
1698
+ # Output only. Format: properties/`propertyId`/googleAdsLinks/`googleAdsLinkId`
1699
+ # Note: googleAdsLinkId is not the Google Ads customer ID.
1700
+ # @param [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink] google_analytics_admin_v1beta_google_ads_link_object
1701
+ # @param [String] update_mask
1702
+ # Required. The list of fields to be updated. Field names must be in snake case (
1703
+ # e.g., "field_to_update"). Omitted fields will not be updated. To replace the
1704
+ # entire entity, use one path with the string "*" to match all fields.
1705
+ # @param [String] fields
1706
+ # Selector specifying which fields to include in a partial response.
1707
+ # @param [String] quota_user
1708
+ # Available to use for quota purposes for server-side applications. Can be any
1709
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1710
+ # @param [Google::Apis::RequestOptions] options
1711
+ # Request-specific options
1712
+ #
1713
+ # @yield [result, err] Result & error if block supplied
1714
+ # @yieldparam result [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink] parsed result object
1715
+ # @yieldparam err [StandardError] error object if request failed
1716
+ #
1717
+ # @return [Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink]
1718
+ #
1719
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1720
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1721
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1722
+ def patch_property_google_ads_link(name, google_analytics_admin_v1beta_google_ads_link_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1723
+ command = make_simple_command(:patch, 'v1beta/{+name}', options)
1724
+ command.request_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink::Representation
1725
+ command.request_object = google_analytics_admin_v1beta_google_ads_link_object
1726
+ command.response_representation = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink::Representation
1727
+ command.response_class = Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaGoogleAdsLink
1728
+ command.params['name'] = name unless name.nil?
1729
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1730
+ command.query['fields'] = fields unless fields.nil?
1731
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1732
+ execute_or_queue_command(command, &block)
1733
+ end
1734
+
1735
+ protected
1736
+
1737
+ def apply_command_defaults(command)
1738
+ command.query['key'] = key unless key.nil?
1739
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1740
+ end
1741
+ end
1742
+ end
1743
+ end
1744
+ end