google-apis-analyticsadmin_v1alpha 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-analyticsadmin_v1alpha.rb +15 -0
- data/lib/google/apis/analyticsadmin_v1alpha.rb +45 -0
- data/lib/google/apis/analyticsadmin_v1alpha/classes.rb +1370 -0
- data/lib/google/apis/analyticsadmin_v1alpha/gem_version.rb +28 -0
- data/lib/google/apis/analyticsadmin_v1alpha/representations.rb +611 -0
- data/lib/google/apis/analyticsadmin_v1alpha/service.rb +2156 -0
- metadata +76 -0
@@ -0,0 +1,2156 @@
|
|
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 AnalyticsadminV1alpha
|
23
|
+
# Google Analytics Admin API
|
24
|
+
#
|
25
|
+
#
|
26
|
+
#
|
27
|
+
# @example
|
28
|
+
# require 'google/apis/analyticsadmin_v1alpha'
|
29
|
+
#
|
30
|
+
# Analyticsadmin = Google::Apis::AnalyticsadminV1alpha # 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_v1alpha',
|
48
|
+
client_version: Google::Apis::AnalyticsadminV1alpha::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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccountSummariesResponse] parsed result object
|
73
|
+
# @yieldparam err [StandardError] error object if request failed
|
74
|
+
#
|
75
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccountSummariesResponse]
|
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, 'v1alpha/accountSummaries', options)
|
82
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccountSummariesResponse::Representation
|
83
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccountSummariesResponse
|
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::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
111
|
+
# @yieldparam err [StandardError] error object if request failed
|
112
|
+
#
|
113
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::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, 'v1alpha/{+name}', options)
|
120
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
121
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount] parsed result object
|
142
|
+
# @yieldparam err [StandardError] error object if request failed
|
143
|
+
#
|
144
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount]
|
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, 'v1alpha/{+name}', options)
|
151
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount::Representation
|
152
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataSharingSettings] parsed result object
|
173
|
+
# @yieldparam err [StandardError] error object if request failed
|
174
|
+
#
|
175
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataSharingSettings]
|
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, 'v1alpha/{+name}', options)
|
182
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataSharingSettings::Representation
|
183
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaDataSharingSettings
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccountsResponse] parsed result object
|
215
|
+
# @yieldparam err [StandardError] error object if request failed
|
216
|
+
#
|
217
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccountsResponse]
|
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, 'v1alpha/accounts', options)
|
224
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccountsResponse::Representation
|
225
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAccountsResponse
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount] google_analytics_admin_v1alpha_account_object
|
239
|
+
# @param [String] update_mask
|
240
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
241
|
+
# To replace the entire entity, use one path with the string "*" to match all
|
242
|
+
# 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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount] parsed result object
|
253
|
+
# @yieldparam err [StandardError] error object if request failed
|
254
|
+
#
|
255
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount]
|
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_v1alpha_account_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
261
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
262
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount::Representation
|
263
|
+
command.request_object = google_analytics_admin_v1alpha_account_object
|
264
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount::Representation
|
265
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAccount
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest] google_analytics_admin_v1alpha_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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse] parsed result object
|
285
|
+
# @yieldparam err [StandardError] error object if request failed
|
286
|
+
#
|
287
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse]
|
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_v1alpha_provision_account_ticket_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
293
|
+
command = make_simple_command(:post, 'v1alpha/accounts:provisionAccountTicket', options)
|
294
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest::Representation
|
295
|
+
command.request_object = google_analytics_admin_v1alpha_provision_account_ticket_request_object
|
296
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse::Representation
|
297
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse
|
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
|
+
# Lists all user links on an account or property, including implicit ones that
|
304
|
+
# come from effective permissions granted by groups or organization admin roles.
|
305
|
+
# If a returned user link does not have direct permissions, they cannot be
|
306
|
+
# removed from the account or property directly with the DeleteUserLink command.
|
307
|
+
# They have to be removed from the group/etc that gives them permissions, which
|
308
|
+
# is currently only usable/discoverable in the GA or GMP UIs.
|
309
|
+
# @param [String] parent
|
310
|
+
# Required. Example format: accounts/1234
|
311
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksRequest] google_analytics_admin_v1alpha_audit_user_links_request_object
|
312
|
+
# @param [String] fields
|
313
|
+
# Selector specifying which fields to include in a partial response.
|
314
|
+
# @param [String] quota_user
|
315
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
316
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
317
|
+
# @param [Google::Apis::RequestOptions] options
|
318
|
+
# Request-specific options
|
319
|
+
#
|
320
|
+
# @yield [result, err] Result & error if block supplied
|
321
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse] parsed result object
|
322
|
+
# @yieldparam err [StandardError] error object if request failed
|
323
|
+
#
|
324
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse]
|
325
|
+
#
|
326
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
327
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
328
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
329
|
+
def audit_account_user_link(parent, google_analytics_admin_v1alpha_audit_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
330
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:audit', options)
|
331
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksRequest::Representation
|
332
|
+
command.request_object = google_analytics_admin_v1alpha_audit_user_links_request_object
|
333
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse::Representation
|
334
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse
|
335
|
+
command.params['parent'] = parent unless parent.nil?
|
336
|
+
command.query['fields'] = fields unless fields.nil?
|
337
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
338
|
+
execute_or_queue_command(command, &block)
|
339
|
+
end
|
340
|
+
|
341
|
+
# Creates information about multiple users' links to an account or property.
|
342
|
+
# This method is transactional. If any UserLink cannot be created, none of the
|
343
|
+
# UserLinks will be created.
|
344
|
+
# @param [String] parent
|
345
|
+
# Required. The account or property that all user links in the request are for.
|
346
|
+
# This field is required. The parent field in the CreateUserLinkRequest messages
|
347
|
+
# must either be empty or match this field. Example format: accounts/1234
|
348
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest] google_analytics_admin_v1alpha_batch_create_user_links_request_object
|
349
|
+
# @param [String] fields
|
350
|
+
# Selector specifying which fields to include in a partial response.
|
351
|
+
# @param [String] quota_user
|
352
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
353
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
354
|
+
# @param [Google::Apis::RequestOptions] options
|
355
|
+
# Request-specific options
|
356
|
+
#
|
357
|
+
# @yield [result, err] Result & error if block supplied
|
358
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse] parsed result object
|
359
|
+
# @yieldparam err [StandardError] error object if request failed
|
360
|
+
#
|
361
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse]
|
362
|
+
#
|
363
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
364
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
365
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
366
|
+
def batch_account_user_link_create(parent, google_analytics_admin_v1alpha_batch_create_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
367
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchCreate', options)
|
368
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest::Representation
|
369
|
+
command.request_object = google_analytics_admin_v1alpha_batch_create_user_links_request_object
|
370
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse::Representation
|
371
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse
|
372
|
+
command.params['parent'] = parent unless parent.nil?
|
373
|
+
command.query['fields'] = fields unless fields.nil?
|
374
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
375
|
+
execute_or_queue_command(command, &block)
|
376
|
+
end
|
377
|
+
|
378
|
+
# Deletes information about multiple users' links to an account or property.
|
379
|
+
# @param [String] parent
|
380
|
+
# Required. The account or property that all user links in the request are for.
|
381
|
+
# The parent of all values for user link names to delete must match this field.
|
382
|
+
# Example format: accounts/1234
|
383
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest] google_analytics_admin_v1alpha_batch_delete_user_links_request_object
|
384
|
+
# @param [String] fields
|
385
|
+
# Selector specifying which fields to include in a partial response.
|
386
|
+
# @param [String] quota_user
|
387
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
388
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
389
|
+
# @param [Google::Apis::RequestOptions] options
|
390
|
+
# Request-specific options
|
391
|
+
#
|
392
|
+
# @yield [result, err] Result & error if block supplied
|
393
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
394
|
+
# @yieldparam err [StandardError] error object if request failed
|
395
|
+
#
|
396
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
397
|
+
#
|
398
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
399
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
400
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
401
|
+
def batch_account_user_link_delete(parent, google_analytics_admin_v1alpha_batch_delete_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
402
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchDelete', options)
|
403
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest::Representation
|
404
|
+
command.request_object = google_analytics_admin_v1alpha_batch_delete_user_links_request_object
|
405
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
406
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
407
|
+
command.params['parent'] = parent unless parent.nil?
|
408
|
+
command.query['fields'] = fields unless fields.nil?
|
409
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
410
|
+
execute_or_queue_command(command, &block)
|
411
|
+
end
|
412
|
+
|
413
|
+
# Gets information about multiple users' links to an account or property.
|
414
|
+
# @param [String] parent
|
415
|
+
# Required. The account or property that all user links in the request are for.
|
416
|
+
# The parent of all provided values for the 'names' field must match this field.
|
417
|
+
# Example format: accounts/1234
|
418
|
+
# @param [Array<String>, String] names
|
419
|
+
# Required. The names of the user links to retrieve. A maximum of 1000 user
|
420
|
+
# links can be retrieved in a batch. Format: accounts/`accountId`/userLinks/`
|
421
|
+
# userLinkId`
|
422
|
+
# @param [String] fields
|
423
|
+
# Selector specifying which fields to include in a partial response.
|
424
|
+
# @param [String] quota_user
|
425
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
426
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
427
|
+
# @param [Google::Apis::RequestOptions] options
|
428
|
+
# Request-specific options
|
429
|
+
#
|
430
|
+
# @yield [result, err] Result & error if block supplied
|
431
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse] parsed result object
|
432
|
+
# @yieldparam err [StandardError] error object if request failed
|
433
|
+
#
|
434
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse]
|
435
|
+
#
|
436
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
437
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
438
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
439
|
+
def batch_account_user_link_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
|
440
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/userLinks:batchGet', options)
|
441
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse::Representation
|
442
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse
|
443
|
+
command.params['parent'] = parent unless parent.nil?
|
444
|
+
command.query['names'] = names unless names.nil?
|
445
|
+
command.query['fields'] = fields unless fields.nil?
|
446
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
447
|
+
execute_or_queue_command(command, &block)
|
448
|
+
end
|
449
|
+
|
450
|
+
# Updates information about multiple users' links to an account or property.
|
451
|
+
# @param [String] parent
|
452
|
+
# Required. The account or property that all user links in the request are for.
|
453
|
+
# The parent field in the UpdateUserLinkRequest messages must either be empty or
|
454
|
+
# match this field. Example format: accounts/1234
|
455
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest] google_analytics_admin_v1alpha_batch_update_user_links_request_object
|
456
|
+
# @param [String] fields
|
457
|
+
# Selector specifying which fields to include in a partial response.
|
458
|
+
# @param [String] quota_user
|
459
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
460
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
461
|
+
# @param [Google::Apis::RequestOptions] options
|
462
|
+
# Request-specific options
|
463
|
+
#
|
464
|
+
# @yield [result, err] Result & error if block supplied
|
465
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse] parsed result object
|
466
|
+
# @yieldparam err [StandardError] error object if request failed
|
467
|
+
#
|
468
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse]
|
469
|
+
#
|
470
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
471
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
472
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
473
|
+
def batch_account_user_link_update(parent, google_analytics_admin_v1alpha_batch_update_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
474
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchUpdate', options)
|
475
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest::Representation
|
476
|
+
command.request_object = google_analytics_admin_v1alpha_batch_update_user_links_request_object
|
477
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse::Representation
|
478
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse
|
479
|
+
command.params['parent'] = parent unless parent.nil?
|
480
|
+
command.query['fields'] = fields unless fields.nil?
|
481
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
482
|
+
execute_or_queue_command(command, &block)
|
483
|
+
end
|
484
|
+
|
485
|
+
# Creates a user link on an account or property. If the user with the specified
|
486
|
+
# email already has permissions on the account or property, then the user's
|
487
|
+
# existing permissions will be unioned with the permissions specified in the new
|
488
|
+
# UserLink.
|
489
|
+
# @param [String] parent
|
490
|
+
# Required. Example format: accounts/1234
|
491
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
|
492
|
+
# @param [Boolean] notify_new_user
|
493
|
+
# Optional. If set, then email the new user notifying them that they've been
|
494
|
+
# granted permissions to the resource.
|
495
|
+
# @param [String] fields
|
496
|
+
# Selector specifying which fields to include in a partial response.
|
497
|
+
# @param [String] quota_user
|
498
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
499
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
500
|
+
# @param [Google::Apis::RequestOptions] options
|
501
|
+
# Request-specific options
|
502
|
+
#
|
503
|
+
# @yield [result, err] Result & error if block supplied
|
504
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
|
505
|
+
# @yieldparam err [StandardError] error object if request failed
|
506
|
+
#
|
507
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
|
508
|
+
#
|
509
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
510
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
511
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
512
|
+
def create_account_user_link(parent, google_analytics_admin_v1alpha_user_link_object = nil, notify_new_user: nil, fields: nil, quota_user: nil, options: nil, &block)
|
513
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks', options)
|
514
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
|
515
|
+
command.request_object = google_analytics_admin_v1alpha_user_link_object
|
516
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
|
517
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
|
518
|
+
command.params['parent'] = parent unless parent.nil?
|
519
|
+
command.query['notifyNewUser'] = notify_new_user unless notify_new_user.nil?
|
520
|
+
command.query['fields'] = fields unless fields.nil?
|
521
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
522
|
+
execute_or_queue_command(command, &block)
|
523
|
+
end
|
524
|
+
|
525
|
+
# Deletes a user link on an account or property.
|
526
|
+
# @param [String] name
|
527
|
+
# Required. Example format: accounts/1234/userLinks/5678
|
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::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
538
|
+
# @yieldparam err [StandardError] error object if request failed
|
539
|
+
#
|
540
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
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 delete_account_user_link(name, fields: nil, quota_user: nil, options: nil, &block)
|
546
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
547
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
548
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
549
|
+
command.params['name'] = name unless name.nil?
|
550
|
+
command.query['fields'] = fields unless fields.nil?
|
551
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
552
|
+
execute_or_queue_command(command, &block)
|
553
|
+
end
|
554
|
+
|
555
|
+
# Gets information about a user's link to an account or property.
|
556
|
+
# @param [String] name
|
557
|
+
# Required. Example format: accounts/1234/userLinks/5678
|
558
|
+
# @param [String] fields
|
559
|
+
# Selector specifying which fields to include in a partial response.
|
560
|
+
# @param [String] quota_user
|
561
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
562
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
563
|
+
# @param [Google::Apis::RequestOptions] options
|
564
|
+
# Request-specific options
|
565
|
+
#
|
566
|
+
# @yield [result, err] Result & error if block supplied
|
567
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
|
568
|
+
# @yieldparam err [StandardError] error object if request failed
|
569
|
+
#
|
570
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
|
571
|
+
#
|
572
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
573
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
574
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
575
|
+
def get_account_user_link(name, fields: nil, quota_user: nil, options: nil, &block)
|
576
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
577
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
|
578
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
|
579
|
+
command.params['name'] = name unless name.nil?
|
580
|
+
command.query['fields'] = fields unless fields.nil?
|
581
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
582
|
+
execute_or_queue_command(command, &block)
|
583
|
+
end
|
584
|
+
|
585
|
+
# Lists all user links on an account or property.
|
586
|
+
# @param [String] parent
|
587
|
+
# Required. Example format: accounts/1234
|
588
|
+
# @param [Fixnum] page_size
|
589
|
+
# The maximum number of user links to return. The service may return fewer than
|
590
|
+
# this value. If unspecified, at most 200 user links will be returned. The
|
591
|
+
# maximum value is 500; values above 500 will be coerced to 500.
|
592
|
+
# @param [String] page_token
|
593
|
+
# A page token, received from a previous `ListUserLinks` call. Provide this to
|
594
|
+
# retrieve the subsequent page. When paginating, all other parameters provided
|
595
|
+
# to `ListUserLinks` must match the call that provided the page token.
|
596
|
+
# @param [String] fields
|
597
|
+
# Selector specifying which fields to include in a partial response.
|
598
|
+
# @param [String] quota_user
|
599
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
600
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
601
|
+
# @param [Google::Apis::RequestOptions] options
|
602
|
+
# Request-specific options
|
603
|
+
#
|
604
|
+
# @yield [result, err] Result & error if block supplied
|
605
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse] parsed result object
|
606
|
+
# @yieldparam err [StandardError] error object if request failed
|
607
|
+
#
|
608
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse]
|
609
|
+
#
|
610
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
611
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
612
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
613
|
+
def list_account_user_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
614
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/userLinks', options)
|
615
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse::Representation
|
616
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse
|
617
|
+
command.params['parent'] = parent unless parent.nil?
|
618
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
619
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
620
|
+
command.query['fields'] = fields unless fields.nil?
|
621
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
622
|
+
execute_or_queue_command(command, &block)
|
623
|
+
end
|
624
|
+
|
625
|
+
# Updates a user link on an account or property.
|
626
|
+
# @param [String] name
|
627
|
+
# Example format: properties/1234/userLinks/5678
|
628
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
|
629
|
+
# @param [String] fields
|
630
|
+
# Selector specifying which fields to include in a partial response.
|
631
|
+
# @param [String] quota_user
|
632
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
633
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
634
|
+
# @param [Google::Apis::RequestOptions] options
|
635
|
+
# Request-specific options
|
636
|
+
#
|
637
|
+
# @yield [result, err] Result & error if block supplied
|
638
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
|
639
|
+
# @yieldparam err [StandardError] error object if request failed
|
640
|
+
#
|
641
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
|
642
|
+
#
|
643
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
644
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
645
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
646
|
+
def patch_account_user_link(name, google_analytics_admin_v1alpha_user_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
647
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
648
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
|
649
|
+
command.request_object = google_analytics_admin_v1alpha_user_link_object
|
650
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
|
651
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
|
652
|
+
command.params['name'] = name unless name.nil?
|
653
|
+
command.query['fields'] = fields unless fields.nil?
|
654
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
655
|
+
execute_or_queue_command(command, &block)
|
656
|
+
end
|
657
|
+
|
658
|
+
# Creates an "GA4" property with the specified location and attributes.
|
659
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty] google_analytics_admin_v1alpha_property_object
|
660
|
+
# @param [String] fields
|
661
|
+
# Selector specifying which fields to include in a partial response.
|
662
|
+
# @param [String] quota_user
|
663
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
664
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
665
|
+
# @param [Google::Apis::RequestOptions] options
|
666
|
+
# Request-specific options
|
667
|
+
#
|
668
|
+
# @yield [result, err] Result & error if block supplied
|
669
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty] parsed result object
|
670
|
+
# @yieldparam err [StandardError] error object if request failed
|
671
|
+
#
|
672
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty]
|
673
|
+
#
|
674
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
675
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
676
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
677
|
+
def create_property(google_analytics_admin_v1alpha_property_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
678
|
+
command = make_simple_command(:post, 'v1alpha/properties', options)
|
679
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty::Representation
|
680
|
+
command.request_object = google_analytics_admin_v1alpha_property_object
|
681
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty::Representation
|
682
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty
|
683
|
+
command.query['fields'] = fields unless fields.nil?
|
684
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
685
|
+
execute_or_queue_command(command, &block)
|
686
|
+
end
|
687
|
+
|
688
|
+
# Marks target Property as soft-deleted (ie: "trashed") and returns it. This API
|
689
|
+
# does not have a method to restore soft-deleted properties. However, they can
|
690
|
+
# be restored using the Trash Can UI. If the properties are not restored before
|
691
|
+
# the expiration time, the Property and all child resources (eg: GoogleAdsLinks,
|
692
|
+
# Streams, UserLinks) will be permanently purged. https://support.google.com/
|
693
|
+
# analytics/answer/6154772 Returns an error if the target is not found, or is
|
694
|
+
# not an GA4 Property.
|
695
|
+
# @param [String] name
|
696
|
+
# Required. The name of the Property to soft-delete. Format: properties/`
|
697
|
+
# property_id` Example: "properties/1000"
|
698
|
+
# @param [String] fields
|
699
|
+
# Selector specifying which fields to include in a partial response.
|
700
|
+
# @param [String] quota_user
|
701
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
702
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
703
|
+
# @param [Google::Apis::RequestOptions] options
|
704
|
+
# Request-specific options
|
705
|
+
#
|
706
|
+
# @yield [result, err] Result & error if block supplied
|
707
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
708
|
+
# @yieldparam err [StandardError] error object if request failed
|
709
|
+
#
|
710
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
711
|
+
#
|
712
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
713
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
714
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
715
|
+
def delete_property(name, fields: nil, quota_user: nil, options: nil, &block)
|
716
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
717
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
718
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
719
|
+
command.params['name'] = name unless name.nil?
|
720
|
+
command.query['fields'] = fields unless fields.nil?
|
721
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
722
|
+
execute_or_queue_command(command, &block)
|
723
|
+
end
|
724
|
+
|
725
|
+
# Lookup for a single "GA4" Property.
|
726
|
+
# @param [String] name
|
727
|
+
# Required. The name of the property to lookup. Format: properties/`property_id`
|
728
|
+
# Example: "properties/1000"
|
729
|
+
# @param [String] fields
|
730
|
+
# Selector specifying which fields to include in a partial response.
|
731
|
+
# @param [String] quota_user
|
732
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
733
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
734
|
+
# @param [Google::Apis::RequestOptions] options
|
735
|
+
# Request-specific options
|
736
|
+
#
|
737
|
+
# @yield [result, err] Result & error if block supplied
|
738
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty] parsed result object
|
739
|
+
# @yieldparam err [StandardError] error object if request failed
|
740
|
+
#
|
741
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty]
|
742
|
+
#
|
743
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
744
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
745
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
746
|
+
def get_property(name, fields: nil, quota_user: nil, options: nil, &block)
|
747
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
748
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty::Representation
|
749
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty
|
750
|
+
command.params['name'] = name unless name.nil?
|
751
|
+
command.query['fields'] = fields unless fields.nil?
|
752
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
753
|
+
execute_or_queue_command(command, &block)
|
754
|
+
end
|
755
|
+
|
756
|
+
# Returns child Properties under the specified parent Account. Only "GA4"
|
757
|
+
# properties will be returned. Properties will be excluded if the caller does
|
758
|
+
# not have access. Soft-deleted (ie: "trashed") properties are excluded by
|
759
|
+
# default. Returns an empty list if no relevant properties are found.
|
760
|
+
# @param [String] filter
|
761
|
+
# Required. An expression for filtering the results of the request. Fields
|
762
|
+
# eligible for filtering are: `parent:`(The resource name of the parent account)
|
763
|
+
# or `firebase_project:`(The id or number of the linked firebase project). Some
|
764
|
+
# examples of filters: ``` | Filter | Description | |----------------------------
|
765
|
+
# -|-------------------------------------------| | parent:accounts/123 | The
|
766
|
+
# account with account id: 123. | | firebase_project:project-id | The firebase
|
767
|
+
# project with id: project-id. | | firebase_project:123 | The firebase project
|
768
|
+
# with number: 123. | ```
|
769
|
+
# @param [Fixnum] page_size
|
770
|
+
# The maximum number of resources to return. The service may return fewer than
|
771
|
+
# this value, even if there are additional pages. If unspecified, at most 50
|
772
|
+
# resources will be returned. The maximum value is 200; (higher values will be
|
773
|
+
# coerced to the maximum)
|
774
|
+
# @param [String] page_token
|
775
|
+
# A page token, received from a previous `ListProperties` call. Provide this to
|
776
|
+
# retrieve the subsequent page. When paginating, all other parameters provided
|
777
|
+
# to `ListProperties` must match the call that provided the page token.
|
778
|
+
# @param [Boolean] show_deleted
|
779
|
+
# Whether to include soft-deleted (ie: "trashed") Properties in the results.
|
780
|
+
# Properties can be inspected to determine whether they are deleted or not.
|
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::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListPropertiesResponse] parsed result object
|
791
|
+
# @yieldparam err [StandardError] error object if request failed
|
792
|
+
#
|
793
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListPropertiesResponse]
|
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 list_properties(filter: nil, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
|
799
|
+
command = make_simple_command(:get, 'v1alpha/properties', options)
|
800
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListPropertiesResponse::Representation
|
801
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListPropertiesResponse
|
802
|
+
command.query['filter'] = filter unless filter.nil?
|
803
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
804
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
805
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
806
|
+
command.query['fields'] = fields unless fields.nil?
|
807
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
808
|
+
execute_or_queue_command(command, &block)
|
809
|
+
end
|
810
|
+
|
811
|
+
# Updates a property.
|
812
|
+
# @param [String] name
|
813
|
+
# Output only. Resource name of this property. Format: properties/`property_id`
|
814
|
+
# Example: "properties/1000"
|
815
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty] google_analytics_admin_v1alpha_property_object
|
816
|
+
# @param [String] update_mask
|
817
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
818
|
+
# To replace the entire entity, use one path with the string "*" to match all
|
819
|
+
# fields.
|
820
|
+
# @param [String] fields
|
821
|
+
# Selector specifying which fields to include in a partial response.
|
822
|
+
# @param [String] quota_user
|
823
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
824
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
825
|
+
# @param [Google::Apis::RequestOptions] options
|
826
|
+
# Request-specific options
|
827
|
+
#
|
828
|
+
# @yield [result, err] Result & error if block supplied
|
829
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty] parsed result object
|
830
|
+
# @yieldparam err [StandardError] error object if request failed
|
831
|
+
#
|
832
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty]
|
833
|
+
#
|
834
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
835
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
836
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
837
|
+
def patch_property(name, google_analytics_admin_v1alpha_property_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
838
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
839
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty::Representation
|
840
|
+
command.request_object = google_analytics_admin_v1alpha_property_object
|
841
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty::Representation
|
842
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaProperty
|
843
|
+
command.params['name'] = name unless name.nil?
|
844
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
845
|
+
command.query['fields'] = fields unless fields.nil?
|
846
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
847
|
+
execute_or_queue_command(command, &block)
|
848
|
+
end
|
849
|
+
|
850
|
+
# Creates an android app stream with the specified location and attributes.
|
851
|
+
# @param [String] parent
|
852
|
+
# Required. The parent resource where this android app data stream will be
|
853
|
+
# created. Format: properties/123
|
854
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream] google_analytics_admin_v1alpha_android_app_data_stream_object
|
855
|
+
# @param [String] fields
|
856
|
+
# Selector specifying which fields to include in a partial response.
|
857
|
+
# @param [String] quota_user
|
858
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
859
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
860
|
+
# @param [Google::Apis::RequestOptions] options
|
861
|
+
# Request-specific options
|
862
|
+
#
|
863
|
+
# @yield [result, err] Result & error if block supplied
|
864
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream] parsed result object
|
865
|
+
# @yieldparam err [StandardError] error object if request failed
|
866
|
+
#
|
867
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream]
|
868
|
+
#
|
869
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
870
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
871
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
872
|
+
def create_property_android_app_data_stream(parent, google_analytics_admin_v1alpha_android_app_data_stream_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
873
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/androidAppDataStreams', options)
|
874
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream::Representation
|
875
|
+
command.request_object = google_analytics_admin_v1alpha_android_app_data_stream_object
|
876
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream::Representation
|
877
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream
|
878
|
+
command.params['parent'] = parent unless parent.nil?
|
879
|
+
command.query['fields'] = fields unless fields.nil?
|
880
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
881
|
+
execute_or_queue_command(command, &block)
|
882
|
+
end
|
883
|
+
|
884
|
+
# Deletes an android app stream on a property.
|
885
|
+
# @param [String] name
|
886
|
+
# Required. The name of the android app data stream to delete. Format:
|
887
|
+
# properties/`property_id`/androidAppDataStreams/`stream_id` Example: "
|
888
|
+
# properties/123/androidAppDataStreams/456"
|
889
|
+
# @param [String] fields
|
890
|
+
# Selector specifying which fields to include in a partial response.
|
891
|
+
# @param [String] quota_user
|
892
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
893
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
894
|
+
# @param [Google::Apis::RequestOptions] options
|
895
|
+
# Request-specific options
|
896
|
+
#
|
897
|
+
# @yield [result, err] Result & error if block supplied
|
898
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
899
|
+
# @yieldparam err [StandardError] error object if request failed
|
900
|
+
#
|
901
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
902
|
+
#
|
903
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
904
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
905
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
906
|
+
def delete_property_android_app_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
|
907
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
908
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
909
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
910
|
+
command.params['name'] = name unless name.nil?
|
911
|
+
command.query['fields'] = fields unless fields.nil?
|
912
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
913
|
+
execute_or_queue_command(command, &block)
|
914
|
+
end
|
915
|
+
|
916
|
+
# Lookup for a single AndroidAppDataStream
|
917
|
+
# @param [String] name
|
918
|
+
# Required. The name of the android app data stream to lookup. Format:
|
919
|
+
# properties/`property_id`/androidAppDataStreams/`stream_id` Example: "
|
920
|
+
# properties/123/androidAppDataStreams/456"
|
921
|
+
# @param [String] fields
|
922
|
+
# Selector specifying which fields to include in a partial response.
|
923
|
+
# @param [String] quota_user
|
924
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
925
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
926
|
+
# @param [Google::Apis::RequestOptions] options
|
927
|
+
# Request-specific options
|
928
|
+
#
|
929
|
+
# @yield [result, err] Result & error if block supplied
|
930
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream] parsed result object
|
931
|
+
# @yieldparam err [StandardError] error object if request failed
|
932
|
+
#
|
933
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream]
|
934
|
+
#
|
935
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
936
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
937
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
938
|
+
def get_property_android_app_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
|
939
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
940
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream::Representation
|
941
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream
|
942
|
+
command.params['name'] = name unless name.nil?
|
943
|
+
command.query['fields'] = fields unless fields.nil?
|
944
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
945
|
+
execute_or_queue_command(command, &block)
|
946
|
+
end
|
947
|
+
|
948
|
+
# Returns child android app streams under the specified parent property. Android
|
949
|
+
# app streams will be excluded if the caller does not have access. Returns an
|
950
|
+
# empty list if no relevant android app streams are found.
|
951
|
+
# @param [String] parent
|
952
|
+
# Required. The name of the parent property. For example, to limit results to
|
953
|
+
# app streams under the property with Id 123: "properties/123"
|
954
|
+
# @param [Fixnum] page_size
|
955
|
+
# The maximum number of resources to return. If unspecified, at most 50
|
956
|
+
# resources will be returned. The maximum value is 200; (higher values will be
|
957
|
+
# coerced to the maximum)
|
958
|
+
# @param [String] page_token
|
959
|
+
# A page token, received from a previous call. Provide this to retrieve the
|
960
|
+
# subsequent page. When paginating, all other parameters provided to `
|
961
|
+
# ListAndroidAppDataStreams` must match the call that provided the page token.
|
962
|
+
# @param [String] fields
|
963
|
+
# Selector specifying which fields to include in a partial response.
|
964
|
+
# @param [String] quota_user
|
965
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
966
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
967
|
+
# @param [Google::Apis::RequestOptions] options
|
968
|
+
# Request-specific options
|
969
|
+
#
|
970
|
+
# @yield [result, err] Result & error if block supplied
|
971
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse] parsed result object
|
972
|
+
# @yieldparam err [StandardError] error object if request failed
|
973
|
+
#
|
974
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse]
|
975
|
+
#
|
976
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
977
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
978
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
979
|
+
def list_property_android_app_data_streams(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
980
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/androidAppDataStreams', options)
|
981
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse::Representation
|
982
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse
|
983
|
+
command.params['parent'] = parent unless parent.nil?
|
984
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
985
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
986
|
+
command.query['fields'] = fields unless fields.nil?
|
987
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
988
|
+
execute_or_queue_command(command, &block)
|
989
|
+
end
|
990
|
+
|
991
|
+
# Updates an android app stream on a property.
|
992
|
+
# @param [String] name
|
993
|
+
# Output only. Resource name of this Data Stream. Format: properties/`
|
994
|
+
# property_id`/androidAppDataStreams/`stream_id` Example: "properties/1000/
|
995
|
+
# androidAppDataStreams/2000"
|
996
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream] google_analytics_admin_v1alpha_android_app_data_stream_object
|
997
|
+
# @param [String] update_mask
|
998
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
999
|
+
# To replace the entire entity, use one path with the string "*" to match all
|
1000
|
+
# fields.
|
1001
|
+
# @param [String] fields
|
1002
|
+
# Selector specifying which fields to include in a partial response.
|
1003
|
+
# @param [String] quota_user
|
1004
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1005
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1006
|
+
# @param [Google::Apis::RequestOptions] options
|
1007
|
+
# Request-specific options
|
1008
|
+
#
|
1009
|
+
# @yield [result, err] Result & error if block supplied
|
1010
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream] parsed result object
|
1011
|
+
# @yieldparam err [StandardError] error object if request failed
|
1012
|
+
#
|
1013
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream]
|
1014
|
+
#
|
1015
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1016
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1017
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1018
|
+
def patch_property_android_app_data_stream(name, google_analytics_admin_v1alpha_android_app_data_stream_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1019
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
1020
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream::Representation
|
1021
|
+
command.request_object = google_analytics_admin_v1alpha_android_app_data_stream_object
|
1022
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream::Representation
|
1023
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAndroidAppDataStream
|
1024
|
+
command.params['name'] = name unless name.nil?
|
1025
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1026
|
+
command.query['fields'] = fields unless fields.nil?
|
1027
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1028
|
+
execute_or_queue_command(command, &block)
|
1029
|
+
end
|
1030
|
+
|
1031
|
+
# Creates a FirebaseLink. Properties can have at most one FirebaseLink.
|
1032
|
+
# @param [String] parent
|
1033
|
+
# Required. Format: properties/`property_id` Example: properties/1234
|
1034
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink] google_analytics_admin_v1alpha_firebase_link_object
|
1035
|
+
# @param [String] fields
|
1036
|
+
# Selector specifying which fields to include in a partial response.
|
1037
|
+
# @param [String] quota_user
|
1038
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1039
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1040
|
+
# @param [Google::Apis::RequestOptions] options
|
1041
|
+
# Request-specific options
|
1042
|
+
#
|
1043
|
+
# @yield [result, err] Result & error if block supplied
|
1044
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink] parsed result object
|
1045
|
+
# @yieldparam err [StandardError] error object if request failed
|
1046
|
+
#
|
1047
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink]
|
1048
|
+
#
|
1049
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1050
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1051
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1052
|
+
def create_property_firebase_link(parent, google_analytics_admin_v1alpha_firebase_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1053
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/firebaseLinks', options)
|
1054
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink::Representation
|
1055
|
+
command.request_object = google_analytics_admin_v1alpha_firebase_link_object
|
1056
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink::Representation
|
1057
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink
|
1058
|
+
command.params['parent'] = parent unless parent.nil?
|
1059
|
+
command.query['fields'] = fields unless fields.nil?
|
1060
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1061
|
+
execute_or_queue_command(command, &block)
|
1062
|
+
end
|
1063
|
+
|
1064
|
+
# Deletes a FirebaseLink on a property
|
1065
|
+
# @param [String] name
|
1066
|
+
# Required. Format: properties/`property_id`/firebaseLinks/`firebase_link_id`
|
1067
|
+
# Example: properties/1234/firebaseLinks/5678
|
1068
|
+
# @param [String] fields
|
1069
|
+
# Selector specifying which fields to include in a partial response.
|
1070
|
+
# @param [String] quota_user
|
1071
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1072
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1073
|
+
# @param [Google::Apis::RequestOptions] options
|
1074
|
+
# Request-specific options
|
1075
|
+
#
|
1076
|
+
# @yield [result, err] Result & error if block supplied
|
1077
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
1078
|
+
# @yieldparam err [StandardError] error object if request failed
|
1079
|
+
#
|
1080
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
1081
|
+
#
|
1082
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1083
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1084
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1085
|
+
def delete_property_firebase_link(name, fields: nil, quota_user: nil, options: nil, &block)
|
1086
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
1087
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
1088
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
1089
|
+
command.params['name'] = name unless name.nil?
|
1090
|
+
command.query['fields'] = fields unless fields.nil?
|
1091
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1092
|
+
execute_or_queue_command(command, &block)
|
1093
|
+
end
|
1094
|
+
|
1095
|
+
# Lists FirebaseLinks on a property. Properties can have at most one
|
1096
|
+
# FirebaseLink.
|
1097
|
+
# @param [String] parent
|
1098
|
+
# Required. Format: properties/`property_id` Example: properties/1234
|
1099
|
+
# @param [Fixnum] page_size
|
1100
|
+
# The maximum number of resources to return. The service may return fewer than
|
1101
|
+
# this value, even if there are additional pages. If unspecified, at most 50
|
1102
|
+
# resources will be returned. The maximum value is 200; (higher values will be
|
1103
|
+
# coerced to the maximum)
|
1104
|
+
# @param [String] page_token
|
1105
|
+
# A page token, received from a previous `ListFirebaseLinks` call. Provide this
|
1106
|
+
# to retrieve the subsequent page. When paginating, all other parameters
|
1107
|
+
# provided to `ListProperties` must match the call that provided the page token.
|
1108
|
+
# @param [String] fields
|
1109
|
+
# Selector specifying which fields to include in a partial response.
|
1110
|
+
# @param [String] quota_user
|
1111
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1112
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1113
|
+
# @param [Google::Apis::RequestOptions] options
|
1114
|
+
# Request-specific options
|
1115
|
+
#
|
1116
|
+
# @yield [result, err] Result & error if block supplied
|
1117
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse] parsed result object
|
1118
|
+
# @yieldparam err [StandardError] error object if request failed
|
1119
|
+
#
|
1120
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse]
|
1121
|
+
#
|
1122
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1123
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1124
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1125
|
+
def list_property_firebase_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1126
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/firebaseLinks', options)
|
1127
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse::Representation
|
1128
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse
|
1129
|
+
command.params['parent'] = parent unless parent.nil?
|
1130
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1131
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1132
|
+
command.query['fields'] = fields unless fields.nil?
|
1133
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1134
|
+
execute_or_queue_command(command, &block)
|
1135
|
+
end
|
1136
|
+
|
1137
|
+
# Updates a FirebaseLink on a property
|
1138
|
+
# @param [String] name
|
1139
|
+
# Output only. Example format: properties/1234/firebaseLinks/5678
|
1140
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink] google_analytics_admin_v1alpha_firebase_link_object
|
1141
|
+
# @param [String] update_mask
|
1142
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
1143
|
+
# To replace the entire entity, use one path with the string "*" to match all
|
1144
|
+
# fields.
|
1145
|
+
# @param [String] fields
|
1146
|
+
# Selector specifying which fields to include in a partial response.
|
1147
|
+
# @param [String] quota_user
|
1148
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1149
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1150
|
+
# @param [Google::Apis::RequestOptions] options
|
1151
|
+
# Request-specific options
|
1152
|
+
#
|
1153
|
+
# @yield [result, err] Result & error if block supplied
|
1154
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink] parsed result object
|
1155
|
+
# @yieldparam err [StandardError] error object if request failed
|
1156
|
+
#
|
1157
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink]
|
1158
|
+
#
|
1159
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1160
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1161
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1162
|
+
def patch_property_firebase_link(name, google_analytics_admin_v1alpha_firebase_link_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1163
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
1164
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink::Representation
|
1165
|
+
command.request_object = google_analytics_admin_v1alpha_firebase_link_object
|
1166
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink::Representation
|
1167
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaFirebaseLink
|
1168
|
+
command.params['name'] = name unless name.nil?
|
1169
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1170
|
+
command.query['fields'] = fields unless fields.nil?
|
1171
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1172
|
+
execute_or_queue_command(command, &block)
|
1173
|
+
end
|
1174
|
+
|
1175
|
+
# Creates a GoogleAdsLink.
|
1176
|
+
# @param [String] parent
|
1177
|
+
# Required. Example format: properties/1234
|
1178
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink] google_analytics_admin_v1alpha_google_ads_link_object
|
1179
|
+
# @param [String] fields
|
1180
|
+
# Selector specifying which fields to include in a partial response.
|
1181
|
+
# @param [String] quota_user
|
1182
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1183
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1184
|
+
# @param [Google::Apis::RequestOptions] options
|
1185
|
+
# Request-specific options
|
1186
|
+
#
|
1187
|
+
# @yield [result, err] Result & error if block supplied
|
1188
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink] parsed result object
|
1189
|
+
# @yieldparam err [StandardError] error object if request failed
|
1190
|
+
#
|
1191
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink]
|
1192
|
+
#
|
1193
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1194
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1195
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1196
|
+
def create_property_google_ads_link(parent, google_analytics_admin_v1alpha_google_ads_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1197
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/googleAdsLinks', options)
|
1198
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink::Representation
|
1199
|
+
command.request_object = google_analytics_admin_v1alpha_google_ads_link_object
|
1200
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink::Representation
|
1201
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink
|
1202
|
+
command.params['parent'] = parent unless parent.nil?
|
1203
|
+
command.query['fields'] = fields unless fields.nil?
|
1204
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1205
|
+
execute_or_queue_command(command, &block)
|
1206
|
+
end
|
1207
|
+
|
1208
|
+
# Deletes a GoogleAdsLink on a property
|
1209
|
+
# @param [String] name
|
1210
|
+
# Required. Example format: properties/1234/googleAdsLinks/5678
|
1211
|
+
# @param [String] fields
|
1212
|
+
# Selector specifying which fields to include in a partial response.
|
1213
|
+
# @param [String] quota_user
|
1214
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1215
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1216
|
+
# @param [Google::Apis::RequestOptions] options
|
1217
|
+
# Request-specific options
|
1218
|
+
#
|
1219
|
+
# @yield [result, err] Result & error if block supplied
|
1220
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
1221
|
+
# @yieldparam err [StandardError] error object if request failed
|
1222
|
+
#
|
1223
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
1224
|
+
#
|
1225
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1226
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1227
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1228
|
+
def delete_property_google_ads_link(name, fields: nil, quota_user: nil, options: nil, &block)
|
1229
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
1230
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
1231
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
1232
|
+
command.params['name'] = name unless name.nil?
|
1233
|
+
command.query['fields'] = fields unless fields.nil?
|
1234
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1235
|
+
execute_or_queue_command(command, &block)
|
1236
|
+
end
|
1237
|
+
|
1238
|
+
# Lists GoogleAdsLinks on a property.
|
1239
|
+
# @param [String] parent
|
1240
|
+
# Required. Example format: properties/1234
|
1241
|
+
# @param [Fixnum] page_size
|
1242
|
+
# The maximum number of resources to return. If unspecified, at most 50
|
1243
|
+
# resources will be returned. The maximum value is 200 (higher values will be
|
1244
|
+
# coerced to the maximum).
|
1245
|
+
# @param [String] page_token
|
1246
|
+
# A page token, received from a previous `ListGoogleAdsLinks` call. Provide this
|
1247
|
+
# to retrieve the subsequent page. When paginating, all other parameters
|
1248
|
+
# provided to `ListGoogleAdsLinks` must match the call that provided the page
|
1249
|
+
# token.
|
1250
|
+
# @param [String] fields
|
1251
|
+
# Selector specifying which fields to include in a partial response.
|
1252
|
+
# @param [String] quota_user
|
1253
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1254
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1255
|
+
# @param [Google::Apis::RequestOptions] options
|
1256
|
+
# Request-specific options
|
1257
|
+
#
|
1258
|
+
# @yield [result, err] Result & error if block supplied
|
1259
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse] parsed result object
|
1260
|
+
# @yieldparam err [StandardError] error object if request failed
|
1261
|
+
#
|
1262
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse]
|
1263
|
+
#
|
1264
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1265
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1266
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1267
|
+
def list_property_google_ads_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1268
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/googleAdsLinks', options)
|
1269
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse::Representation
|
1270
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse
|
1271
|
+
command.params['parent'] = parent unless parent.nil?
|
1272
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1273
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1274
|
+
command.query['fields'] = fields unless fields.nil?
|
1275
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1276
|
+
execute_or_queue_command(command, &block)
|
1277
|
+
end
|
1278
|
+
|
1279
|
+
# Updates a GoogleAdsLink on a property
|
1280
|
+
# @param [String] name
|
1281
|
+
# Output only. Format: properties/`propertyId`/googleAdsLinks/`googleAdsLinkId`
|
1282
|
+
# Note: googleAdsLinkId is not the Google Ads customer ID.
|
1283
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink] google_analytics_admin_v1alpha_google_ads_link_object
|
1284
|
+
# @param [String] update_mask
|
1285
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
1286
|
+
# To replace the entire entity, use one path with the string "*" to match all
|
1287
|
+
# fields.
|
1288
|
+
# @param [String] fields
|
1289
|
+
# Selector specifying which fields to include in a partial response.
|
1290
|
+
# @param [String] quota_user
|
1291
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1292
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1293
|
+
# @param [Google::Apis::RequestOptions] options
|
1294
|
+
# Request-specific options
|
1295
|
+
#
|
1296
|
+
# @yield [result, err] Result & error if block supplied
|
1297
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink] parsed result object
|
1298
|
+
# @yieldparam err [StandardError] error object if request failed
|
1299
|
+
#
|
1300
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink]
|
1301
|
+
#
|
1302
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1303
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1304
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1305
|
+
def patch_property_google_ads_link(name, google_analytics_admin_v1alpha_google_ads_link_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1306
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
1307
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink::Representation
|
1308
|
+
command.request_object = google_analytics_admin_v1alpha_google_ads_link_object
|
1309
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink::Representation
|
1310
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGoogleAdsLink
|
1311
|
+
command.params['name'] = name unless name.nil?
|
1312
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1313
|
+
command.query['fields'] = fields unless fields.nil?
|
1314
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1315
|
+
execute_or_queue_command(command, &block)
|
1316
|
+
end
|
1317
|
+
|
1318
|
+
# Creates an iOS app data stream with the specified location and attributes.
|
1319
|
+
# @param [String] parent
|
1320
|
+
# Required. The parent resource where this ios app data stream will be created.
|
1321
|
+
# Format: properties/123
|
1322
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream] google_analytics_admin_v1alpha_ios_app_data_stream_object
|
1323
|
+
# @param [String] fields
|
1324
|
+
# Selector specifying which fields to include in a partial response.
|
1325
|
+
# @param [String] quota_user
|
1326
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1327
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1328
|
+
# @param [Google::Apis::RequestOptions] options
|
1329
|
+
# Request-specific options
|
1330
|
+
#
|
1331
|
+
# @yield [result, err] Result & error if block supplied
|
1332
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream] parsed result object
|
1333
|
+
# @yieldparam err [StandardError] error object if request failed
|
1334
|
+
#
|
1335
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream]
|
1336
|
+
#
|
1337
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1338
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1339
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1340
|
+
def create_property_ios_app_data_stream(parent, google_analytics_admin_v1alpha_ios_app_data_stream_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1341
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/iosAppDataStreams', options)
|
1342
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream::Representation
|
1343
|
+
command.request_object = google_analytics_admin_v1alpha_ios_app_data_stream_object
|
1344
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream::Representation
|
1345
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream
|
1346
|
+
command.params['parent'] = parent unless parent.nil?
|
1347
|
+
command.query['fields'] = fields unless fields.nil?
|
1348
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1349
|
+
execute_or_queue_command(command, &block)
|
1350
|
+
end
|
1351
|
+
|
1352
|
+
# Deletes an iOS app stream on a property.
|
1353
|
+
# @param [String] name
|
1354
|
+
# Required. The name of the iOS app data stream to delete. Format: properties/`
|
1355
|
+
# property_id`/iosAppDataStreams/`stream_id` Example: "properties/123/
|
1356
|
+
# iosAppDataStreams/456"
|
1357
|
+
# @param [String] fields
|
1358
|
+
# Selector specifying which fields to include in a partial response.
|
1359
|
+
# @param [String] quota_user
|
1360
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1361
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1362
|
+
# @param [Google::Apis::RequestOptions] options
|
1363
|
+
# Request-specific options
|
1364
|
+
#
|
1365
|
+
# @yield [result, err] Result & error if block supplied
|
1366
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
1367
|
+
# @yieldparam err [StandardError] error object if request failed
|
1368
|
+
#
|
1369
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
1370
|
+
#
|
1371
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1372
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1373
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1374
|
+
def delete_property_ios_app_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
|
1375
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
1376
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
1377
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
1378
|
+
command.params['name'] = name unless name.nil?
|
1379
|
+
command.query['fields'] = fields unless fields.nil?
|
1380
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1381
|
+
execute_or_queue_command(command, &block)
|
1382
|
+
end
|
1383
|
+
|
1384
|
+
# Lookup for a single IosAppDataStream
|
1385
|
+
# @param [String] name
|
1386
|
+
# Required. The name of the iOS app data stream to lookup. Format: properties/`
|
1387
|
+
# property_id`/iosAppDataStreams/`stream_id` Example: "properties/123/
|
1388
|
+
# iosAppDataStreams/456"
|
1389
|
+
# @param [String] fields
|
1390
|
+
# Selector specifying which fields to include in a partial response.
|
1391
|
+
# @param [String] quota_user
|
1392
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1393
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1394
|
+
# @param [Google::Apis::RequestOptions] options
|
1395
|
+
# Request-specific options
|
1396
|
+
#
|
1397
|
+
# @yield [result, err] Result & error if block supplied
|
1398
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream] parsed result object
|
1399
|
+
# @yieldparam err [StandardError] error object if request failed
|
1400
|
+
#
|
1401
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream]
|
1402
|
+
#
|
1403
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1404
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1405
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1406
|
+
def get_property_ios_app_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
|
1407
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1408
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream::Representation
|
1409
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream
|
1410
|
+
command.params['name'] = name unless name.nil?
|
1411
|
+
command.query['fields'] = fields unless fields.nil?
|
1412
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1413
|
+
execute_or_queue_command(command, &block)
|
1414
|
+
end
|
1415
|
+
|
1416
|
+
# Returns child iOS app data streams under the specified parent property. iOS
|
1417
|
+
# app data streams will be excluded if the caller does not have access. Returns
|
1418
|
+
# an empty list if no relevant iOS app data streams are found.
|
1419
|
+
# @param [String] parent
|
1420
|
+
# Required. The name of the parent property. For example, to list results of app
|
1421
|
+
# streams under the property with Id 123: "properties/123"
|
1422
|
+
# @param [Fixnum] page_size
|
1423
|
+
# The maximum number of resources to return. If unspecified, at most 50
|
1424
|
+
# resources will be returned. The maximum value is 200; (higher values will be
|
1425
|
+
# coerced to the maximum)
|
1426
|
+
# @param [String] page_token
|
1427
|
+
# A page token, received from a previous `ListIosAppDataStreams` call. Provide
|
1428
|
+
# this to retrieve the subsequent page. When paginating, all other parameters
|
1429
|
+
# provided to `ListIosAppDataStreams` must match the call that provided the page
|
1430
|
+
# token.
|
1431
|
+
# @param [String] fields
|
1432
|
+
# Selector specifying which fields to include in a partial response.
|
1433
|
+
# @param [String] quota_user
|
1434
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1435
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1436
|
+
# @param [Google::Apis::RequestOptions] options
|
1437
|
+
# Request-specific options
|
1438
|
+
#
|
1439
|
+
# @yield [result, err] Result & error if block supplied
|
1440
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse] parsed result object
|
1441
|
+
# @yieldparam err [StandardError] error object if request failed
|
1442
|
+
#
|
1443
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse]
|
1444
|
+
#
|
1445
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1446
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1447
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1448
|
+
def list_property_ios_app_data_streams(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1449
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/iosAppDataStreams', options)
|
1450
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse::Representation
|
1451
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse
|
1452
|
+
command.params['parent'] = parent unless parent.nil?
|
1453
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1454
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1455
|
+
command.query['fields'] = fields unless fields.nil?
|
1456
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1457
|
+
execute_or_queue_command(command, &block)
|
1458
|
+
end
|
1459
|
+
|
1460
|
+
# Updates an iOS app stream on a property.
|
1461
|
+
# @param [String] name
|
1462
|
+
# Output only. Resource name of this Data Stream. Format: properties/`
|
1463
|
+
# property_id`/iosAppDataStreams/`stream_id` Example: "properties/1000/
|
1464
|
+
# iosAppDataStreams/2000"
|
1465
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream] google_analytics_admin_v1alpha_ios_app_data_stream_object
|
1466
|
+
# @param [String] update_mask
|
1467
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
1468
|
+
# To replace the entire entity, use one path with the string "*" to match all
|
1469
|
+
# fields.
|
1470
|
+
# @param [String] fields
|
1471
|
+
# Selector specifying which fields to include in a partial response.
|
1472
|
+
# @param [String] quota_user
|
1473
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1474
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1475
|
+
# @param [Google::Apis::RequestOptions] options
|
1476
|
+
# Request-specific options
|
1477
|
+
#
|
1478
|
+
# @yield [result, err] Result & error if block supplied
|
1479
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream] parsed result object
|
1480
|
+
# @yieldparam err [StandardError] error object if request failed
|
1481
|
+
#
|
1482
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream]
|
1483
|
+
#
|
1484
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1485
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1486
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1487
|
+
def patch_property_ios_app_data_stream(name, google_analytics_admin_v1alpha_ios_app_data_stream_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1488
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
1489
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream::Representation
|
1490
|
+
command.request_object = google_analytics_admin_v1alpha_ios_app_data_stream_object
|
1491
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream::Representation
|
1492
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaIosAppDataStream
|
1493
|
+
command.params['name'] = name unless name.nil?
|
1494
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1495
|
+
command.query['fields'] = fields unless fields.nil?
|
1496
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1497
|
+
execute_or_queue_command(command, &block)
|
1498
|
+
end
|
1499
|
+
|
1500
|
+
# Lists all user links on an account or property, including implicit ones that
|
1501
|
+
# come from effective permissions granted by groups or organization admin roles.
|
1502
|
+
# If a returned user link does not have direct permissions, they cannot be
|
1503
|
+
# removed from the account or property directly with the DeleteUserLink command.
|
1504
|
+
# They have to be removed from the group/etc that gives them permissions, which
|
1505
|
+
# is currently only usable/discoverable in the GA or GMP UIs.
|
1506
|
+
# @param [String] parent
|
1507
|
+
# Required. Example format: accounts/1234
|
1508
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksRequest] google_analytics_admin_v1alpha_audit_user_links_request_object
|
1509
|
+
# @param [String] fields
|
1510
|
+
# Selector specifying which fields to include in a partial response.
|
1511
|
+
# @param [String] quota_user
|
1512
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1513
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1514
|
+
# @param [Google::Apis::RequestOptions] options
|
1515
|
+
# Request-specific options
|
1516
|
+
#
|
1517
|
+
# @yield [result, err] Result & error if block supplied
|
1518
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse] parsed result object
|
1519
|
+
# @yieldparam err [StandardError] error object if request failed
|
1520
|
+
#
|
1521
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse]
|
1522
|
+
#
|
1523
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1524
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1525
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1526
|
+
def audit_property_user_link(parent, google_analytics_admin_v1alpha_audit_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1527
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:audit', options)
|
1528
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksRequest::Representation
|
1529
|
+
command.request_object = google_analytics_admin_v1alpha_audit_user_links_request_object
|
1530
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse::Representation
|
1531
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAuditUserLinksResponse
|
1532
|
+
command.params['parent'] = parent unless parent.nil?
|
1533
|
+
command.query['fields'] = fields unless fields.nil?
|
1534
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1535
|
+
execute_or_queue_command(command, &block)
|
1536
|
+
end
|
1537
|
+
|
1538
|
+
# Creates information about multiple users' links to an account or property.
|
1539
|
+
# This method is transactional. If any UserLink cannot be created, none of the
|
1540
|
+
# UserLinks will be created.
|
1541
|
+
# @param [String] parent
|
1542
|
+
# Required. The account or property that all user links in the request are for.
|
1543
|
+
# This field is required. The parent field in the CreateUserLinkRequest messages
|
1544
|
+
# must either be empty or match this field. Example format: accounts/1234
|
1545
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest] google_analytics_admin_v1alpha_batch_create_user_links_request_object
|
1546
|
+
# @param [String] fields
|
1547
|
+
# Selector specifying which fields to include in a partial response.
|
1548
|
+
# @param [String] quota_user
|
1549
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1550
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1551
|
+
# @param [Google::Apis::RequestOptions] options
|
1552
|
+
# Request-specific options
|
1553
|
+
#
|
1554
|
+
# @yield [result, err] Result & error if block supplied
|
1555
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse] parsed result object
|
1556
|
+
# @yieldparam err [StandardError] error object if request failed
|
1557
|
+
#
|
1558
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse]
|
1559
|
+
#
|
1560
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1561
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1562
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1563
|
+
def batch_property_user_link_create(parent, google_analytics_admin_v1alpha_batch_create_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1564
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchCreate', options)
|
1565
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest::Representation
|
1566
|
+
command.request_object = google_analytics_admin_v1alpha_batch_create_user_links_request_object
|
1567
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse::Representation
|
1568
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse
|
1569
|
+
command.params['parent'] = parent unless parent.nil?
|
1570
|
+
command.query['fields'] = fields unless fields.nil?
|
1571
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1572
|
+
execute_or_queue_command(command, &block)
|
1573
|
+
end
|
1574
|
+
|
1575
|
+
# Deletes information about multiple users' links to an account or property.
|
1576
|
+
# @param [String] parent
|
1577
|
+
# Required. The account or property that all user links in the request are for.
|
1578
|
+
# The parent of all values for user link names to delete must match this field.
|
1579
|
+
# Example format: accounts/1234
|
1580
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest] google_analytics_admin_v1alpha_batch_delete_user_links_request_object
|
1581
|
+
# @param [String] fields
|
1582
|
+
# Selector specifying which fields to include in a partial response.
|
1583
|
+
# @param [String] quota_user
|
1584
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1585
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1586
|
+
# @param [Google::Apis::RequestOptions] options
|
1587
|
+
# Request-specific options
|
1588
|
+
#
|
1589
|
+
# @yield [result, err] Result & error if block supplied
|
1590
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
1591
|
+
# @yieldparam err [StandardError] error object if request failed
|
1592
|
+
#
|
1593
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
1594
|
+
#
|
1595
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1596
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1597
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1598
|
+
def batch_property_user_link_delete(parent, google_analytics_admin_v1alpha_batch_delete_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1599
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchDelete', options)
|
1600
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest::Representation
|
1601
|
+
command.request_object = google_analytics_admin_v1alpha_batch_delete_user_links_request_object
|
1602
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
1603
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
1604
|
+
command.params['parent'] = parent unless parent.nil?
|
1605
|
+
command.query['fields'] = fields unless fields.nil?
|
1606
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1607
|
+
execute_or_queue_command(command, &block)
|
1608
|
+
end
|
1609
|
+
|
1610
|
+
# Gets information about multiple users' links to an account or property.
|
1611
|
+
# @param [String] parent
|
1612
|
+
# Required. The account or property that all user links in the request are for.
|
1613
|
+
# The parent of all provided values for the 'names' field must match this field.
|
1614
|
+
# Example format: accounts/1234
|
1615
|
+
# @param [Array<String>, String] names
|
1616
|
+
# Required. The names of the user links to retrieve. A maximum of 1000 user
|
1617
|
+
# links can be retrieved in a batch. Format: accounts/`accountId`/userLinks/`
|
1618
|
+
# userLinkId`
|
1619
|
+
# @param [String] fields
|
1620
|
+
# Selector specifying which fields to include in a partial response.
|
1621
|
+
# @param [String] quota_user
|
1622
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1623
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1624
|
+
# @param [Google::Apis::RequestOptions] options
|
1625
|
+
# Request-specific options
|
1626
|
+
#
|
1627
|
+
# @yield [result, err] Result & error if block supplied
|
1628
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse] parsed result object
|
1629
|
+
# @yieldparam err [StandardError] error object if request failed
|
1630
|
+
#
|
1631
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse]
|
1632
|
+
#
|
1633
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1634
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1635
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1636
|
+
def batch_property_user_link_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1637
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/userLinks:batchGet', options)
|
1638
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse::Representation
|
1639
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse
|
1640
|
+
command.params['parent'] = parent unless parent.nil?
|
1641
|
+
command.query['names'] = names unless names.nil?
|
1642
|
+
command.query['fields'] = fields unless fields.nil?
|
1643
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1644
|
+
execute_or_queue_command(command, &block)
|
1645
|
+
end
|
1646
|
+
|
1647
|
+
# Updates information about multiple users' links to an account or property.
|
1648
|
+
# @param [String] parent
|
1649
|
+
# Required. The account or property that all user links in the request are for.
|
1650
|
+
# The parent field in the UpdateUserLinkRequest messages must either be empty or
|
1651
|
+
# match this field. Example format: accounts/1234
|
1652
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest] google_analytics_admin_v1alpha_batch_update_user_links_request_object
|
1653
|
+
# @param [String] fields
|
1654
|
+
# Selector specifying which fields to include in a partial response.
|
1655
|
+
# @param [String] quota_user
|
1656
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1657
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1658
|
+
# @param [Google::Apis::RequestOptions] options
|
1659
|
+
# Request-specific options
|
1660
|
+
#
|
1661
|
+
# @yield [result, err] Result & error if block supplied
|
1662
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse] parsed result object
|
1663
|
+
# @yieldparam err [StandardError] error object if request failed
|
1664
|
+
#
|
1665
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse]
|
1666
|
+
#
|
1667
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1668
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1669
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1670
|
+
def batch_property_user_link_update(parent, google_analytics_admin_v1alpha_batch_update_user_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1671
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks:batchUpdate', options)
|
1672
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest::Representation
|
1673
|
+
command.request_object = google_analytics_admin_v1alpha_batch_update_user_links_request_object
|
1674
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse::Representation
|
1675
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse
|
1676
|
+
command.params['parent'] = parent unless parent.nil?
|
1677
|
+
command.query['fields'] = fields unless fields.nil?
|
1678
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1679
|
+
execute_or_queue_command(command, &block)
|
1680
|
+
end
|
1681
|
+
|
1682
|
+
# Creates a user link on an account or property. If the user with the specified
|
1683
|
+
# email already has permissions on the account or property, then the user's
|
1684
|
+
# existing permissions will be unioned with the permissions specified in the new
|
1685
|
+
# UserLink.
|
1686
|
+
# @param [String] parent
|
1687
|
+
# Required. Example format: accounts/1234
|
1688
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
|
1689
|
+
# @param [Boolean] notify_new_user
|
1690
|
+
# Optional. If set, then email the new user notifying them that they've been
|
1691
|
+
# granted permissions to the resource.
|
1692
|
+
# @param [String] fields
|
1693
|
+
# Selector specifying which fields to include in a partial response.
|
1694
|
+
# @param [String] quota_user
|
1695
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1696
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1697
|
+
# @param [Google::Apis::RequestOptions] options
|
1698
|
+
# Request-specific options
|
1699
|
+
#
|
1700
|
+
# @yield [result, err] Result & error if block supplied
|
1701
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
|
1702
|
+
# @yieldparam err [StandardError] error object if request failed
|
1703
|
+
#
|
1704
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
|
1705
|
+
#
|
1706
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1707
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1708
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1709
|
+
def create_property_user_link(parent, google_analytics_admin_v1alpha_user_link_object = nil, notify_new_user: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1710
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userLinks', options)
|
1711
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
|
1712
|
+
command.request_object = google_analytics_admin_v1alpha_user_link_object
|
1713
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
|
1714
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
|
1715
|
+
command.params['parent'] = parent unless parent.nil?
|
1716
|
+
command.query['notifyNewUser'] = notify_new_user unless notify_new_user.nil?
|
1717
|
+
command.query['fields'] = fields unless fields.nil?
|
1718
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1719
|
+
execute_or_queue_command(command, &block)
|
1720
|
+
end
|
1721
|
+
|
1722
|
+
# Deletes a user link on an account or property.
|
1723
|
+
# @param [String] name
|
1724
|
+
# Required. Example format: accounts/1234/userLinks/5678
|
1725
|
+
# @param [String] fields
|
1726
|
+
# Selector specifying which fields to include in a partial response.
|
1727
|
+
# @param [String] quota_user
|
1728
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1729
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1730
|
+
# @param [Google::Apis::RequestOptions] options
|
1731
|
+
# Request-specific options
|
1732
|
+
#
|
1733
|
+
# @yield [result, err] Result & error if block supplied
|
1734
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
1735
|
+
# @yieldparam err [StandardError] error object if request failed
|
1736
|
+
#
|
1737
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
1738
|
+
#
|
1739
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1740
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1741
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1742
|
+
def delete_property_user_link(name, fields: nil, quota_user: nil, options: nil, &block)
|
1743
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
1744
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
1745
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
1746
|
+
command.params['name'] = name unless name.nil?
|
1747
|
+
command.query['fields'] = fields unless fields.nil?
|
1748
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1749
|
+
execute_or_queue_command(command, &block)
|
1750
|
+
end
|
1751
|
+
|
1752
|
+
# Gets information about a user's link to an account or property.
|
1753
|
+
# @param [String] name
|
1754
|
+
# Required. Example format: accounts/1234/userLinks/5678
|
1755
|
+
# @param [String] fields
|
1756
|
+
# Selector specifying which fields to include in a partial response.
|
1757
|
+
# @param [String] quota_user
|
1758
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1759
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1760
|
+
# @param [Google::Apis::RequestOptions] options
|
1761
|
+
# Request-specific options
|
1762
|
+
#
|
1763
|
+
# @yield [result, err] Result & error if block supplied
|
1764
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
|
1765
|
+
# @yieldparam err [StandardError] error object if request failed
|
1766
|
+
#
|
1767
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
|
1768
|
+
#
|
1769
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1770
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1771
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1772
|
+
def get_property_user_link(name, fields: nil, quota_user: nil, options: nil, &block)
|
1773
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1774
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
|
1775
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
|
1776
|
+
command.params['name'] = name unless name.nil?
|
1777
|
+
command.query['fields'] = fields unless fields.nil?
|
1778
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1779
|
+
execute_or_queue_command(command, &block)
|
1780
|
+
end
|
1781
|
+
|
1782
|
+
# Lists all user links on an account or property.
|
1783
|
+
# @param [String] parent
|
1784
|
+
# Required. Example format: accounts/1234
|
1785
|
+
# @param [Fixnum] page_size
|
1786
|
+
# The maximum number of user links to return. The service may return fewer than
|
1787
|
+
# this value. If unspecified, at most 200 user links will be returned. The
|
1788
|
+
# maximum value is 500; values above 500 will be coerced to 500.
|
1789
|
+
# @param [String] page_token
|
1790
|
+
# A page token, received from a previous `ListUserLinks` call. Provide this to
|
1791
|
+
# retrieve the subsequent page. When paginating, all other parameters provided
|
1792
|
+
# to `ListUserLinks` must match the call that provided the page token.
|
1793
|
+
# @param [String] fields
|
1794
|
+
# Selector specifying which fields to include in a partial response.
|
1795
|
+
# @param [String] quota_user
|
1796
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1797
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1798
|
+
# @param [Google::Apis::RequestOptions] options
|
1799
|
+
# Request-specific options
|
1800
|
+
#
|
1801
|
+
# @yield [result, err] Result & error if block supplied
|
1802
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse] parsed result object
|
1803
|
+
# @yieldparam err [StandardError] error object if request failed
|
1804
|
+
#
|
1805
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse]
|
1806
|
+
#
|
1807
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1808
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1809
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1810
|
+
def list_property_user_links(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1811
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/userLinks', options)
|
1812
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse::Representation
|
1813
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListUserLinksResponse
|
1814
|
+
command.params['parent'] = parent unless parent.nil?
|
1815
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1816
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1817
|
+
command.query['fields'] = fields unless fields.nil?
|
1818
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1819
|
+
execute_or_queue_command(command, &block)
|
1820
|
+
end
|
1821
|
+
|
1822
|
+
# Updates a user link on an account or property.
|
1823
|
+
# @param [String] name
|
1824
|
+
# Example format: properties/1234/userLinks/5678
|
1825
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] google_analytics_admin_v1alpha_user_link_object
|
1826
|
+
# @param [String] fields
|
1827
|
+
# Selector specifying which fields to include in a partial response.
|
1828
|
+
# @param [String] quota_user
|
1829
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1830
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1831
|
+
# @param [Google::Apis::RequestOptions] options
|
1832
|
+
# Request-specific options
|
1833
|
+
#
|
1834
|
+
# @yield [result, err] Result & error if block supplied
|
1835
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink] parsed result object
|
1836
|
+
# @yieldparam err [StandardError] error object if request failed
|
1837
|
+
#
|
1838
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink]
|
1839
|
+
#
|
1840
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1841
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1842
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1843
|
+
def patch_property_user_link(name, google_analytics_admin_v1alpha_user_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1844
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
1845
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
|
1846
|
+
command.request_object = google_analytics_admin_v1alpha_user_link_object
|
1847
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink::Representation
|
1848
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaUserLink
|
1849
|
+
command.params['name'] = name unless name.nil?
|
1850
|
+
command.query['fields'] = fields unless fields.nil?
|
1851
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1852
|
+
execute_or_queue_command(command, &block)
|
1853
|
+
end
|
1854
|
+
|
1855
|
+
# Creates a web stream with the specified location and attributes.
|
1856
|
+
# @param [String] parent
|
1857
|
+
# Required. The parent resource where this web data stream will be created.
|
1858
|
+
# Format: properties/123
|
1859
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream] google_analytics_admin_v1alpha_web_data_stream_object
|
1860
|
+
# @param [String] fields
|
1861
|
+
# Selector specifying which fields to include in a partial response.
|
1862
|
+
# @param [String] quota_user
|
1863
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1864
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1865
|
+
# @param [Google::Apis::RequestOptions] options
|
1866
|
+
# Request-specific options
|
1867
|
+
#
|
1868
|
+
# @yield [result, err] Result & error if block supplied
|
1869
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream] parsed result object
|
1870
|
+
# @yieldparam err [StandardError] error object if request failed
|
1871
|
+
#
|
1872
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream]
|
1873
|
+
#
|
1874
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1875
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1876
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1877
|
+
def create_property_web_data_stream(parent, google_analytics_admin_v1alpha_web_data_stream_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1878
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/webDataStreams', options)
|
1879
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream::Representation
|
1880
|
+
command.request_object = google_analytics_admin_v1alpha_web_data_stream_object
|
1881
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream::Representation
|
1882
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream
|
1883
|
+
command.params['parent'] = parent unless parent.nil?
|
1884
|
+
command.query['fields'] = fields unless fields.nil?
|
1885
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1886
|
+
execute_or_queue_command(command, &block)
|
1887
|
+
end
|
1888
|
+
|
1889
|
+
# Deletes a web stream on a property.
|
1890
|
+
# @param [String] name
|
1891
|
+
# Required. The name of the web data stream to delete. Format: properties/`
|
1892
|
+
# property_id`/webDataStreams/`stream_id` Example: "properties/123/
|
1893
|
+
# webDataStreams/456"
|
1894
|
+
# @param [String] fields
|
1895
|
+
# Selector specifying which fields to include in a partial response.
|
1896
|
+
# @param [String] quota_user
|
1897
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1898
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1899
|
+
# @param [Google::Apis::RequestOptions] options
|
1900
|
+
# Request-specific options
|
1901
|
+
#
|
1902
|
+
# @yield [result, err] Result & error if block supplied
|
1903
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty] parsed result object
|
1904
|
+
# @yieldparam err [StandardError] error object if request failed
|
1905
|
+
#
|
1906
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty]
|
1907
|
+
#
|
1908
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1909
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1910
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1911
|
+
def delete_property_web_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
|
1912
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
1913
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty::Representation
|
1914
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleProtobufEmpty
|
1915
|
+
command.params['name'] = name unless name.nil?
|
1916
|
+
command.query['fields'] = fields unless fields.nil?
|
1917
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1918
|
+
execute_or_queue_command(command, &block)
|
1919
|
+
end
|
1920
|
+
|
1921
|
+
# Lookup for a single WebDataStream
|
1922
|
+
# @param [String] name
|
1923
|
+
# Required. The name of the web data stream to lookup. Format: properties/`
|
1924
|
+
# property_id`/webDataStreams/`stream_id` Example: "properties/123/
|
1925
|
+
# webDataStreams/456"
|
1926
|
+
# @param [String] fields
|
1927
|
+
# Selector specifying which fields to include in a partial response.
|
1928
|
+
# @param [String] quota_user
|
1929
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1930
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1931
|
+
# @param [Google::Apis::RequestOptions] options
|
1932
|
+
# Request-specific options
|
1933
|
+
#
|
1934
|
+
# @yield [result, err] Result & error if block supplied
|
1935
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream] parsed result object
|
1936
|
+
# @yieldparam err [StandardError] error object if request failed
|
1937
|
+
#
|
1938
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream]
|
1939
|
+
#
|
1940
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1941
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1942
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1943
|
+
def get_property_web_data_stream(name, fields: nil, quota_user: nil, options: nil, &block)
|
1944
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1945
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream::Representation
|
1946
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream
|
1947
|
+
command.params['name'] = name unless name.nil?
|
1948
|
+
command.query['fields'] = fields unless fields.nil?
|
1949
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1950
|
+
execute_or_queue_command(command, &block)
|
1951
|
+
end
|
1952
|
+
|
1953
|
+
# Returns the singleton enhanced measurement settings for this web stream. Note
|
1954
|
+
# that the stream must enable enhanced measurement for these settings to take
|
1955
|
+
# effect.
|
1956
|
+
# @param [String] name
|
1957
|
+
# Required. The name of the settings to lookup. Format: properties/`property_id`/
|
1958
|
+
# webDataStreams/`stream_id`/enhancedMeasurementSettings Example: "properties/
|
1959
|
+
# 1000/webDataStreams/2000/enhancedMeasurementSettings"
|
1960
|
+
# @param [String] fields
|
1961
|
+
# Selector specifying which fields to include in a partial response.
|
1962
|
+
# @param [String] quota_user
|
1963
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1964
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1965
|
+
# @param [Google::Apis::RequestOptions] options
|
1966
|
+
# Request-specific options
|
1967
|
+
#
|
1968
|
+
# @yield [result, err] Result & error if block supplied
|
1969
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings] parsed result object
|
1970
|
+
# @yieldparam err [StandardError] error object if request failed
|
1971
|
+
#
|
1972
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings]
|
1973
|
+
#
|
1974
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1975
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1976
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1977
|
+
def get_property_web_data_stream_enhanced_measurement_settings(name, fields: nil, quota_user: nil, options: nil, &block)
|
1978
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
1979
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings::Representation
|
1980
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
|
1981
|
+
command.params['name'] = name unless name.nil?
|
1982
|
+
command.query['fields'] = fields unless fields.nil?
|
1983
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1984
|
+
execute_or_queue_command(command, &block)
|
1985
|
+
end
|
1986
|
+
|
1987
|
+
# Returns the Site Tag for the specified web stream. Site Tags are immutable
|
1988
|
+
# singletons.
|
1989
|
+
# @param [String] name
|
1990
|
+
# Required. The name of the site tag to lookup. Note that site tags are
|
1991
|
+
# singletons and do not have unique IDs. Format: properties/`property_id`/
|
1992
|
+
# webDataStreams/`stream_id`/globalSiteTag Example: "properties/123/
|
1993
|
+
# webDataStreams/456/globalSiteTag"
|
1994
|
+
# @param [String] fields
|
1995
|
+
# Selector specifying which fields to include in a partial response.
|
1996
|
+
# @param [String] quota_user
|
1997
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1998
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1999
|
+
# @param [Google::Apis::RequestOptions] options
|
2000
|
+
# Request-specific options
|
2001
|
+
#
|
2002
|
+
# @yield [result, err] Result & error if block supplied
|
2003
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag] parsed result object
|
2004
|
+
# @yieldparam err [StandardError] error object if request failed
|
2005
|
+
#
|
2006
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag]
|
2007
|
+
#
|
2008
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2009
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2010
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2011
|
+
def get_property_web_data_stream_global_site_tag(name, fields: nil, quota_user: nil, options: nil, &block)
|
2012
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
2013
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag::Representation
|
2014
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaGlobalSiteTag
|
2015
|
+
command.params['name'] = name unless name.nil?
|
2016
|
+
command.query['fields'] = fields unless fields.nil?
|
2017
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2018
|
+
execute_or_queue_command(command, &block)
|
2019
|
+
end
|
2020
|
+
|
2021
|
+
# Returns child web data streams under the specified parent property. Web data
|
2022
|
+
# streams will be excluded if the caller does not have access. Returns an empty
|
2023
|
+
# list if no relevant web data streams are found.
|
2024
|
+
# @param [String] parent
|
2025
|
+
# Required. The name of the parent property. For example, to list results of web
|
2026
|
+
# streams under the property with Id 123: "properties/123"
|
2027
|
+
# @param [Fixnum] page_size
|
2028
|
+
# The maximum number of resources to return. If unspecified, at most 50
|
2029
|
+
# resources will be returned. The maximum value is 200; (higher values will be
|
2030
|
+
# coerced to the maximum)
|
2031
|
+
# @param [String] page_token
|
2032
|
+
# A page token, received from a previous `ListWebDataStreams` call. Provide this
|
2033
|
+
# to retrieve the subsequent page. When paginating, all other parameters
|
2034
|
+
# provided to `ListWebDataStreams` must match the call that provided the page
|
2035
|
+
# token.
|
2036
|
+
# @param [String] fields
|
2037
|
+
# Selector specifying which fields to include in a partial response.
|
2038
|
+
# @param [String] quota_user
|
2039
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2040
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2041
|
+
# @param [Google::Apis::RequestOptions] options
|
2042
|
+
# Request-specific options
|
2043
|
+
#
|
2044
|
+
# @yield [result, err] Result & error if block supplied
|
2045
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse] parsed result object
|
2046
|
+
# @yieldparam err [StandardError] error object if request failed
|
2047
|
+
#
|
2048
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse]
|
2049
|
+
#
|
2050
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2051
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2052
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2053
|
+
def list_property_web_data_streams(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2054
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/webDataStreams', options)
|
2055
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse::Representation
|
2056
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse
|
2057
|
+
command.params['parent'] = parent unless parent.nil?
|
2058
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
2059
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
2060
|
+
command.query['fields'] = fields unless fields.nil?
|
2061
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2062
|
+
execute_or_queue_command(command, &block)
|
2063
|
+
end
|
2064
|
+
|
2065
|
+
# Updates a web stream on a property.
|
2066
|
+
# @param [String] name
|
2067
|
+
# Output only. Resource name of this Data Stream. Format: properties/`
|
2068
|
+
# property_id`/webDataStreams/`stream_id` Example: "properties/1000/
|
2069
|
+
# webDataStreams/2000"
|
2070
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream] google_analytics_admin_v1alpha_web_data_stream_object
|
2071
|
+
# @param [String] update_mask
|
2072
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
2073
|
+
# To replace the entire entity, use one path with the string "*" to match all
|
2074
|
+
# fields.
|
2075
|
+
# @param [String] fields
|
2076
|
+
# Selector specifying which fields to include in a partial response.
|
2077
|
+
# @param [String] quota_user
|
2078
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2079
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2080
|
+
# @param [Google::Apis::RequestOptions] options
|
2081
|
+
# Request-specific options
|
2082
|
+
#
|
2083
|
+
# @yield [result, err] Result & error if block supplied
|
2084
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream] parsed result object
|
2085
|
+
# @yieldparam err [StandardError] error object if request failed
|
2086
|
+
#
|
2087
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream]
|
2088
|
+
#
|
2089
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2090
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2091
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2092
|
+
def patch_property_web_data_stream(name, google_analytics_admin_v1alpha_web_data_stream_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2093
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
2094
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream::Representation
|
2095
|
+
command.request_object = google_analytics_admin_v1alpha_web_data_stream_object
|
2096
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream::Representation
|
2097
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaWebDataStream
|
2098
|
+
command.params['name'] = name unless name.nil?
|
2099
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2100
|
+
command.query['fields'] = fields unless fields.nil?
|
2101
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2102
|
+
execute_or_queue_command(command, &block)
|
2103
|
+
end
|
2104
|
+
|
2105
|
+
# Updates the singleton enhanced measurement settings for this web stream. Note
|
2106
|
+
# that the stream must enable enhanced measurement for these settings to take
|
2107
|
+
# effect.
|
2108
|
+
# @param [String] name
|
2109
|
+
# Output only. Resource name of this Data Stream. Format: properties/`
|
2110
|
+
# property_id`/webDataStreams/`stream_id`/enhancedMeasurementSettings Example: "
|
2111
|
+
# properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
|
2112
|
+
# @param [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings] google_analytics_admin_v1alpha_enhanced_measurement_settings_object
|
2113
|
+
# @param [String] update_mask
|
2114
|
+
# Required. The list of fields to be updated. Omitted fields will not be updated.
|
2115
|
+
# To replace the entire entity, use one path with the string "*" to match all
|
2116
|
+
# fields.
|
2117
|
+
# @param [String] fields
|
2118
|
+
# Selector specifying which fields to include in a partial response.
|
2119
|
+
# @param [String] quota_user
|
2120
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2121
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2122
|
+
# @param [Google::Apis::RequestOptions] options
|
2123
|
+
# Request-specific options
|
2124
|
+
#
|
2125
|
+
# @yield [result, err] Result & error if block supplied
|
2126
|
+
# @yieldparam result [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings] parsed result object
|
2127
|
+
# @yieldparam err [StandardError] error object if request failed
|
2128
|
+
#
|
2129
|
+
# @return [Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings]
|
2130
|
+
#
|
2131
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2132
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2133
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2134
|
+
def update_property_web_data_stream_enhanced_measurement_settings(name, google_analytics_admin_v1alpha_enhanced_measurement_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2135
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
2136
|
+
command.request_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings::Representation
|
2137
|
+
command.request_object = google_analytics_admin_v1alpha_enhanced_measurement_settings_object
|
2138
|
+
command.response_representation = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings::Representation
|
2139
|
+
command.response_class = Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings
|
2140
|
+
command.params['name'] = name unless name.nil?
|
2141
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
2142
|
+
command.query['fields'] = fields unless fields.nil?
|
2143
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2144
|
+
execute_or_queue_command(command, &block)
|
2145
|
+
end
|
2146
|
+
|
2147
|
+
protected
|
2148
|
+
|
2149
|
+
def apply_command_defaults(command)
|
2150
|
+
command.query['key'] = key unless key.nil?
|
2151
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2152
|
+
end
|
2153
|
+
end
|
2154
|
+
end
|
2155
|
+
end
|
2156
|
+
end
|