google-apis-analytics_v3 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,3754 @@
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 AnalyticsV3
23
+ # Google Analytics API
24
+ #
25
+ # Views and manages your Google Analytics data.
26
+ #
27
+ # @example
28
+ # require 'google/apis/analytics_v3'
29
+ #
30
+ # Analytics = Google::Apis::AnalyticsV3 # Alias the module
31
+ # service = Analytics::AnalyticsService.new
32
+ #
33
+ # @see https://developers.google.com/analytics/
34
+ class AnalyticsService < 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
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
42
+ # characters.
43
+ attr_accessor :quota_user
44
+
45
+ # @return [String]
46
+ # Deprecated. Please use quotaUser instead.
47
+ attr_accessor :user_ip
48
+
49
+ def initialize
50
+ super('https://analytics.googleapis.com/', 'analytics/v3/',
51
+ client_name: 'google-apis-analytics_v3',
52
+ client_version: Google::Apis::AnalyticsV3::GEM_VERSION)
53
+ @batch_path = 'batch/analytics/v3'
54
+ end
55
+
56
+ # Returns Analytics data for a view (profile).
57
+ # @param [String] ids
58
+ # Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX,
59
+ # where XXXX is the Analytics view (profile) ID.
60
+ # @param [String] start_date
61
+ # Start date for fetching Analytics data. Requests can specify a start date
62
+ # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or
63
+ # 7daysAgo). The default value is 7daysAgo.
64
+ # @param [String] end_date
65
+ # End date for fetching Analytics data. Request can should specify an end date
66
+ # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or
67
+ # 7daysAgo). The default value is yesterday.
68
+ # @param [String] metrics
69
+ # A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'.
70
+ # At least one metric must be specified.
71
+ # @param [String] dimensions
72
+ # A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
73
+ # @param [String] filters
74
+ # A comma-separated list of dimension or metric filters to be applied to
75
+ # Analytics data.
76
+ # @param [Boolean] include_empty_rows
77
+ # The response will include empty rows if this parameter is set to true, the
78
+ # default is true
79
+ # @param [Fixnum] max_results
80
+ # The maximum number of entries to include in this feed.
81
+ # @param [String] output
82
+ # The selected format for the response. Default format is JSON.
83
+ # @param [String] sampling_level
84
+ # The desired sampling level.
85
+ # @param [String] segment
86
+ # An Analytics segment to be applied to data.
87
+ # @param [String] sort
88
+ # A comma-separated list of dimensions or metrics that determine the sort order
89
+ # for Analytics data.
90
+ # @param [Fixnum] start_index
91
+ # An index of the first entity to retrieve. Use this parameter as a pagination
92
+ # mechanism along with the max-results parameter.
93
+ # @param [String] fields
94
+ # Selector specifying which fields to include in a partial response.
95
+ # @param [String] quota_user
96
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
97
+ # characters.
98
+ # @param [String] user_ip
99
+ # Deprecated. Please use quotaUser instead.
100
+ # @param [Google::Apis::RequestOptions] options
101
+ # Request-specific options
102
+ #
103
+ # @yield [result, err] Result & error if block supplied
104
+ # @yieldparam result [Google::Apis::AnalyticsV3::GaData] parsed result object
105
+ # @yieldparam err [StandardError] error object if request failed
106
+ #
107
+ # @return [Google::Apis::AnalyticsV3::GaData]
108
+ #
109
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
110
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
111
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
112
+ def get_ga_data(ids, start_date, end_date, metrics, dimensions: nil, filters: nil, include_empty_rows: nil, max_results: nil, output: nil, sampling_level: nil, segment: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
113
+ command = make_simple_command(:get, 'data/ga', options)
114
+ command.response_representation = Google::Apis::AnalyticsV3::GaData::Representation
115
+ command.response_class = Google::Apis::AnalyticsV3::GaData
116
+ command.query['dimensions'] = dimensions unless dimensions.nil?
117
+ command.query['end-date'] = end_date unless end_date.nil?
118
+ command.query['filters'] = filters unless filters.nil?
119
+ command.query['ids'] = ids unless ids.nil?
120
+ command.query['include-empty-rows'] = include_empty_rows unless include_empty_rows.nil?
121
+ command.query['max-results'] = max_results unless max_results.nil?
122
+ command.query['metrics'] = metrics unless metrics.nil?
123
+ command.query['output'] = output unless output.nil?
124
+ command.query['samplingLevel'] = sampling_level unless sampling_level.nil?
125
+ command.query['segment'] = segment unless segment.nil?
126
+ command.query['sort'] = sort unless sort.nil?
127
+ command.query['start-date'] = start_date unless start_date.nil?
128
+ command.query['start-index'] = start_index unless start_index.nil?
129
+ command.query['fields'] = fields unless fields.nil?
130
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
131
+ command.query['userIp'] = user_ip unless user_ip.nil?
132
+ execute_or_queue_command(command, &block)
133
+ end
134
+
135
+ # Returns Analytics Multi-Channel Funnels data for a view (profile).
136
+ # @param [String] ids
137
+ # Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX,
138
+ # where XXXX is the Analytics view (profile) ID.
139
+ # @param [String] start_date
140
+ # Start date for fetching Analytics data. Requests can specify a start date
141
+ # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or
142
+ # 7daysAgo). The default value is 7daysAgo.
143
+ # @param [String] end_date
144
+ # End date for fetching Analytics data. Requests can specify a start date
145
+ # formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or
146
+ # 7daysAgo). The default value is 7daysAgo.
147
+ # @param [String] metrics
148
+ # A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:
149
+ # totalConversions,mcf:totalConversionValue'. At least one metric must be
150
+ # specified.
151
+ # @param [String] dimensions
152
+ # A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,
153
+ # mcf:medium'.
154
+ # @param [String] filters
155
+ # A comma-separated list of dimension or metric filters to be applied to the
156
+ # Analytics data.
157
+ # @param [Fixnum] max_results
158
+ # The maximum number of entries to include in this feed.
159
+ # @param [String] sampling_level
160
+ # The desired sampling level.
161
+ # @param [String] sort
162
+ # A comma-separated list of dimensions or metrics that determine the sort order
163
+ # for the Analytics data.
164
+ # @param [Fixnum] start_index
165
+ # An index of the first entity to retrieve. Use this parameter as a pagination
166
+ # mechanism along with the max-results parameter.
167
+ # @param [String] fields
168
+ # Selector specifying which fields to include in a partial response.
169
+ # @param [String] quota_user
170
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
171
+ # characters.
172
+ # @param [String] user_ip
173
+ # Deprecated. Please use quotaUser instead.
174
+ # @param [Google::Apis::RequestOptions] options
175
+ # Request-specific options
176
+ #
177
+ # @yield [result, err] Result & error if block supplied
178
+ # @yieldparam result [Google::Apis::AnalyticsV3::McfData] parsed result object
179
+ # @yieldparam err [StandardError] error object if request failed
180
+ #
181
+ # @return [Google::Apis::AnalyticsV3::McfData]
182
+ #
183
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
184
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
185
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
186
+ def get_mcf_data(ids, start_date, end_date, metrics, dimensions: nil, filters: nil, max_results: nil, sampling_level: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
187
+ command = make_simple_command(:get, 'data/mcf', options)
188
+ command.response_representation = Google::Apis::AnalyticsV3::McfData::Representation
189
+ command.response_class = Google::Apis::AnalyticsV3::McfData
190
+ command.query['dimensions'] = dimensions unless dimensions.nil?
191
+ command.query['end-date'] = end_date unless end_date.nil?
192
+ command.query['filters'] = filters unless filters.nil?
193
+ command.query['ids'] = ids unless ids.nil?
194
+ command.query['max-results'] = max_results unless max_results.nil?
195
+ command.query['metrics'] = metrics unless metrics.nil?
196
+ command.query['samplingLevel'] = sampling_level unless sampling_level.nil?
197
+ command.query['sort'] = sort unless sort.nil?
198
+ command.query['start-date'] = start_date unless start_date.nil?
199
+ command.query['start-index'] = start_index unless start_index.nil?
200
+ command.query['fields'] = fields unless fields.nil?
201
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
202
+ command.query['userIp'] = user_ip unless user_ip.nil?
203
+ execute_or_queue_command(command, &block)
204
+ end
205
+
206
+ # Returns real time data for a view (profile).
207
+ # @param [String] ids
208
+ # Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX,
209
+ # where XXXX is the Analytics view (profile) ID.
210
+ # @param [String] metrics
211
+ # A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least
212
+ # one metric must be specified.
213
+ # @param [String] dimensions
214
+ # A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.
215
+ # @param [String] filters
216
+ # A comma-separated list of dimension or metric filters to be applied to real
217
+ # time data.
218
+ # @param [Fixnum] max_results
219
+ # The maximum number of entries to include in this feed.
220
+ # @param [String] sort
221
+ # A comma-separated list of dimensions or metrics that determine the sort order
222
+ # for real time data.
223
+ # @param [String] fields
224
+ # Selector specifying which fields to include in a partial response.
225
+ # @param [String] quota_user
226
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
227
+ # characters.
228
+ # @param [String] user_ip
229
+ # Deprecated. Please use quotaUser instead.
230
+ # @param [Google::Apis::RequestOptions] options
231
+ # Request-specific options
232
+ #
233
+ # @yield [result, err] Result & error if block supplied
234
+ # @yieldparam result [Google::Apis::AnalyticsV3::RealtimeData] parsed result object
235
+ # @yieldparam err [StandardError] error object if request failed
236
+ #
237
+ # @return [Google::Apis::AnalyticsV3::RealtimeData]
238
+ #
239
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
240
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
241
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
242
+ def get_realtime_data(ids, metrics, dimensions: nil, filters: nil, max_results: nil, sort: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
243
+ command = make_simple_command(:get, 'data/realtime', options)
244
+ command.response_representation = Google::Apis::AnalyticsV3::RealtimeData::Representation
245
+ command.response_class = Google::Apis::AnalyticsV3::RealtimeData
246
+ command.query['dimensions'] = dimensions unless dimensions.nil?
247
+ command.query['filters'] = filters unless filters.nil?
248
+ command.query['ids'] = ids unless ids.nil?
249
+ command.query['max-results'] = max_results unless max_results.nil?
250
+ command.query['metrics'] = metrics unless metrics.nil?
251
+ command.query['sort'] = sort unless sort.nil?
252
+ command.query['fields'] = fields unless fields.nil?
253
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
254
+ command.query['userIp'] = user_ip unless user_ip.nil?
255
+ execute_or_queue_command(command, &block)
256
+ end
257
+
258
+ # Lists account summaries (lightweight tree comprised of accounts/properties/
259
+ # profiles) to which the user has access.
260
+ # @param [Fixnum] max_results
261
+ # The maximum number of account summaries to include in this response, where the
262
+ # largest acceptable value is 1000.
263
+ # @param [Fixnum] start_index
264
+ # An index of the first entity to retrieve. Use this parameter as a pagination
265
+ # mechanism along with the max-results parameter.
266
+ # @param [String] fields
267
+ # Selector specifying which fields to include in a partial response.
268
+ # @param [String] quota_user
269
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
270
+ # characters.
271
+ # @param [String] user_ip
272
+ # Deprecated. Please use quotaUser instead.
273
+ # @param [Google::Apis::RequestOptions] options
274
+ # Request-specific options
275
+ #
276
+ # @yield [result, err] Result & error if block supplied
277
+ # @yieldparam result [Google::Apis::AnalyticsV3::AccountSummaries] parsed result object
278
+ # @yieldparam err [StandardError] error object if request failed
279
+ #
280
+ # @return [Google::Apis::AnalyticsV3::AccountSummaries]
281
+ #
282
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
283
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
284
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
285
+ def list_account_summaries(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
286
+ command = make_simple_command(:get, 'management/accountSummaries', options)
287
+ command.response_representation = Google::Apis::AnalyticsV3::AccountSummaries::Representation
288
+ command.response_class = Google::Apis::AnalyticsV3::AccountSummaries
289
+ command.query['max-results'] = max_results unless max_results.nil?
290
+ command.query['start-index'] = start_index unless start_index.nil?
291
+ command.query['fields'] = fields unless fields.nil?
292
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
293
+ command.query['userIp'] = user_ip unless user_ip.nil?
294
+ execute_or_queue_command(command, &block)
295
+ end
296
+
297
+ # Removes a user from the given account.
298
+ # @param [String] account_id
299
+ # Account ID to delete the user link for.
300
+ # @param [String] link_id
301
+ # Link ID to delete the user link for.
302
+ # @param [String] fields
303
+ # Selector specifying which fields to include in a partial response.
304
+ # @param [String] quota_user
305
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
306
+ # characters.
307
+ # @param [String] user_ip
308
+ # Deprecated. Please use quotaUser instead.
309
+ # @param [Google::Apis::RequestOptions] options
310
+ # Request-specific options
311
+ #
312
+ # @yield [result, err] Result & error if block supplied
313
+ # @yieldparam result [NilClass] No result returned for this method
314
+ # @yieldparam err [StandardError] error object if request failed
315
+ #
316
+ # @return [void]
317
+ #
318
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
319
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
320
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
321
+ def delete_account_user_link(account_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
322
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/entityUserLinks/{linkId}', options)
323
+ command.params['accountId'] = account_id unless account_id.nil?
324
+ command.params['linkId'] = link_id unless link_id.nil?
325
+ command.query['fields'] = fields unless fields.nil?
326
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
327
+ command.query['userIp'] = user_ip unless user_ip.nil?
328
+ execute_or_queue_command(command, &block)
329
+ end
330
+
331
+ # Adds a new user to the given account.
332
+ # @param [String] account_id
333
+ # Account ID to create the user link for.
334
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
335
+ # @param [String] fields
336
+ # Selector specifying which fields to include in a partial response.
337
+ # @param [String] quota_user
338
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
339
+ # characters.
340
+ # @param [String] user_ip
341
+ # Deprecated. Please use quotaUser instead.
342
+ # @param [Google::Apis::RequestOptions] options
343
+ # Request-specific options
344
+ #
345
+ # @yield [result, err] Result & error if block supplied
346
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
347
+ # @yieldparam err [StandardError] error object if request failed
348
+ #
349
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
350
+ #
351
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
352
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
353
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
354
+ def insert_account_user_link(account_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
355
+ command = make_simple_command(:post, 'management/accounts/{accountId}/entityUserLinks', options)
356
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
357
+ command.request_object = entity_user_link_object
358
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
359
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
360
+ command.params['accountId'] = account_id unless account_id.nil?
361
+ command.query['fields'] = fields unless fields.nil?
362
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
363
+ command.query['userIp'] = user_ip unless user_ip.nil?
364
+ execute_or_queue_command(command, &block)
365
+ end
366
+
367
+ # Lists account-user links for a given account.
368
+ # @param [String] account_id
369
+ # Account ID to retrieve the user links for.
370
+ # @param [Fixnum] max_results
371
+ # The maximum number of account-user links to include in this response.
372
+ # @param [Fixnum] start_index
373
+ # An index of the first account-user link to retrieve. Use this parameter as a
374
+ # pagination mechanism along with the max-results parameter.
375
+ # @param [String] fields
376
+ # Selector specifying which fields to include in a partial response.
377
+ # @param [String] quota_user
378
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
379
+ # characters.
380
+ # @param [String] user_ip
381
+ # Deprecated. Please use quotaUser instead.
382
+ # @param [Google::Apis::RequestOptions] options
383
+ # Request-specific options
384
+ #
385
+ # @yield [result, err] Result & error if block supplied
386
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLinks] parsed result object
387
+ # @yieldparam err [StandardError] error object if request failed
388
+ #
389
+ # @return [Google::Apis::AnalyticsV3::EntityUserLinks]
390
+ #
391
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
392
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
393
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
394
+ def list_account_user_links(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
395
+ command = make_simple_command(:get, 'management/accounts/{accountId}/entityUserLinks', options)
396
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation
397
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks
398
+ command.params['accountId'] = account_id unless account_id.nil?
399
+ command.query['max-results'] = max_results unless max_results.nil?
400
+ command.query['start-index'] = start_index unless start_index.nil?
401
+ command.query['fields'] = fields unless fields.nil?
402
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
403
+ command.query['userIp'] = user_ip unless user_ip.nil?
404
+ execute_or_queue_command(command, &block)
405
+ end
406
+
407
+ # Updates permissions for an existing user on the given account.
408
+ # @param [String] account_id
409
+ # Account ID to update the account-user link for.
410
+ # @param [String] link_id
411
+ # Link ID to update the account-user link for.
412
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
413
+ # @param [String] fields
414
+ # Selector specifying which fields to include in a partial response.
415
+ # @param [String] quota_user
416
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
417
+ # characters.
418
+ # @param [String] user_ip
419
+ # Deprecated. Please use quotaUser instead.
420
+ # @param [Google::Apis::RequestOptions] options
421
+ # Request-specific options
422
+ #
423
+ # @yield [result, err] Result & error if block supplied
424
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
425
+ # @yieldparam err [StandardError] error object if request failed
426
+ #
427
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
428
+ #
429
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
430
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
431
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
432
+ def update_account_user_link(account_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
433
+ command = make_simple_command(:put, 'management/accounts/{accountId}/entityUserLinks/{linkId}', options)
434
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
435
+ command.request_object = entity_user_link_object
436
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
437
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
438
+ command.params['accountId'] = account_id unless account_id.nil?
439
+ command.params['linkId'] = link_id unless link_id.nil?
440
+ command.query['fields'] = fields unless fields.nil?
441
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
442
+ command.query['userIp'] = user_ip unless user_ip.nil?
443
+ execute_or_queue_command(command, &block)
444
+ end
445
+
446
+ # Lists all accounts to which the user has access.
447
+ # @param [Fixnum] max_results
448
+ # The maximum number of accounts to include in this response.
449
+ # @param [Fixnum] start_index
450
+ # An index of the first account to retrieve. Use this parameter as a pagination
451
+ # mechanism along with the max-results parameter.
452
+ # @param [String] fields
453
+ # Selector specifying which fields to include in a partial response.
454
+ # @param [String] quota_user
455
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
456
+ # characters.
457
+ # @param [String] user_ip
458
+ # Deprecated. Please use quotaUser instead.
459
+ # @param [Google::Apis::RequestOptions] options
460
+ # Request-specific options
461
+ #
462
+ # @yield [result, err] Result & error if block supplied
463
+ # @yieldparam result [Google::Apis::AnalyticsV3::Accounts] parsed result object
464
+ # @yieldparam err [StandardError] error object if request failed
465
+ #
466
+ # @return [Google::Apis::AnalyticsV3::Accounts]
467
+ #
468
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
469
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
470
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
471
+ def list_accounts(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
472
+ command = make_simple_command(:get, 'management/accounts', options)
473
+ command.response_representation = Google::Apis::AnalyticsV3::Accounts::Representation
474
+ command.response_class = Google::Apis::AnalyticsV3::Accounts
475
+ command.query['max-results'] = max_results unless max_results.nil?
476
+ command.query['start-index'] = start_index unless start_index.nil?
477
+ command.query['fields'] = fields unless fields.nil?
478
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
479
+ command.query['userIp'] = user_ip unless user_ip.nil?
480
+ execute_or_queue_command(command, &block)
481
+ end
482
+
483
+ # Hashes the given Client ID.
484
+ # @param [Google::Apis::AnalyticsV3::HashClientIdRequest] hash_client_id_request_object
485
+ # @param [String] fields
486
+ # Selector specifying which fields to include in a partial response.
487
+ # @param [String] quota_user
488
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
489
+ # characters.
490
+ # @param [String] user_ip
491
+ # Deprecated. Please use quotaUser instead.
492
+ # @param [Google::Apis::RequestOptions] options
493
+ # Request-specific options
494
+ #
495
+ # @yield [result, err] Result & error if block supplied
496
+ # @yieldparam result [Google::Apis::AnalyticsV3::HashClientIdResponse] parsed result object
497
+ # @yieldparam err [StandardError] error object if request failed
498
+ #
499
+ # @return [Google::Apis::AnalyticsV3::HashClientIdResponse]
500
+ #
501
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
502
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
503
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
504
+ def hash_client_id(hash_client_id_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
505
+ command = make_simple_command(:post, 'management/clientId:hashClientId', options)
506
+ command.request_representation = Google::Apis::AnalyticsV3::HashClientIdRequest::Representation
507
+ command.request_object = hash_client_id_request_object
508
+ command.response_representation = Google::Apis::AnalyticsV3::HashClientIdResponse::Representation
509
+ command.response_class = Google::Apis::AnalyticsV3::HashClientIdResponse
510
+ command.query['fields'] = fields unless fields.nil?
511
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
512
+ command.query['userIp'] = user_ip unless user_ip.nil?
513
+ execute_or_queue_command(command, &block)
514
+ end
515
+
516
+ # List custom data sources to which the user has access.
517
+ # @param [String] account_id
518
+ # Account Id for the custom data sources to retrieve.
519
+ # @param [String] web_property_id
520
+ # Web property Id for the custom data sources to retrieve.
521
+ # @param [Fixnum] max_results
522
+ # The maximum number of custom data sources to include in this response.
523
+ # @param [Fixnum] start_index
524
+ # A 1-based index of the first custom data source to retrieve. Use this
525
+ # parameter as a pagination mechanism along with the max-results parameter.
526
+ # @param [String] fields
527
+ # Selector specifying which fields to include in a partial response.
528
+ # @param [String] quota_user
529
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
530
+ # characters.
531
+ # @param [String] user_ip
532
+ # Deprecated. Please use quotaUser instead.
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::AnalyticsV3::CustomDataSources] parsed result object
538
+ # @yieldparam err [StandardError] error object if request failed
539
+ #
540
+ # @return [Google::Apis::AnalyticsV3::CustomDataSources]
541
+ #
542
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
543
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
544
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
545
+ def list_custom_data_sources(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
546
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources', options)
547
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDataSources::Representation
548
+ command.response_class = Google::Apis::AnalyticsV3::CustomDataSources
549
+ command.params['accountId'] = account_id unless account_id.nil?
550
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
551
+ command.query['max-results'] = max_results unless max_results.nil?
552
+ command.query['start-index'] = start_index unless start_index.nil?
553
+ command.query['fields'] = fields unless fields.nil?
554
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
555
+ command.query['userIp'] = user_ip unless user_ip.nil?
556
+ execute_or_queue_command(command, &block)
557
+ end
558
+
559
+ # Get a custom dimension to which the user has access.
560
+ # @param [String] account_id
561
+ # Account ID for the custom dimension to retrieve.
562
+ # @param [String] web_property_id
563
+ # Web property ID for the custom dimension to retrieve.
564
+ # @param [String] custom_dimension_id
565
+ # The ID of the custom dimension to retrieve.
566
+ # @param [String] fields
567
+ # Selector specifying which fields to include in a partial response.
568
+ # @param [String] quota_user
569
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
570
+ # characters.
571
+ # @param [String] user_ip
572
+ # Deprecated. Please use quotaUser instead.
573
+ # @param [Google::Apis::RequestOptions] options
574
+ # Request-specific options
575
+ #
576
+ # @yield [result, err] Result & error if block supplied
577
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object
578
+ # @yieldparam err [StandardError] error object if request failed
579
+ #
580
+ # @return [Google::Apis::AnalyticsV3::CustomDimension]
581
+ #
582
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
583
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
584
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
585
+ def get_custom_dimension(account_id, web_property_id, custom_dimension_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
586
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options)
587
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
588
+ command.response_class = Google::Apis::AnalyticsV3::CustomDimension
589
+ command.params['accountId'] = account_id unless account_id.nil?
590
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
591
+ command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_id.nil?
592
+ command.query['fields'] = fields unless fields.nil?
593
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
594
+ command.query['userIp'] = user_ip unless user_ip.nil?
595
+ execute_or_queue_command(command, &block)
596
+ end
597
+
598
+ # Create a new custom dimension.
599
+ # @param [String] account_id
600
+ # Account ID for the custom dimension to create.
601
+ # @param [String] web_property_id
602
+ # Web property ID for the custom dimension to create.
603
+ # @param [Google::Apis::AnalyticsV3::CustomDimension] custom_dimension_object
604
+ # @param [String] fields
605
+ # Selector specifying which fields to include in a partial response.
606
+ # @param [String] quota_user
607
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
608
+ # characters.
609
+ # @param [String] user_ip
610
+ # Deprecated. Please use quotaUser instead.
611
+ # @param [Google::Apis::RequestOptions] options
612
+ # Request-specific options
613
+ #
614
+ # @yield [result, err] Result & error if block supplied
615
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object
616
+ # @yieldparam err [StandardError] error object if request failed
617
+ #
618
+ # @return [Google::Apis::AnalyticsV3::CustomDimension]
619
+ #
620
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
621
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
622
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
623
+ def insert_custom_dimension(account_id, web_property_id, custom_dimension_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
624
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions', options)
625
+ command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
626
+ command.request_object = custom_dimension_object
627
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
628
+ command.response_class = Google::Apis::AnalyticsV3::CustomDimension
629
+ command.params['accountId'] = account_id unless account_id.nil?
630
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
631
+ command.query['fields'] = fields unless fields.nil?
632
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
633
+ command.query['userIp'] = user_ip unless user_ip.nil?
634
+ execute_or_queue_command(command, &block)
635
+ end
636
+
637
+ # Lists custom dimensions to which the user has access.
638
+ # @param [String] account_id
639
+ # Account ID for the custom dimensions to retrieve.
640
+ # @param [String] web_property_id
641
+ # Web property ID for the custom dimensions to retrieve.
642
+ # @param [Fixnum] max_results
643
+ # The maximum number of custom dimensions to include in this response.
644
+ # @param [Fixnum] start_index
645
+ # An index of the first entity to retrieve. Use this parameter as a pagination
646
+ # mechanism along with the max-results parameter.
647
+ # @param [String] fields
648
+ # Selector specifying which fields to include in a partial response.
649
+ # @param [String] quota_user
650
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
651
+ # characters.
652
+ # @param [String] user_ip
653
+ # Deprecated. Please use quotaUser instead.
654
+ # @param [Google::Apis::RequestOptions] options
655
+ # Request-specific options
656
+ #
657
+ # @yield [result, err] Result & error if block supplied
658
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimensions] parsed result object
659
+ # @yieldparam err [StandardError] error object if request failed
660
+ #
661
+ # @return [Google::Apis::AnalyticsV3::CustomDimensions]
662
+ #
663
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
664
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
665
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
666
+ def list_custom_dimensions(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
667
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions', options)
668
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDimensions::Representation
669
+ command.response_class = Google::Apis::AnalyticsV3::CustomDimensions
670
+ command.params['accountId'] = account_id unless account_id.nil?
671
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
672
+ command.query['max-results'] = max_results unless max_results.nil?
673
+ command.query['start-index'] = start_index unless start_index.nil?
674
+ command.query['fields'] = fields unless fields.nil?
675
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
676
+ command.query['userIp'] = user_ip unless user_ip.nil?
677
+ execute_or_queue_command(command, &block)
678
+ end
679
+
680
+ # Updates an existing custom dimension. This method supports patch semantics.
681
+ # @param [String] account_id
682
+ # Account ID for the custom dimension to update.
683
+ # @param [String] web_property_id
684
+ # Web property ID for the custom dimension to update.
685
+ # @param [String] custom_dimension_id
686
+ # Custom dimension ID for the custom dimension to update.
687
+ # @param [Google::Apis::AnalyticsV3::CustomDimension] custom_dimension_object
688
+ # @param [Boolean] ignore_custom_data_source_links
689
+ # Force the update and ignore any warnings related to the custom dimension being
690
+ # linked to a custom data source / data set.
691
+ # @param [String] fields
692
+ # Selector specifying which fields to include in a partial response.
693
+ # @param [String] quota_user
694
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
695
+ # characters.
696
+ # @param [String] user_ip
697
+ # Deprecated. Please use quotaUser instead.
698
+ # @param [Google::Apis::RequestOptions] options
699
+ # Request-specific options
700
+ #
701
+ # @yield [result, err] Result & error if block supplied
702
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object
703
+ # @yieldparam err [StandardError] error object if request failed
704
+ #
705
+ # @return [Google::Apis::AnalyticsV3::CustomDimension]
706
+ #
707
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
708
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
709
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
710
+ def patch_custom_dimension(account_id, web_property_id, custom_dimension_id, custom_dimension_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
711
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options)
712
+ command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
713
+ command.request_object = custom_dimension_object
714
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
715
+ command.response_class = Google::Apis::AnalyticsV3::CustomDimension
716
+ command.params['accountId'] = account_id unless account_id.nil?
717
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
718
+ command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_id.nil?
719
+ command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
720
+ command.query['fields'] = fields unless fields.nil?
721
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
722
+ command.query['userIp'] = user_ip unless user_ip.nil?
723
+ execute_or_queue_command(command, &block)
724
+ end
725
+
726
+ # Updates an existing custom dimension.
727
+ # @param [String] account_id
728
+ # Account ID for the custom dimension to update.
729
+ # @param [String] web_property_id
730
+ # Web property ID for the custom dimension to update.
731
+ # @param [String] custom_dimension_id
732
+ # Custom dimension ID for the custom dimension to update.
733
+ # @param [Google::Apis::AnalyticsV3::CustomDimension] custom_dimension_object
734
+ # @param [Boolean] ignore_custom_data_source_links
735
+ # Force the update and ignore any warnings related to the custom dimension being
736
+ # linked to a custom data source / data set.
737
+ # @param [String] fields
738
+ # Selector specifying which fields to include in a partial response.
739
+ # @param [String] quota_user
740
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
741
+ # characters.
742
+ # @param [String] user_ip
743
+ # Deprecated. Please use quotaUser instead.
744
+ # @param [Google::Apis::RequestOptions] options
745
+ # Request-specific options
746
+ #
747
+ # @yield [result, err] Result & error if block supplied
748
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomDimension] parsed result object
749
+ # @yieldparam err [StandardError] error object if request failed
750
+ #
751
+ # @return [Google::Apis::AnalyticsV3::CustomDimension]
752
+ #
753
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
754
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
755
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
756
+ def update_custom_dimension(account_id, web_property_id, custom_dimension_id, custom_dimension_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
757
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options)
758
+ command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
759
+ command.request_object = custom_dimension_object
760
+ command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
761
+ command.response_class = Google::Apis::AnalyticsV3::CustomDimension
762
+ command.params['accountId'] = account_id unless account_id.nil?
763
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
764
+ command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_id.nil?
765
+ command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
766
+ command.query['fields'] = fields unless fields.nil?
767
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
768
+ command.query['userIp'] = user_ip unless user_ip.nil?
769
+ execute_or_queue_command(command, &block)
770
+ end
771
+
772
+ # Get a custom metric to which the user has access.
773
+ # @param [String] account_id
774
+ # Account ID for the custom metric to retrieve.
775
+ # @param [String] web_property_id
776
+ # Web property ID for the custom metric to retrieve.
777
+ # @param [String] custom_metric_id
778
+ # The ID of the custom metric to retrieve.
779
+ # @param [String] fields
780
+ # Selector specifying which fields to include in a partial response.
781
+ # @param [String] quota_user
782
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
783
+ # characters.
784
+ # @param [String] user_ip
785
+ # Deprecated. Please use quotaUser instead.
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::AnalyticsV3::CustomMetric] parsed result object
791
+ # @yieldparam err [StandardError] error object if request failed
792
+ #
793
+ # @return [Google::Apis::AnalyticsV3::CustomMetric]
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 get_custom_metric(account_id, web_property_id, custom_metric_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
799
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options)
800
+ command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
801
+ command.response_class = Google::Apis::AnalyticsV3::CustomMetric
802
+ command.params['accountId'] = account_id unless account_id.nil?
803
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
804
+ command.params['customMetricId'] = custom_metric_id unless custom_metric_id.nil?
805
+ command.query['fields'] = fields unless fields.nil?
806
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
807
+ command.query['userIp'] = user_ip unless user_ip.nil?
808
+ execute_or_queue_command(command, &block)
809
+ end
810
+
811
+ # Create a new custom metric.
812
+ # @param [String] account_id
813
+ # Account ID for the custom metric to create.
814
+ # @param [String] web_property_id
815
+ # Web property ID for the custom dimension to create.
816
+ # @param [Google::Apis::AnalyticsV3::CustomMetric] custom_metric_object
817
+ # @param [String] fields
818
+ # Selector specifying which fields to include in a partial response.
819
+ # @param [String] quota_user
820
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
821
+ # characters.
822
+ # @param [String] user_ip
823
+ # Deprecated. Please use quotaUser instead.
824
+ # @param [Google::Apis::RequestOptions] options
825
+ # Request-specific options
826
+ #
827
+ # @yield [result, err] Result & error if block supplied
828
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetric] parsed result object
829
+ # @yieldparam err [StandardError] error object if request failed
830
+ #
831
+ # @return [Google::Apis::AnalyticsV3::CustomMetric]
832
+ #
833
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
834
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
835
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
836
+ def insert_custom_metric(account_id, web_property_id, custom_metric_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
837
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics', options)
838
+ command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
839
+ command.request_object = custom_metric_object
840
+ command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
841
+ command.response_class = Google::Apis::AnalyticsV3::CustomMetric
842
+ command.params['accountId'] = account_id unless account_id.nil?
843
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
844
+ command.query['fields'] = fields unless fields.nil?
845
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
846
+ command.query['userIp'] = user_ip unless user_ip.nil?
847
+ execute_or_queue_command(command, &block)
848
+ end
849
+
850
+ # Lists custom metrics to which the user has access.
851
+ # @param [String] account_id
852
+ # Account ID for the custom metrics to retrieve.
853
+ # @param [String] web_property_id
854
+ # Web property ID for the custom metrics to retrieve.
855
+ # @param [Fixnum] max_results
856
+ # The maximum number of custom metrics to include in this response.
857
+ # @param [Fixnum] start_index
858
+ # An index of the first entity to retrieve. Use this parameter as a pagination
859
+ # mechanism along with the max-results parameter.
860
+ # @param [String] fields
861
+ # Selector specifying which fields to include in a partial response.
862
+ # @param [String] quota_user
863
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
864
+ # characters.
865
+ # @param [String] user_ip
866
+ # Deprecated. Please use quotaUser instead.
867
+ # @param [Google::Apis::RequestOptions] options
868
+ # Request-specific options
869
+ #
870
+ # @yield [result, err] Result & error if block supplied
871
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetrics] parsed result object
872
+ # @yieldparam err [StandardError] error object if request failed
873
+ #
874
+ # @return [Google::Apis::AnalyticsV3::CustomMetrics]
875
+ #
876
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
877
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
878
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
879
+ def list_custom_metrics(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
880
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics', options)
881
+ command.response_representation = Google::Apis::AnalyticsV3::CustomMetrics::Representation
882
+ command.response_class = Google::Apis::AnalyticsV3::CustomMetrics
883
+ command.params['accountId'] = account_id unless account_id.nil?
884
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
885
+ command.query['max-results'] = max_results unless max_results.nil?
886
+ command.query['start-index'] = start_index unless start_index.nil?
887
+ command.query['fields'] = fields unless fields.nil?
888
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
889
+ command.query['userIp'] = user_ip unless user_ip.nil?
890
+ execute_or_queue_command(command, &block)
891
+ end
892
+
893
+ # Updates an existing custom metric. This method supports patch semantics.
894
+ # @param [String] account_id
895
+ # Account ID for the custom metric to update.
896
+ # @param [String] web_property_id
897
+ # Web property ID for the custom metric to update.
898
+ # @param [String] custom_metric_id
899
+ # Custom metric ID for the custom metric to update.
900
+ # @param [Google::Apis::AnalyticsV3::CustomMetric] custom_metric_object
901
+ # @param [Boolean] ignore_custom_data_source_links
902
+ # Force the update and ignore any warnings related to the custom metric being
903
+ # linked to a custom data source / data set.
904
+ # @param [String] fields
905
+ # Selector specifying which fields to include in a partial response.
906
+ # @param [String] quota_user
907
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
908
+ # characters.
909
+ # @param [String] user_ip
910
+ # Deprecated. Please use quotaUser instead.
911
+ # @param [Google::Apis::RequestOptions] options
912
+ # Request-specific options
913
+ #
914
+ # @yield [result, err] Result & error if block supplied
915
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetric] parsed result object
916
+ # @yieldparam err [StandardError] error object if request failed
917
+ #
918
+ # @return [Google::Apis::AnalyticsV3::CustomMetric]
919
+ #
920
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
921
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
922
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
923
+ def patch_custom_metric(account_id, web_property_id, custom_metric_id, custom_metric_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
924
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options)
925
+ command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
926
+ command.request_object = custom_metric_object
927
+ command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
928
+ command.response_class = Google::Apis::AnalyticsV3::CustomMetric
929
+ command.params['accountId'] = account_id unless account_id.nil?
930
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
931
+ command.params['customMetricId'] = custom_metric_id unless custom_metric_id.nil?
932
+ command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
933
+ command.query['fields'] = fields unless fields.nil?
934
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
935
+ command.query['userIp'] = user_ip unless user_ip.nil?
936
+ execute_or_queue_command(command, &block)
937
+ end
938
+
939
+ # Updates an existing custom metric.
940
+ # @param [String] account_id
941
+ # Account ID for the custom metric to update.
942
+ # @param [String] web_property_id
943
+ # Web property ID for the custom metric to update.
944
+ # @param [String] custom_metric_id
945
+ # Custom metric ID for the custom metric to update.
946
+ # @param [Google::Apis::AnalyticsV3::CustomMetric] custom_metric_object
947
+ # @param [Boolean] ignore_custom_data_source_links
948
+ # Force the update and ignore any warnings related to the custom metric being
949
+ # linked to a custom data source / data set.
950
+ # @param [String] fields
951
+ # Selector specifying which fields to include in a partial response.
952
+ # @param [String] quota_user
953
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
954
+ # characters.
955
+ # @param [String] user_ip
956
+ # Deprecated. Please use quotaUser instead.
957
+ # @param [Google::Apis::RequestOptions] options
958
+ # Request-specific options
959
+ #
960
+ # @yield [result, err] Result & error if block supplied
961
+ # @yieldparam result [Google::Apis::AnalyticsV3::CustomMetric] parsed result object
962
+ # @yieldparam err [StandardError] error object if request failed
963
+ #
964
+ # @return [Google::Apis::AnalyticsV3::CustomMetric]
965
+ #
966
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
967
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
968
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
969
+ def update_custom_metric(account_id, web_property_id, custom_metric_id, custom_metric_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
970
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options)
971
+ command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
972
+ command.request_object = custom_metric_object
973
+ command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
974
+ command.response_class = Google::Apis::AnalyticsV3::CustomMetric
975
+ command.params['accountId'] = account_id unless account_id.nil?
976
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
977
+ command.params['customMetricId'] = custom_metric_id unless custom_metric_id.nil?
978
+ command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
979
+ command.query['fields'] = fields unless fields.nil?
980
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
981
+ command.query['userIp'] = user_ip unless user_ip.nil?
982
+ execute_or_queue_command(command, &block)
983
+ end
984
+
985
+ # Delete an experiment.
986
+ # @param [String] account_id
987
+ # Account ID to which the experiment belongs
988
+ # @param [String] web_property_id
989
+ # Web property ID to which the experiment belongs
990
+ # @param [String] profile_id
991
+ # View (Profile) ID to which the experiment belongs
992
+ # @param [String] experiment_id
993
+ # ID of the experiment to delete
994
+ # @param [String] fields
995
+ # Selector specifying which fields to include in a partial response.
996
+ # @param [String] quota_user
997
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
998
+ # characters.
999
+ # @param [String] user_ip
1000
+ # Deprecated. Please use quotaUser instead.
1001
+ # @param [Google::Apis::RequestOptions] options
1002
+ # Request-specific options
1003
+ #
1004
+ # @yield [result, err] Result & error if block supplied
1005
+ # @yieldparam result [NilClass] No result returned for this method
1006
+ # @yieldparam err [StandardError] error object if request failed
1007
+ #
1008
+ # @return [void]
1009
+ #
1010
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1011
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1012
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1013
+ def delete_experiment(account_id, web_property_id, profile_id, experiment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1014
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
1015
+ command.params['accountId'] = account_id unless account_id.nil?
1016
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1017
+ command.params['profileId'] = profile_id unless profile_id.nil?
1018
+ command.params['experimentId'] = experiment_id unless experiment_id.nil?
1019
+ command.query['fields'] = fields unless fields.nil?
1020
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1021
+ command.query['userIp'] = user_ip unless user_ip.nil?
1022
+ execute_or_queue_command(command, &block)
1023
+ end
1024
+
1025
+ # Returns an experiment to which the user has access.
1026
+ # @param [String] account_id
1027
+ # Account ID to retrieve the experiment for.
1028
+ # @param [String] web_property_id
1029
+ # Web property ID to retrieve the experiment for.
1030
+ # @param [String] profile_id
1031
+ # View (Profile) ID to retrieve the experiment for.
1032
+ # @param [String] experiment_id
1033
+ # Experiment ID to retrieve the experiment for.
1034
+ # @param [String] fields
1035
+ # Selector specifying which fields to include in a partial response.
1036
+ # @param [String] quota_user
1037
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1038
+ # characters.
1039
+ # @param [String] user_ip
1040
+ # Deprecated. Please use quotaUser instead.
1041
+ # @param [Google::Apis::RequestOptions] options
1042
+ # Request-specific options
1043
+ #
1044
+ # @yield [result, err] Result & error if block supplied
1045
+ # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object
1046
+ # @yieldparam err [StandardError] error object if request failed
1047
+ #
1048
+ # @return [Google::Apis::AnalyticsV3::Experiment]
1049
+ #
1050
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1051
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1052
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1053
+ def get_experiment(account_id, web_property_id, profile_id, experiment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1054
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
1055
+ command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1056
+ command.response_class = Google::Apis::AnalyticsV3::Experiment
1057
+ command.params['accountId'] = account_id unless account_id.nil?
1058
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1059
+ command.params['profileId'] = profile_id unless profile_id.nil?
1060
+ command.params['experimentId'] = experiment_id unless experiment_id.nil?
1061
+ command.query['fields'] = fields unless fields.nil?
1062
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1063
+ command.query['userIp'] = user_ip unless user_ip.nil?
1064
+ execute_or_queue_command(command, &block)
1065
+ end
1066
+
1067
+ # Create a new experiment.
1068
+ # @param [String] account_id
1069
+ # Account ID to create the experiment for.
1070
+ # @param [String] web_property_id
1071
+ # Web property ID to create the experiment for.
1072
+ # @param [String] profile_id
1073
+ # View (Profile) ID to create the experiment for.
1074
+ # @param [Google::Apis::AnalyticsV3::Experiment] experiment_object
1075
+ # @param [String] fields
1076
+ # Selector specifying which fields to include in a partial response.
1077
+ # @param [String] quota_user
1078
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1079
+ # characters.
1080
+ # @param [String] user_ip
1081
+ # Deprecated. Please use quotaUser instead.
1082
+ # @param [Google::Apis::RequestOptions] options
1083
+ # Request-specific options
1084
+ #
1085
+ # @yield [result, err] Result & error if block supplied
1086
+ # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object
1087
+ # @yieldparam err [StandardError] error object if request failed
1088
+ #
1089
+ # @return [Google::Apis::AnalyticsV3::Experiment]
1090
+ #
1091
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1092
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1093
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1094
+ def insert_experiment(account_id, web_property_id, profile_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1095
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments', options)
1096
+ command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1097
+ command.request_object = experiment_object
1098
+ command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1099
+ command.response_class = Google::Apis::AnalyticsV3::Experiment
1100
+ command.params['accountId'] = account_id unless account_id.nil?
1101
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1102
+ command.params['profileId'] = profile_id unless profile_id.nil?
1103
+ command.query['fields'] = fields unless fields.nil?
1104
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1105
+ command.query['userIp'] = user_ip unless user_ip.nil?
1106
+ execute_or_queue_command(command, &block)
1107
+ end
1108
+
1109
+ # Lists experiments to which the user has access.
1110
+ # @param [String] account_id
1111
+ # Account ID to retrieve experiments for.
1112
+ # @param [String] web_property_id
1113
+ # Web property ID to retrieve experiments for.
1114
+ # @param [String] profile_id
1115
+ # View (Profile) ID to retrieve experiments for.
1116
+ # @param [Fixnum] max_results
1117
+ # The maximum number of experiments to include in this response.
1118
+ # @param [Fixnum] start_index
1119
+ # An index of the first experiment to retrieve. Use this parameter as a
1120
+ # pagination mechanism along with the max-results parameter.
1121
+ # @param [String] fields
1122
+ # Selector specifying which fields to include in a partial response.
1123
+ # @param [String] quota_user
1124
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1125
+ # characters.
1126
+ # @param [String] user_ip
1127
+ # Deprecated. Please use quotaUser instead.
1128
+ # @param [Google::Apis::RequestOptions] options
1129
+ # Request-specific options
1130
+ #
1131
+ # @yield [result, err] Result & error if block supplied
1132
+ # @yieldparam result [Google::Apis::AnalyticsV3::Experiments] parsed result object
1133
+ # @yieldparam err [StandardError] error object if request failed
1134
+ #
1135
+ # @return [Google::Apis::AnalyticsV3::Experiments]
1136
+ #
1137
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1138
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1139
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1140
+ def list_experiments(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1141
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments', options)
1142
+ command.response_representation = Google::Apis::AnalyticsV3::Experiments::Representation
1143
+ command.response_class = Google::Apis::AnalyticsV3::Experiments
1144
+ command.params['accountId'] = account_id unless account_id.nil?
1145
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1146
+ command.params['profileId'] = profile_id unless profile_id.nil?
1147
+ command.query['max-results'] = max_results unless max_results.nil?
1148
+ command.query['start-index'] = start_index unless start_index.nil?
1149
+ command.query['fields'] = fields unless fields.nil?
1150
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1151
+ command.query['userIp'] = user_ip unless user_ip.nil?
1152
+ execute_or_queue_command(command, &block)
1153
+ end
1154
+
1155
+ # Update an existing experiment. This method supports patch semantics.
1156
+ # @param [String] account_id
1157
+ # Account ID of the experiment to update.
1158
+ # @param [String] web_property_id
1159
+ # Web property ID of the experiment to update.
1160
+ # @param [String] profile_id
1161
+ # View (Profile) ID of the experiment to update.
1162
+ # @param [String] experiment_id
1163
+ # Experiment ID of the experiment to update.
1164
+ # @param [Google::Apis::AnalyticsV3::Experiment] experiment_object
1165
+ # @param [String] fields
1166
+ # Selector specifying which fields to include in a partial response.
1167
+ # @param [String] quota_user
1168
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1169
+ # characters.
1170
+ # @param [String] user_ip
1171
+ # Deprecated. Please use quotaUser instead.
1172
+ # @param [Google::Apis::RequestOptions] options
1173
+ # Request-specific options
1174
+ #
1175
+ # @yield [result, err] Result & error if block supplied
1176
+ # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object
1177
+ # @yieldparam err [StandardError] error object if request failed
1178
+ #
1179
+ # @return [Google::Apis::AnalyticsV3::Experiment]
1180
+ #
1181
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1182
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1183
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1184
+ def patch_experiment(account_id, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1185
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
1186
+ command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1187
+ command.request_object = experiment_object
1188
+ command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1189
+ command.response_class = Google::Apis::AnalyticsV3::Experiment
1190
+ command.params['accountId'] = account_id unless account_id.nil?
1191
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1192
+ command.params['profileId'] = profile_id unless profile_id.nil?
1193
+ command.params['experimentId'] = experiment_id unless experiment_id.nil?
1194
+ command.query['fields'] = fields unless fields.nil?
1195
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1196
+ command.query['userIp'] = user_ip unless user_ip.nil?
1197
+ execute_or_queue_command(command, &block)
1198
+ end
1199
+
1200
+ # Update an existing experiment.
1201
+ # @param [String] account_id
1202
+ # Account ID of the experiment to update.
1203
+ # @param [String] web_property_id
1204
+ # Web property ID of the experiment to update.
1205
+ # @param [String] profile_id
1206
+ # View (Profile) ID of the experiment to update.
1207
+ # @param [String] experiment_id
1208
+ # Experiment ID of the experiment to update.
1209
+ # @param [Google::Apis::AnalyticsV3::Experiment] experiment_object
1210
+ # @param [String] fields
1211
+ # Selector specifying which fields to include in a partial response.
1212
+ # @param [String] quota_user
1213
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1214
+ # characters.
1215
+ # @param [String] user_ip
1216
+ # Deprecated. Please use quotaUser instead.
1217
+ # @param [Google::Apis::RequestOptions] options
1218
+ # Request-specific options
1219
+ #
1220
+ # @yield [result, err] Result & error if block supplied
1221
+ # @yieldparam result [Google::Apis::AnalyticsV3::Experiment] parsed result object
1222
+ # @yieldparam err [StandardError] error object if request failed
1223
+ #
1224
+ # @return [Google::Apis::AnalyticsV3::Experiment]
1225
+ #
1226
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1227
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1228
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1229
+ def update_experiment(account_id, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1230
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
1231
+ command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1232
+ command.request_object = experiment_object
1233
+ command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
1234
+ command.response_class = Google::Apis::AnalyticsV3::Experiment
1235
+ command.params['accountId'] = account_id unless account_id.nil?
1236
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1237
+ command.params['profileId'] = profile_id unless profile_id.nil?
1238
+ command.params['experimentId'] = experiment_id unless experiment_id.nil?
1239
+ command.query['fields'] = fields unless fields.nil?
1240
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1241
+ command.query['userIp'] = user_ip unless user_ip.nil?
1242
+ execute_or_queue_command(command, &block)
1243
+ end
1244
+
1245
+ # Delete a filter.
1246
+ # @param [String] account_id
1247
+ # Account ID to delete the filter for.
1248
+ # @param [String] filter_id
1249
+ # ID of the filter to be deleted.
1250
+ # @param [String] fields
1251
+ # Selector specifying which fields to include in a partial response.
1252
+ # @param [String] quota_user
1253
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1254
+ # characters.
1255
+ # @param [String] user_ip
1256
+ # Deprecated. Please use quotaUser instead.
1257
+ # @param [Google::Apis::RequestOptions] options
1258
+ # Request-specific options
1259
+ #
1260
+ # @yield [result, err] Result & error if block supplied
1261
+ # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object
1262
+ # @yieldparam err [StandardError] error object if request failed
1263
+ #
1264
+ # @return [Google::Apis::AnalyticsV3::Filter]
1265
+ #
1266
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1267
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1268
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1269
+ def delete_filter(account_id, filter_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1270
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/filters/{filterId}', options)
1271
+ command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
1272
+ command.response_class = Google::Apis::AnalyticsV3::Filter
1273
+ command.params['accountId'] = account_id unless account_id.nil?
1274
+ command.params['filterId'] = filter_id unless filter_id.nil?
1275
+ command.query['fields'] = fields unless fields.nil?
1276
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1277
+ command.query['userIp'] = user_ip unless user_ip.nil?
1278
+ execute_or_queue_command(command, &block)
1279
+ end
1280
+
1281
+ # Returns filters to which the user has access.
1282
+ # @param [String] account_id
1283
+ # Account ID to retrieve filters for.
1284
+ # @param [String] filter_id
1285
+ # Filter ID to retrieve filters for.
1286
+ # @param [String] fields
1287
+ # Selector specifying which fields to include in a partial response.
1288
+ # @param [String] quota_user
1289
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1290
+ # characters.
1291
+ # @param [String] user_ip
1292
+ # Deprecated. Please use quotaUser instead.
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::AnalyticsV3::Filter] parsed result object
1298
+ # @yieldparam err [StandardError] error object if request failed
1299
+ #
1300
+ # @return [Google::Apis::AnalyticsV3::Filter]
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 get_filter(account_id, filter_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1306
+ command = make_simple_command(:get, 'management/accounts/{accountId}/filters/{filterId}', options)
1307
+ command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
1308
+ command.response_class = Google::Apis::AnalyticsV3::Filter
1309
+ command.params['accountId'] = account_id unless account_id.nil?
1310
+ command.params['filterId'] = filter_id unless filter_id.nil?
1311
+ command.query['fields'] = fields unless fields.nil?
1312
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1313
+ command.query['userIp'] = user_ip unless user_ip.nil?
1314
+ execute_or_queue_command(command, &block)
1315
+ end
1316
+
1317
+ # Create a new filter.
1318
+ # @param [String] account_id
1319
+ # Account ID to create filter for.
1320
+ # @param [Google::Apis::AnalyticsV3::Filter] filter_object
1321
+ # @param [String] fields
1322
+ # Selector specifying which fields to include in a partial response.
1323
+ # @param [String] quota_user
1324
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1325
+ # characters.
1326
+ # @param [String] user_ip
1327
+ # Deprecated. Please use quotaUser instead.
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::AnalyticsV3::Filter] parsed result object
1333
+ # @yieldparam err [StandardError] error object if request failed
1334
+ #
1335
+ # @return [Google::Apis::AnalyticsV3::Filter]
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 insert_filter(account_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1341
+ command = make_simple_command(:post, 'management/accounts/{accountId}/filters', options)
1342
+ command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation
1343
+ command.request_object = filter_object
1344
+ command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
1345
+ command.response_class = Google::Apis::AnalyticsV3::Filter
1346
+ command.params['accountId'] = account_id unless account_id.nil?
1347
+ command.query['fields'] = fields unless fields.nil?
1348
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1349
+ command.query['userIp'] = user_ip unless user_ip.nil?
1350
+ execute_or_queue_command(command, &block)
1351
+ end
1352
+
1353
+ # Lists all filters for an account
1354
+ # @param [String] account_id
1355
+ # Account ID to retrieve filters for.
1356
+ # @param [Fixnum] max_results
1357
+ # The maximum number of filters to include in this response.
1358
+ # @param [Fixnum] start_index
1359
+ # An index of the first entity to retrieve. Use this parameter as a pagination
1360
+ # mechanism along with the max-results parameter.
1361
+ # @param [String] fields
1362
+ # Selector specifying which fields to include in a partial response.
1363
+ # @param [String] quota_user
1364
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1365
+ # characters.
1366
+ # @param [String] user_ip
1367
+ # Deprecated. Please use quotaUser instead.
1368
+ # @param [Google::Apis::RequestOptions] options
1369
+ # Request-specific options
1370
+ #
1371
+ # @yield [result, err] Result & error if block supplied
1372
+ # @yieldparam result [Google::Apis::AnalyticsV3::Filters] parsed result object
1373
+ # @yieldparam err [StandardError] error object if request failed
1374
+ #
1375
+ # @return [Google::Apis::AnalyticsV3::Filters]
1376
+ #
1377
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1378
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1379
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1380
+ def list_filters(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1381
+ command = make_simple_command(:get, 'management/accounts/{accountId}/filters', options)
1382
+ command.response_representation = Google::Apis::AnalyticsV3::Filters::Representation
1383
+ command.response_class = Google::Apis::AnalyticsV3::Filters
1384
+ command.params['accountId'] = account_id unless account_id.nil?
1385
+ command.query['max-results'] = max_results unless max_results.nil?
1386
+ command.query['start-index'] = start_index unless start_index.nil?
1387
+ command.query['fields'] = fields unless fields.nil?
1388
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1389
+ command.query['userIp'] = user_ip unless user_ip.nil?
1390
+ execute_or_queue_command(command, &block)
1391
+ end
1392
+
1393
+ # Updates an existing filter. This method supports patch semantics.
1394
+ # @param [String] account_id
1395
+ # Account ID to which the filter belongs.
1396
+ # @param [String] filter_id
1397
+ # ID of the filter to be updated.
1398
+ # @param [Google::Apis::AnalyticsV3::Filter] filter_object
1399
+ # @param [String] fields
1400
+ # Selector specifying which fields to include in a partial response.
1401
+ # @param [String] quota_user
1402
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1403
+ # characters.
1404
+ # @param [String] user_ip
1405
+ # Deprecated. Please use quotaUser instead.
1406
+ # @param [Google::Apis::RequestOptions] options
1407
+ # Request-specific options
1408
+ #
1409
+ # @yield [result, err] Result & error if block supplied
1410
+ # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object
1411
+ # @yieldparam err [StandardError] error object if request failed
1412
+ #
1413
+ # @return [Google::Apis::AnalyticsV3::Filter]
1414
+ #
1415
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1416
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1417
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1418
+ def patch_filter(account_id, filter_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1419
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/filters/{filterId}', options)
1420
+ command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation
1421
+ command.request_object = filter_object
1422
+ command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
1423
+ command.response_class = Google::Apis::AnalyticsV3::Filter
1424
+ command.params['accountId'] = account_id unless account_id.nil?
1425
+ command.params['filterId'] = filter_id unless filter_id.nil?
1426
+ command.query['fields'] = fields unless fields.nil?
1427
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1428
+ command.query['userIp'] = user_ip unless user_ip.nil?
1429
+ execute_or_queue_command(command, &block)
1430
+ end
1431
+
1432
+ # Updates an existing filter.
1433
+ # @param [String] account_id
1434
+ # Account ID to which the filter belongs.
1435
+ # @param [String] filter_id
1436
+ # ID of the filter to be updated.
1437
+ # @param [Google::Apis::AnalyticsV3::Filter] filter_object
1438
+ # @param [String] fields
1439
+ # Selector specifying which fields to include in a partial response.
1440
+ # @param [String] quota_user
1441
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1442
+ # characters.
1443
+ # @param [String] user_ip
1444
+ # Deprecated. Please use quotaUser instead.
1445
+ # @param [Google::Apis::RequestOptions] options
1446
+ # Request-specific options
1447
+ #
1448
+ # @yield [result, err] Result & error if block supplied
1449
+ # @yieldparam result [Google::Apis::AnalyticsV3::Filter] parsed result object
1450
+ # @yieldparam err [StandardError] error object if request failed
1451
+ #
1452
+ # @return [Google::Apis::AnalyticsV3::Filter]
1453
+ #
1454
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1455
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1456
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1457
+ def update_filter(account_id, filter_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1458
+ command = make_simple_command(:put, 'management/accounts/{accountId}/filters/{filterId}', options)
1459
+ command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation
1460
+ command.request_object = filter_object
1461
+ command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
1462
+ command.response_class = Google::Apis::AnalyticsV3::Filter
1463
+ command.params['accountId'] = account_id unless account_id.nil?
1464
+ command.params['filterId'] = filter_id unless filter_id.nil?
1465
+ command.query['fields'] = fields unless fields.nil?
1466
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1467
+ command.query['userIp'] = user_ip unless user_ip.nil?
1468
+ execute_or_queue_command(command, &block)
1469
+ end
1470
+
1471
+ # Gets a goal to which the user has access.
1472
+ # @param [String] account_id
1473
+ # Account ID to retrieve the goal for.
1474
+ # @param [String] web_property_id
1475
+ # Web property ID to retrieve the goal for.
1476
+ # @param [String] profile_id
1477
+ # View (Profile) ID to retrieve the goal for.
1478
+ # @param [String] goal_id
1479
+ # Goal ID to retrieve the goal for.
1480
+ # @param [String] fields
1481
+ # Selector specifying which fields to include in a partial response.
1482
+ # @param [String] quota_user
1483
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1484
+ # characters.
1485
+ # @param [String] user_ip
1486
+ # Deprecated. Please use quotaUser instead.
1487
+ # @param [Google::Apis::RequestOptions] options
1488
+ # Request-specific options
1489
+ #
1490
+ # @yield [result, err] Result & error if block supplied
1491
+ # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object
1492
+ # @yieldparam err [StandardError] error object if request failed
1493
+ #
1494
+ # @return [Google::Apis::AnalyticsV3::Goal]
1495
+ #
1496
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1497
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1498
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1499
+ def get_goal(account_id, web_property_id, profile_id, goal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1500
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options)
1501
+ command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
1502
+ command.response_class = Google::Apis::AnalyticsV3::Goal
1503
+ command.params['accountId'] = account_id unless account_id.nil?
1504
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1505
+ command.params['profileId'] = profile_id unless profile_id.nil?
1506
+ command.params['goalId'] = goal_id unless goal_id.nil?
1507
+ command.query['fields'] = fields unless fields.nil?
1508
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1509
+ command.query['userIp'] = user_ip unless user_ip.nil?
1510
+ execute_or_queue_command(command, &block)
1511
+ end
1512
+
1513
+ # Create a new goal.
1514
+ # @param [String] account_id
1515
+ # Account ID to create the goal for.
1516
+ # @param [String] web_property_id
1517
+ # Web property ID to create the goal for.
1518
+ # @param [String] profile_id
1519
+ # View (Profile) ID to create the goal for.
1520
+ # @param [Google::Apis::AnalyticsV3::Goal] goal_object
1521
+ # @param [String] fields
1522
+ # Selector specifying which fields to include in a partial response.
1523
+ # @param [String] quota_user
1524
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1525
+ # characters.
1526
+ # @param [String] user_ip
1527
+ # Deprecated. Please use quotaUser instead.
1528
+ # @param [Google::Apis::RequestOptions] options
1529
+ # Request-specific options
1530
+ #
1531
+ # @yield [result, err] Result & error if block supplied
1532
+ # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object
1533
+ # @yieldparam err [StandardError] error object if request failed
1534
+ #
1535
+ # @return [Google::Apis::AnalyticsV3::Goal]
1536
+ #
1537
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1538
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1539
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1540
+ def insert_goal(account_id, web_property_id, profile_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1541
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals', options)
1542
+ command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation
1543
+ command.request_object = goal_object
1544
+ command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
1545
+ command.response_class = Google::Apis::AnalyticsV3::Goal
1546
+ command.params['accountId'] = account_id unless account_id.nil?
1547
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1548
+ command.params['profileId'] = profile_id unless profile_id.nil?
1549
+ command.query['fields'] = fields unless fields.nil?
1550
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1551
+ command.query['userIp'] = user_ip unless user_ip.nil?
1552
+ execute_or_queue_command(command, &block)
1553
+ end
1554
+
1555
+ # Lists goals to which the user has access.
1556
+ # @param [String] account_id
1557
+ # Account ID to retrieve goals for. Can either be a specific account ID or '~all'
1558
+ # , which refers to all the accounts that user has access to.
1559
+ # @param [String] web_property_id
1560
+ # Web property ID to retrieve goals for. Can either be a specific web property
1561
+ # ID or '~all', which refers to all the web properties that user has access to.
1562
+ # @param [String] profile_id
1563
+ # View (Profile) ID to retrieve goals for. Can either be a specific view (
1564
+ # profile) ID or '~all', which refers to all the views (profiles) that user has
1565
+ # access to.
1566
+ # @param [Fixnum] max_results
1567
+ # The maximum number of goals to include in this response.
1568
+ # @param [Fixnum] start_index
1569
+ # An index of the first goal to retrieve. Use this parameter as a pagination
1570
+ # mechanism along with the max-results parameter.
1571
+ # @param [String] fields
1572
+ # Selector specifying which fields to include in a partial response.
1573
+ # @param [String] quota_user
1574
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1575
+ # characters.
1576
+ # @param [String] user_ip
1577
+ # Deprecated. Please use quotaUser instead.
1578
+ # @param [Google::Apis::RequestOptions] options
1579
+ # Request-specific options
1580
+ #
1581
+ # @yield [result, err] Result & error if block supplied
1582
+ # @yieldparam result [Google::Apis::AnalyticsV3::Goals] parsed result object
1583
+ # @yieldparam err [StandardError] error object if request failed
1584
+ #
1585
+ # @return [Google::Apis::AnalyticsV3::Goals]
1586
+ #
1587
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1588
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1589
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1590
+ def list_goals(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1591
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals', options)
1592
+ command.response_representation = Google::Apis::AnalyticsV3::Goals::Representation
1593
+ command.response_class = Google::Apis::AnalyticsV3::Goals
1594
+ command.params['accountId'] = account_id unless account_id.nil?
1595
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1596
+ command.params['profileId'] = profile_id unless profile_id.nil?
1597
+ command.query['max-results'] = max_results unless max_results.nil?
1598
+ command.query['start-index'] = start_index unless start_index.nil?
1599
+ command.query['fields'] = fields unless fields.nil?
1600
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1601
+ command.query['userIp'] = user_ip unless user_ip.nil?
1602
+ execute_or_queue_command(command, &block)
1603
+ end
1604
+
1605
+ # Updates an existing goal. This method supports patch semantics.
1606
+ # @param [String] account_id
1607
+ # Account ID to update the goal.
1608
+ # @param [String] web_property_id
1609
+ # Web property ID to update the goal.
1610
+ # @param [String] profile_id
1611
+ # View (Profile) ID to update the goal.
1612
+ # @param [String] goal_id
1613
+ # Index of the goal to be updated.
1614
+ # @param [Google::Apis::AnalyticsV3::Goal] goal_object
1615
+ # @param [String] fields
1616
+ # Selector specifying which fields to include in a partial response.
1617
+ # @param [String] quota_user
1618
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1619
+ # characters.
1620
+ # @param [String] user_ip
1621
+ # Deprecated. Please use quotaUser instead.
1622
+ # @param [Google::Apis::RequestOptions] options
1623
+ # Request-specific options
1624
+ #
1625
+ # @yield [result, err] Result & error if block supplied
1626
+ # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object
1627
+ # @yieldparam err [StandardError] error object if request failed
1628
+ #
1629
+ # @return [Google::Apis::AnalyticsV3::Goal]
1630
+ #
1631
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1632
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1633
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1634
+ def patch_goal(account_id, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1635
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options)
1636
+ command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation
1637
+ command.request_object = goal_object
1638
+ command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
1639
+ command.response_class = Google::Apis::AnalyticsV3::Goal
1640
+ command.params['accountId'] = account_id unless account_id.nil?
1641
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1642
+ command.params['profileId'] = profile_id unless profile_id.nil?
1643
+ command.params['goalId'] = goal_id unless goal_id.nil?
1644
+ command.query['fields'] = fields unless fields.nil?
1645
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1646
+ command.query['userIp'] = user_ip unless user_ip.nil?
1647
+ execute_or_queue_command(command, &block)
1648
+ end
1649
+
1650
+ # Updates an existing goal.
1651
+ # @param [String] account_id
1652
+ # Account ID to update the goal.
1653
+ # @param [String] web_property_id
1654
+ # Web property ID to update the goal.
1655
+ # @param [String] profile_id
1656
+ # View (Profile) ID to update the goal.
1657
+ # @param [String] goal_id
1658
+ # Index of the goal to be updated.
1659
+ # @param [Google::Apis::AnalyticsV3::Goal] goal_object
1660
+ # @param [String] fields
1661
+ # Selector specifying which fields to include in a partial response.
1662
+ # @param [String] quota_user
1663
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1664
+ # characters.
1665
+ # @param [String] user_ip
1666
+ # Deprecated. Please use quotaUser instead.
1667
+ # @param [Google::Apis::RequestOptions] options
1668
+ # Request-specific options
1669
+ #
1670
+ # @yield [result, err] Result & error if block supplied
1671
+ # @yieldparam result [Google::Apis::AnalyticsV3::Goal] parsed result object
1672
+ # @yieldparam err [StandardError] error object if request failed
1673
+ #
1674
+ # @return [Google::Apis::AnalyticsV3::Goal]
1675
+ #
1676
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1677
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1678
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1679
+ def update_goal(account_id, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1680
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options)
1681
+ command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation
1682
+ command.request_object = goal_object
1683
+ command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
1684
+ command.response_class = Google::Apis::AnalyticsV3::Goal
1685
+ command.params['accountId'] = account_id unless account_id.nil?
1686
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1687
+ command.params['profileId'] = profile_id unless profile_id.nil?
1688
+ command.params['goalId'] = goal_id unless goal_id.nil?
1689
+ command.query['fields'] = fields unless fields.nil?
1690
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1691
+ command.query['userIp'] = user_ip unless user_ip.nil?
1692
+ execute_or_queue_command(command, &block)
1693
+ end
1694
+
1695
+ # Delete a profile filter link.
1696
+ # @param [String] account_id
1697
+ # Account ID to which the profile filter link belongs.
1698
+ # @param [String] web_property_id
1699
+ # Web property Id to which the profile filter link belongs.
1700
+ # @param [String] profile_id
1701
+ # Profile ID to which the filter link belongs.
1702
+ # @param [String] link_id
1703
+ # ID of the profile filter link to delete.
1704
+ # @param [String] fields
1705
+ # Selector specifying which fields to include in a partial response.
1706
+ # @param [String] quota_user
1707
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1708
+ # characters.
1709
+ # @param [String] user_ip
1710
+ # Deprecated. Please use quotaUser instead.
1711
+ # @param [Google::Apis::RequestOptions] options
1712
+ # Request-specific options
1713
+ #
1714
+ # @yield [result, err] Result & error if block supplied
1715
+ # @yieldparam result [NilClass] No result returned for this method
1716
+ # @yieldparam err [StandardError] error object if request failed
1717
+ #
1718
+ # @return [void]
1719
+ #
1720
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1721
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1722
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1723
+ def delete_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1724
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
1725
+ command.params['accountId'] = account_id unless account_id.nil?
1726
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1727
+ command.params['profileId'] = profile_id unless profile_id.nil?
1728
+ command.params['linkId'] = link_id unless link_id.nil?
1729
+ command.query['fields'] = fields unless fields.nil?
1730
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1731
+ command.query['userIp'] = user_ip unless user_ip.nil?
1732
+ execute_or_queue_command(command, &block)
1733
+ end
1734
+
1735
+ # Returns a single profile filter link.
1736
+ # @param [String] account_id
1737
+ # Account ID to retrieve profile filter link for.
1738
+ # @param [String] web_property_id
1739
+ # Web property Id to retrieve profile filter link for.
1740
+ # @param [String] profile_id
1741
+ # Profile ID to retrieve filter link for.
1742
+ # @param [String] link_id
1743
+ # ID of the profile filter link.
1744
+ # @param [String] fields
1745
+ # Selector specifying which fields to include in a partial response.
1746
+ # @param [String] quota_user
1747
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1748
+ # characters.
1749
+ # @param [String] user_ip
1750
+ # Deprecated. Please use quotaUser instead.
1751
+ # @param [Google::Apis::RequestOptions] options
1752
+ # Request-specific options
1753
+ #
1754
+ # @yield [result, err] Result & error if block supplied
1755
+ # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object
1756
+ # @yieldparam err [StandardError] error object if request failed
1757
+ #
1758
+ # @return [Google::Apis::AnalyticsV3::ProfileFilterLink]
1759
+ #
1760
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1761
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1762
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1763
+ def get_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1764
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
1765
+ command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1766
+ command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
1767
+ command.params['accountId'] = account_id unless account_id.nil?
1768
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1769
+ command.params['profileId'] = profile_id unless profile_id.nil?
1770
+ command.params['linkId'] = link_id unless link_id.nil?
1771
+ command.query['fields'] = fields unless fields.nil?
1772
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1773
+ command.query['userIp'] = user_ip unless user_ip.nil?
1774
+ execute_or_queue_command(command, &block)
1775
+ end
1776
+
1777
+ # Create a new profile filter link.
1778
+ # @param [String] account_id
1779
+ # Account ID to create profile filter link for.
1780
+ # @param [String] web_property_id
1781
+ # Web property Id to create profile filter link for.
1782
+ # @param [String] profile_id
1783
+ # Profile ID to create filter link for.
1784
+ # @param [Google::Apis::AnalyticsV3::ProfileFilterLink] profile_filter_link_object
1785
+ # @param [String] fields
1786
+ # Selector specifying which fields to include in a partial response.
1787
+ # @param [String] quota_user
1788
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1789
+ # characters.
1790
+ # @param [String] user_ip
1791
+ # Deprecated. Please use quotaUser instead.
1792
+ # @param [Google::Apis::RequestOptions] options
1793
+ # Request-specific options
1794
+ #
1795
+ # @yield [result, err] Result & error if block supplied
1796
+ # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object
1797
+ # @yieldparam err [StandardError] error object if request failed
1798
+ #
1799
+ # @return [Google::Apis::AnalyticsV3::ProfileFilterLink]
1800
+ #
1801
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1802
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1803
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1804
+ def insert_profile_filter_link(account_id, web_property_id, profile_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1805
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks', options)
1806
+ command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1807
+ command.request_object = profile_filter_link_object
1808
+ command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1809
+ command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
1810
+ command.params['accountId'] = account_id unless account_id.nil?
1811
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1812
+ command.params['profileId'] = profile_id unless profile_id.nil?
1813
+ command.query['fields'] = fields unless fields.nil?
1814
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1815
+ command.query['userIp'] = user_ip unless user_ip.nil?
1816
+ execute_or_queue_command(command, &block)
1817
+ end
1818
+
1819
+ # Lists all profile filter links for a profile.
1820
+ # @param [String] account_id
1821
+ # Account ID to retrieve profile filter links for.
1822
+ # @param [String] web_property_id
1823
+ # Web property Id for profile filter links for. Can either be a specific web
1824
+ # property ID or '~all', which refers to all the web properties that user has
1825
+ # access to.
1826
+ # @param [String] profile_id
1827
+ # Profile ID to retrieve filter links for. Can either be a specific profile ID
1828
+ # or '~all', which refers to all the profiles that user has access to.
1829
+ # @param [Fixnum] max_results
1830
+ # The maximum number of profile filter links to include in this response.
1831
+ # @param [Fixnum] start_index
1832
+ # An index of the first entity to retrieve. Use this parameter as a pagination
1833
+ # mechanism along with the max-results parameter.
1834
+ # @param [String] fields
1835
+ # Selector specifying which fields to include in a partial response.
1836
+ # @param [String] quota_user
1837
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1838
+ # characters.
1839
+ # @param [String] user_ip
1840
+ # Deprecated. Please use quotaUser instead.
1841
+ # @param [Google::Apis::RequestOptions] options
1842
+ # Request-specific options
1843
+ #
1844
+ # @yield [result, err] Result & error if block supplied
1845
+ # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLinks] parsed result object
1846
+ # @yieldparam err [StandardError] error object if request failed
1847
+ #
1848
+ # @return [Google::Apis::AnalyticsV3::ProfileFilterLinks]
1849
+ #
1850
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1851
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1852
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1853
+ def list_profile_filter_links(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1854
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks', options)
1855
+ command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLinks::Representation
1856
+ command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLinks
1857
+ command.params['accountId'] = account_id unless account_id.nil?
1858
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1859
+ command.params['profileId'] = profile_id unless profile_id.nil?
1860
+ command.query['max-results'] = max_results unless max_results.nil?
1861
+ command.query['start-index'] = start_index unless start_index.nil?
1862
+ command.query['fields'] = fields unless fields.nil?
1863
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1864
+ command.query['userIp'] = user_ip unless user_ip.nil?
1865
+ execute_or_queue_command(command, &block)
1866
+ end
1867
+
1868
+ # Update an existing profile filter link. This method supports patch semantics.
1869
+ # @param [String] account_id
1870
+ # Account ID to which profile filter link belongs.
1871
+ # @param [String] web_property_id
1872
+ # Web property Id to which profile filter link belongs
1873
+ # @param [String] profile_id
1874
+ # Profile ID to which filter link belongs
1875
+ # @param [String] link_id
1876
+ # ID of the profile filter link to be updated.
1877
+ # @param [Google::Apis::AnalyticsV3::ProfileFilterLink] profile_filter_link_object
1878
+ # @param [String] fields
1879
+ # Selector specifying which fields to include in a partial response.
1880
+ # @param [String] quota_user
1881
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1882
+ # characters.
1883
+ # @param [String] user_ip
1884
+ # Deprecated. Please use quotaUser instead.
1885
+ # @param [Google::Apis::RequestOptions] options
1886
+ # Request-specific options
1887
+ #
1888
+ # @yield [result, err] Result & error if block supplied
1889
+ # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object
1890
+ # @yieldparam err [StandardError] error object if request failed
1891
+ #
1892
+ # @return [Google::Apis::AnalyticsV3::ProfileFilterLink]
1893
+ #
1894
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1895
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1896
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1897
+ def patch_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1898
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
1899
+ command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1900
+ command.request_object = profile_filter_link_object
1901
+ command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1902
+ command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
1903
+ command.params['accountId'] = account_id unless account_id.nil?
1904
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1905
+ command.params['profileId'] = profile_id unless profile_id.nil?
1906
+ command.params['linkId'] = link_id unless link_id.nil?
1907
+ command.query['fields'] = fields unless fields.nil?
1908
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1909
+ command.query['userIp'] = user_ip unless user_ip.nil?
1910
+ execute_or_queue_command(command, &block)
1911
+ end
1912
+
1913
+ # Update an existing profile filter link.
1914
+ # @param [String] account_id
1915
+ # Account ID to which profile filter link belongs.
1916
+ # @param [String] web_property_id
1917
+ # Web property Id to which profile filter link belongs
1918
+ # @param [String] profile_id
1919
+ # Profile ID to which filter link belongs
1920
+ # @param [String] link_id
1921
+ # ID of the profile filter link to be updated.
1922
+ # @param [Google::Apis::AnalyticsV3::ProfileFilterLink] profile_filter_link_object
1923
+ # @param [String] fields
1924
+ # Selector specifying which fields to include in a partial response.
1925
+ # @param [String] quota_user
1926
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1927
+ # characters.
1928
+ # @param [String] user_ip
1929
+ # Deprecated. Please use quotaUser instead.
1930
+ # @param [Google::Apis::RequestOptions] options
1931
+ # Request-specific options
1932
+ #
1933
+ # @yield [result, err] Result & error if block supplied
1934
+ # @yieldparam result [Google::Apis::AnalyticsV3::ProfileFilterLink] parsed result object
1935
+ # @yieldparam err [StandardError] error object if request failed
1936
+ #
1937
+ # @return [Google::Apis::AnalyticsV3::ProfileFilterLink]
1938
+ #
1939
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1940
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1941
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1942
+ def update_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1943
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
1944
+ command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1945
+ command.request_object = profile_filter_link_object
1946
+ command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
1947
+ command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
1948
+ command.params['accountId'] = account_id unless account_id.nil?
1949
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1950
+ command.params['profileId'] = profile_id unless profile_id.nil?
1951
+ command.params['linkId'] = link_id unless link_id.nil?
1952
+ command.query['fields'] = fields unless fields.nil?
1953
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1954
+ command.query['userIp'] = user_ip unless user_ip.nil?
1955
+ execute_or_queue_command(command, &block)
1956
+ end
1957
+
1958
+ # Removes a user from the given view (profile).
1959
+ # @param [String] account_id
1960
+ # Account ID to delete the user link for.
1961
+ # @param [String] web_property_id
1962
+ # Web Property ID to delete the user link for.
1963
+ # @param [String] profile_id
1964
+ # View (Profile) ID to delete the user link for.
1965
+ # @param [String] link_id
1966
+ # Link ID to delete the user link for.
1967
+ # @param [String] fields
1968
+ # Selector specifying which fields to include in a partial response.
1969
+ # @param [String] quota_user
1970
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
1971
+ # characters.
1972
+ # @param [String] user_ip
1973
+ # Deprecated. Please use quotaUser instead.
1974
+ # @param [Google::Apis::RequestOptions] options
1975
+ # Request-specific options
1976
+ #
1977
+ # @yield [result, err] Result & error if block supplied
1978
+ # @yieldparam result [NilClass] No result returned for this method
1979
+ # @yieldparam err [StandardError] error object if request failed
1980
+ #
1981
+ # @return [void]
1982
+ #
1983
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1984
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1985
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1986
+ def delete_profile_user_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1987
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}', options)
1988
+ command.params['accountId'] = account_id unless account_id.nil?
1989
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
1990
+ command.params['profileId'] = profile_id unless profile_id.nil?
1991
+ command.params['linkId'] = link_id unless link_id.nil?
1992
+ command.query['fields'] = fields unless fields.nil?
1993
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1994
+ command.query['userIp'] = user_ip unless user_ip.nil?
1995
+ execute_or_queue_command(command, &block)
1996
+ end
1997
+
1998
+ # Adds a new user to the given view (profile).
1999
+ # @param [String] account_id
2000
+ # Account ID to create the user link for.
2001
+ # @param [String] web_property_id
2002
+ # Web Property ID to create the user link for.
2003
+ # @param [String] profile_id
2004
+ # View (Profile) ID to create the user link for.
2005
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
2006
+ # @param [String] fields
2007
+ # Selector specifying which fields to include in a partial response.
2008
+ # @param [String] quota_user
2009
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2010
+ # characters.
2011
+ # @param [String] user_ip
2012
+ # Deprecated. Please use quotaUser instead.
2013
+ # @param [Google::Apis::RequestOptions] options
2014
+ # Request-specific options
2015
+ #
2016
+ # @yield [result, err] Result & error if block supplied
2017
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
2018
+ # @yieldparam err [StandardError] error object if request failed
2019
+ #
2020
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
2021
+ #
2022
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2023
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2024
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2025
+ def insert_profile_user_link(account_id, web_property_id, profile_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2026
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks', options)
2027
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
2028
+ command.request_object = entity_user_link_object
2029
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
2030
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
2031
+ command.params['accountId'] = account_id unless account_id.nil?
2032
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2033
+ command.params['profileId'] = profile_id unless profile_id.nil?
2034
+ command.query['fields'] = fields unless fields.nil?
2035
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2036
+ command.query['userIp'] = user_ip unless user_ip.nil?
2037
+ execute_or_queue_command(command, &block)
2038
+ end
2039
+
2040
+ # Lists profile-user links for a given view (profile).
2041
+ # @param [String] account_id
2042
+ # Account ID which the given view (profile) belongs to.
2043
+ # @param [String] web_property_id
2044
+ # Web Property ID which the given view (profile) belongs to. Can either be a
2045
+ # specific web property ID or '~all', which refers to all the web properties
2046
+ # that user has access to.
2047
+ # @param [String] profile_id
2048
+ # View (Profile) ID to retrieve the profile-user links for. Can either be a
2049
+ # specific profile ID or '~all', which refers to all the profiles that user has
2050
+ # access to.
2051
+ # @param [Fixnum] max_results
2052
+ # The maximum number of profile-user links to include in this response.
2053
+ # @param [Fixnum] start_index
2054
+ # An index of the first profile-user link to retrieve. Use this parameter as a
2055
+ # pagination mechanism along with the max-results parameter.
2056
+ # @param [String] fields
2057
+ # Selector specifying which fields to include in a partial response.
2058
+ # @param [String] quota_user
2059
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2060
+ # characters.
2061
+ # @param [String] user_ip
2062
+ # Deprecated. Please use quotaUser instead.
2063
+ # @param [Google::Apis::RequestOptions] options
2064
+ # Request-specific options
2065
+ #
2066
+ # @yield [result, err] Result & error if block supplied
2067
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLinks] parsed result object
2068
+ # @yieldparam err [StandardError] error object if request failed
2069
+ #
2070
+ # @return [Google::Apis::AnalyticsV3::EntityUserLinks]
2071
+ #
2072
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2073
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2074
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2075
+ def list_profile_user_links(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2076
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks', options)
2077
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation
2078
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks
2079
+ command.params['accountId'] = account_id unless account_id.nil?
2080
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2081
+ command.params['profileId'] = profile_id unless profile_id.nil?
2082
+ command.query['max-results'] = max_results unless max_results.nil?
2083
+ command.query['start-index'] = start_index unless start_index.nil?
2084
+ command.query['fields'] = fields unless fields.nil?
2085
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2086
+ command.query['userIp'] = user_ip unless user_ip.nil?
2087
+ execute_or_queue_command(command, &block)
2088
+ end
2089
+
2090
+ # Updates permissions for an existing user on the given view (profile).
2091
+ # @param [String] account_id
2092
+ # Account ID to update the user link for.
2093
+ # @param [String] web_property_id
2094
+ # Web Property ID to update the user link for.
2095
+ # @param [String] profile_id
2096
+ # View (Profile ID) to update the user link for.
2097
+ # @param [String] link_id
2098
+ # Link ID to update the user link for.
2099
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
2100
+ # @param [String] fields
2101
+ # Selector specifying which fields to include in a partial response.
2102
+ # @param [String] quota_user
2103
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2104
+ # characters.
2105
+ # @param [String] user_ip
2106
+ # Deprecated. Please use quotaUser instead.
2107
+ # @param [Google::Apis::RequestOptions] options
2108
+ # Request-specific options
2109
+ #
2110
+ # @yield [result, err] Result & error if block supplied
2111
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
2112
+ # @yieldparam err [StandardError] error object if request failed
2113
+ #
2114
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
2115
+ #
2116
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2117
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2118
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2119
+ def update_profile_user_link(account_id, web_property_id, profile_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2120
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}', options)
2121
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
2122
+ command.request_object = entity_user_link_object
2123
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
2124
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
2125
+ command.params['accountId'] = account_id unless account_id.nil?
2126
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2127
+ command.params['profileId'] = profile_id unless profile_id.nil?
2128
+ command.params['linkId'] = link_id unless link_id.nil?
2129
+ command.query['fields'] = fields unless fields.nil?
2130
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2131
+ command.query['userIp'] = user_ip unless user_ip.nil?
2132
+ execute_or_queue_command(command, &block)
2133
+ end
2134
+
2135
+ # Deletes a view (profile).
2136
+ # @param [String] account_id
2137
+ # Account ID to delete the view (profile) for.
2138
+ # @param [String] web_property_id
2139
+ # Web property ID to delete the view (profile) for.
2140
+ # @param [String] profile_id
2141
+ # ID of the view (profile) to be deleted.
2142
+ # @param [String] fields
2143
+ # Selector specifying which fields to include in a partial response.
2144
+ # @param [String] quota_user
2145
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2146
+ # characters.
2147
+ # @param [String] user_ip
2148
+ # Deprecated. Please use quotaUser instead.
2149
+ # @param [Google::Apis::RequestOptions] options
2150
+ # Request-specific options
2151
+ #
2152
+ # @yield [result, err] Result & error if block supplied
2153
+ # @yieldparam result [NilClass] No result returned for this method
2154
+ # @yieldparam err [StandardError] error object if request failed
2155
+ #
2156
+ # @return [void]
2157
+ #
2158
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2159
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2160
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2161
+ def delete_profile(account_id, web_property_id, profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2162
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
2163
+ command.params['accountId'] = account_id unless account_id.nil?
2164
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2165
+ command.params['profileId'] = profile_id unless profile_id.nil?
2166
+ command.query['fields'] = fields unless fields.nil?
2167
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2168
+ command.query['userIp'] = user_ip unless user_ip.nil?
2169
+ execute_or_queue_command(command, &block)
2170
+ end
2171
+
2172
+ # Gets a view (profile) to which the user has access.
2173
+ # @param [String] account_id
2174
+ # Account ID to retrieve the view (profile) for.
2175
+ # @param [String] web_property_id
2176
+ # Web property ID to retrieve the view (profile) for.
2177
+ # @param [String] profile_id
2178
+ # View (Profile) ID to retrieve the view (profile) for.
2179
+ # @param [String] fields
2180
+ # Selector specifying which fields to include in a partial response.
2181
+ # @param [String] quota_user
2182
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2183
+ # characters.
2184
+ # @param [String] user_ip
2185
+ # Deprecated. Please use quotaUser instead.
2186
+ # @param [Google::Apis::RequestOptions] options
2187
+ # Request-specific options
2188
+ #
2189
+ # @yield [result, err] Result & error if block supplied
2190
+ # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object
2191
+ # @yieldparam err [StandardError] error object if request failed
2192
+ #
2193
+ # @return [Google::Apis::AnalyticsV3::Profile]
2194
+ #
2195
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2196
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2197
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2198
+ def get_profile(account_id, web_property_id, profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2199
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
2200
+ command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
2201
+ command.response_class = Google::Apis::AnalyticsV3::Profile
2202
+ command.params['accountId'] = account_id unless account_id.nil?
2203
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2204
+ command.params['profileId'] = profile_id unless profile_id.nil?
2205
+ command.query['fields'] = fields unless fields.nil?
2206
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2207
+ command.query['userIp'] = user_ip unless user_ip.nil?
2208
+ execute_or_queue_command(command, &block)
2209
+ end
2210
+
2211
+ # Create a new view (profile).
2212
+ # @param [String] account_id
2213
+ # Account ID to create the view (profile) for.
2214
+ # @param [String] web_property_id
2215
+ # Web property ID to create the view (profile) for.
2216
+ # @param [Google::Apis::AnalyticsV3::Profile] profile_object
2217
+ # @param [String] fields
2218
+ # Selector specifying which fields to include in a partial response.
2219
+ # @param [String] quota_user
2220
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2221
+ # characters.
2222
+ # @param [String] user_ip
2223
+ # Deprecated. Please use quotaUser instead.
2224
+ # @param [Google::Apis::RequestOptions] options
2225
+ # Request-specific options
2226
+ #
2227
+ # @yield [result, err] Result & error if block supplied
2228
+ # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object
2229
+ # @yieldparam err [StandardError] error object if request failed
2230
+ #
2231
+ # @return [Google::Apis::AnalyticsV3::Profile]
2232
+ #
2233
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2234
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2235
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2236
+ def insert_profile(account_id, web_property_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2237
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles', options)
2238
+ command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation
2239
+ command.request_object = profile_object
2240
+ command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
2241
+ command.response_class = Google::Apis::AnalyticsV3::Profile
2242
+ command.params['accountId'] = account_id unless account_id.nil?
2243
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2244
+ command.query['fields'] = fields unless fields.nil?
2245
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2246
+ command.query['userIp'] = user_ip unless user_ip.nil?
2247
+ execute_or_queue_command(command, &block)
2248
+ end
2249
+
2250
+ # Lists views (profiles) to which the user has access.
2251
+ # @param [String] account_id
2252
+ # Account ID for the view (profiles) to retrieve. Can either be a specific
2253
+ # account ID or '~all', which refers to all the accounts to which the user has
2254
+ # access.
2255
+ # @param [String] web_property_id
2256
+ # Web property ID for the views (profiles) to retrieve. Can either be a specific
2257
+ # web property ID or '~all', which refers to all the web properties to which the
2258
+ # user has access.
2259
+ # @param [Fixnum] max_results
2260
+ # The maximum number of views (profiles) to include in this response.
2261
+ # @param [Fixnum] start_index
2262
+ # An index of the first entity to retrieve. Use this parameter as a pagination
2263
+ # mechanism along with the max-results parameter.
2264
+ # @param [String] fields
2265
+ # Selector specifying which fields to include in a partial response.
2266
+ # @param [String] quota_user
2267
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2268
+ # characters.
2269
+ # @param [String] user_ip
2270
+ # Deprecated. Please use quotaUser instead.
2271
+ # @param [Google::Apis::RequestOptions] options
2272
+ # Request-specific options
2273
+ #
2274
+ # @yield [result, err] Result & error if block supplied
2275
+ # @yieldparam result [Google::Apis::AnalyticsV3::Profiles] parsed result object
2276
+ # @yieldparam err [StandardError] error object if request failed
2277
+ #
2278
+ # @return [Google::Apis::AnalyticsV3::Profiles]
2279
+ #
2280
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2281
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2282
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2283
+ def list_profiles(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2284
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles', options)
2285
+ command.response_representation = Google::Apis::AnalyticsV3::Profiles::Representation
2286
+ command.response_class = Google::Apis::AnalyticsV3::Profiles
2287
+ command.params['accountId'] = account_id unless account_id.nil?
2288
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2289
+ command.query['max-results'] = max_results unless max_results.nil?
2290
+ command.query['start-index'] = start_index unless start_index.nil?
2291
+ command.query['fields'] = fields unless fields.nil?
2292
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2293
+ command.query['userIp'] = user_ip unless user_ip.nil?
2294
+ execute_or_queue_command(command, &block)
2295
+ end
2296
+
2297
+ # Updates an existing view (profile). This method supports patch semantics.
2298
+ # @param [String] account_id
2299
+ # Account ID to which the view (profile) belongs
2300
+ # @param [String] web_property_id
2301
+ # Web property ID to which the view (profile) belongs
2302
+ # @param [String] profile_id
2303
+ # ID of the view (profile) to be updated.
2304
+ # @param [Google::Apis::AnalyticsV3::Profile] profile_object
2305
+ # @param [String] fields
2306
+ # Selector specifying which fields to include in a partial response.
2307
+ # @param [String] quota_user
2308
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2309
+ # characters.
2310
+ # @param [String] user_ip
2311
+ # Deprecated. Please use quotaUser instead.
2312
+ # @param [Google::Apis::RequestOptions] options
2313
+ # Request-specific options
2314
+ #
2315
+ # @yield [result, err] Result & error if block supplied
2316
+ # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object
2317
+ # @yieldparam err [StandardError] error object if request failed
2318
+ #
2319
+ # @return [Google::Apis::AnalyticsV3::Profile]
2320
+ #
2321
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2322
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2323
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2324
+ def patch_profile(account_id, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2325
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
2326
+ command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation
2327
+ command.request_object = profile_object
2328
+ command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
2329
+ command.response_class = Google::Apis::AnalyticsV3::Profile
2330
+ command.params['accountId'] = account_id unless account_id.nil?
2331
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2332
+ command.params['profileId'] = profile_id unless profile_id.nil?
2333
+ command.query['fields'] = fields unless fields.nil?
2334
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2335
+ command.query['userIp'] = user_ip unless user_ip.nil?
2336
+ execute_or_queue_command(command, &block)
2337
+ end
2338
+
2339
+ # Updates an existing view (profile).
2340
+ # @param [String] account_id
2341
+ # Account ID to which the view (profile) belongs
2342
+ # @param [String] web_property_id
2343
+ # Web property ID to which the view (profile) belongs
2344
+ # @param [String] profile_id
2345
+ # ID of the view (profile) to be updated.
2346
+ # @param [Google::Apis::AnalyticsV3::Profile] profile_object
2347
+ # @param [String] fields
2348
+ # Selector specifying which fields to include in a partial response.
2349
+ # @param [String] quota_user
2350
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2351
+ # characters.
2352
+ # @param [String] user_ip
2353
+ # Deprecated. Please use quotaUser instead.
2354
+ # @param [Google::Apis::RequestOptions] options
2355
+ # Request-specific options
2356
+ #
2357
+ # @yield [result, err] Result & error if block supplied
2358
+ # @yieldparam result [Google::Apis::AnalyticsV3::Profile] parsed result object
2359
+ # @yieldparam err [StandardError] error object if request failed
2360
+ #
2361
+ # @return [Google::Apis::AnalyticsV3::Profile]
2362
+ #
2363
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2364
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2365
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2366
+ def update_profile(account_id, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2367
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
2368
+ command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation
2369
+ command.request_object = profile_object
2370
+ command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
2371
+ command.response_class = Google::Apis::AnalyticsV3::Profile
2372
+ command.params['accountId'] = account_id unless account_id.nil?
2373
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2374
+ command.params['profileId'] = profile_id unless profile_id.nil?
2375
+ command.query['fields'] = fields unless fields.nil?
2376
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2377
+ command.query['userIp'] = user_ip unless user_ip.nil?
2378
+ execute_or_queue_command(command, &block)
2379
+ end
2380
+
2381
+ # Delete a remarketing audience.
2382
+ # @param [String] account_id
2383
+ # Account ID to which the remarketing audience belongs.
2384
+ # @param [String] web_property_id
2385
+ # Web property ID to which the remarketing audience belongs.
2386
+ # @param [String] remarketing_audience_id
2387
+ # The ID of the remarketing audience to delete.
2388
+ # @param [String] fields
2389
+ # Selector specifying which fields to include in a partial response.
2390
+ # @param [String] quota_user
2391
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2392
+ # characters.
2393
+ # @param [String] user_ip
2394
+ # Deprecated. Please use quotaUser instead.
2395
+ # @param [Google::Apis::RequestOptions] options
2396
+ # Request-specific options
2397
+ #
2398
+ # @yield [result, err] Result & error if block supplied
2399
+ # @yieldparam result [NilClass] No result returned for this method
2400
+ # @yieldparam err [StandardError] error object if request failed
2401
+ #
2402
+ # @return [void]
2403
+ #
2404
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2405
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2406
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2407
+ def delete_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2408
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options)
2409
+ command.params['accountId'] = account_id unless account_id.nil?
2410
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2411
+ command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_id.nil?
2412
+ command.query['fields'] = fields unless fields.nil?
2413
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2414
+ command.query['userIp'] = user_ip unless user_ip.nil?
2415
+ execute_or_queue_command(command, &block)
2416
+ end
2417
+
2418
+ # Gets a remarketing audience to which the user has access.
2419
+ # @param [String] account_id
2420
+ # The account ID of the remarketing audience to retrieve.
2421
+ # @param [String] web_property_id
2422
+ # The web property ID of the remarketing audience to retrieve.
2423
+ # @param [String] remarketing_audience_id
2424
+ # The ID of the remarketing audience to retrieve.
2425
+ # @param [String] fields
2426
+ # Selector specifying which fields to include in a partial response.
2427
+ # @param [String] quota_user
2428
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2429
+ # characters.
2430
+ # @param [String] user_ip
2431
+ # Deprecated. Please use quotaUser instead.
2432
+ # @param [Google::Apis::RequestOptions] options
2433
+ # Request-specific options
2434
+ #
2435
+ # @yield [result, err] Result & error if block supplied
2436
+ # @yieldparam result [Google::Apis::AnalyticsV3::RemarketingAudience] parsed result object
2437
+ # @yieldparam err [StandardError] error object if request failed
2438
+ #
2439
+ # @return [Google::Apis::AnalyticsV3::RemarketingAudience]
2440
+ #
2441
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2442
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2443
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2444
+ def get_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2445
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options)
2446
+ command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
2447
+ command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience
2448
+ command.params['accountId'] = account_id unless account_id.nil?
2449
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2450
+ command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_id.nil?
2451
+ command.query['fields'] = fields unless fields.nil?
2452
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2453
+ command.query['userIp'] = user_ip unless user_ip.nil?
2454
+ execute_or_queue_command(command, &block)
2455
+ end
2456
+
2457
+ # Creates a new remarketing audience.
2458
+ # @param [String] account_id
2459
+ # The account ID for which to create the remarketing audience.
2460
+ # @param [String] web_property_id
2461
+ # Web property ID for which to create the remarketing audience.
2462
+ # @param [Google::Apis::AnalyticsV3::RemarketingAudience] remarketing_audience_object
2463
+ # @param [String] fields
2464
+ # Selector specifying which fields to include in a partial response.
2465
+ # @param [String] quota_user
2466
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2467
+ # characters.
2468
+ # @param [String] user_ip
2469
+ # Deprecated. Please use quotaUser instead.
2470
+ # @param [Google::Apis::RequestOptions] options
2471
+ # Request-specific options
2472
+ #
2473
+ # @yield [result, err] Result & error if block supplied
2474
+ # @yieldparam result [Google::Apis::AnalyticsV3::RemarketingAudience] parsed result object
2475
+ # @yieldparam err [StandardError] error object if request failed
2476
+ #
2477
+ # @return [Google::Apis::AnalyticsV3::RemarketingAudience]
2478
+ #
2479
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2480
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2481
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2482
+ def insert_management_remarketing_audience(account_id, web_property_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2483
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences', options)
2484
+ command.request_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
2485
+ command.request_object = remarketing_audience_object
2486
+ command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
2487
+ command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience
2488
+ command.params['accountId'] = account_id unless account_id.nil?
2489
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2490
+ command.query['fields'] = fields unless fields.nil?
2491
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2492
+ command.query['userIp'] = user_ip unless user_ip.nil?
2493
+ execute_or_queue_command(command, &block)
2494
+ end
2495
+
2496
+ # Lists remarketing audiences to which the user has access.
2497
+ # @param [String] account_id
2498
+ # The account ID of the remarketing audiences to retrieve.
2499
+ # @param [String] web_property_id
2500
+ # The web property ID of the remarketing audiences to retrieve.
2501
+ # @param [Fixnum] max_results
2502
+ # The maximum number of remarketing audiences to include in this response.
2503
+ # @param [Fixnum] start_index
2504
+ # An index of the first entity to retrieve. Use this parameter as a pagination
2505
+ # mechanism along with the max-results parameter.
2506
+ # @param [String] type
2507
+ # @param [String] fields
2508
+ # Selector specifying which fields to include in a partial response.
2509
+ # @param [String] quota_user
2510
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2511
+ # characters.
2512
+ # @param [String] user_ip
2513
+ # Deprecated. Please use quotaUser instead.
2514
+ # @param [Google::Apis::RequestOptions] options
2515
+ # Request-specific options
2516
+ #
2517
+ # @yield [result, err] Result & error if block supplied
2518
+ # @yieldparam result [Google::Apis::AnalyticsV3::RemarketingAudiences] parsed result object
2519
+ # @yieldparam err [StandardError] error object if request failed
2520
+ #
2521
+ # @return [Google::Apis::AnalyticsV3::RemarketingAudiences]
2522
+ #
2523
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2524
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2525
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2526
+ def list_management_remarketing_audiences(account_id, web_property_id, max_results: nil, start_index: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2527
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences', options)
2528
+ command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudiences::Representation
2529
+ command.response_class = Google::Apis::AnalyticsV3::RemarketingAudiences
2530
+ command.params['accountId'] = account_id unless account_id.nil?
2531
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2532
+ command.query['max-results'] = max_results unless max_results.nil?
2533
+ command.query['start-index'] = start_index unless start_index.nil?
2534
+ command.query['type'] = type unless type.nil?
2535
+ command.query['fields'] = fields unless fields.nil?
2536
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2537
+ command.query['userIp'] = user_ip unless user_ip.nil?
2538
+ execute_or_queue_command(command, &block)
2539
+ end
2540
+
2541
+ # Updates an existing remarketing audience. This method supports patch semantics.
2542
+ # @param [String] account_id
2543
+ # The account ID of the remarketing audience to update.
2544
+ # @param [String] web_property_id
2545
+ # The web property ID of the remarketing audience to update.
2546
+ # @param [String] remarketing_audience_id
2547
+ # The ID of the remarketing audience to update.
2548
+ # @param [Google::Apis::AnalyticsV3::RemarketingAudience] remarketing_audience_object
2549
+ # @param [String] fields
2550
+ # Selector specifying which fields to include in a partial response.
2551
+ # @param [String] quota_user
2552
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2553
+ # characters.
2554
+ # @param [String] user_ip
2555
+ # Deprecated. Please use quotaUser instead.
2556
+ # @param [Google::Apis::RequestOptions] options
2557
+ # Request-specific options
2558
+ #
2559
+ # @yield [result, err] Result & error if block supplied
2560
+ # @yieldparam result [Google::Apis::AnalyticsV3::RemarketingAudience] parsed result object
2561
+ # @yieldparam err [StandardError] error object if request failed
2562
+ #
2563
+ # @return [Google::Apis::AnalyticsV3::RemarketingAudience]
2564
+ #
2565
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2566
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2567
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2568
+ def patch_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2569
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options)
2570
+ command.request_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
2571
+ command.request_object = remarketing_audience_object
2572
+ command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
2573
+ command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience
2574
+ command.params['accountId'] = account_id unless account_id.nil?
2575
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2576
+ command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_id.nil?
2577
+ command.query['fields'] = fields unless fields.nil?
2578
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2579
+ command.query['userIp'] = user_ip unless user_ip.nil?
2580
+ execute_or_queue_command(command, &block)
2581
+ end
2582
+
2583
+ # Updates an existing remarketing audience.
2584
+ # @param [String] account_id
2585
+ # The account ID of the remarketing audience to update.
2586
+ # @param [String] web_property_id
2587
+ # The web property ID of the remarketing audience to update.
2588
+ # @param [String] remarketing_audience_id
2589
+ # The ID of the remarketing audience to update.
2590
+ # @param [Google::Apis::AnalyticsV3::RemarketingAudience] remarketing_audience_object
2591
+ # @param [String] fields
2592
+ # Selector specifying which fields to include in a partial response.
2593
+ # @param [String] quota_user
2594
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2595
+ # characters.
2596
+ # @param [String] user_ip
2597
+ # Deprecated. Please use quotaUser instead.
2598
+ # @param [Google::Apis::RequestOptions] options
2599
+ # Request-specific options
2600
+ #
2601
+ # @yield [result, err] Result & error if block supplied
2602
+ # @yieldparam result [Google::Apis::AnalyticsV3::RemarketingAudience] parsed result object
2603
+ # @yieldparam err [StandardError] error object if request failed
2604
+ #
2605
+ # @return [Google::Apis::AnalyticsV3::RemarketingAudience]
2606
+ #
2607
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2608
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2609
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2610
+ def update_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2611
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options)
2612
+ command.request_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
2613
+ command.request_object = remarketing_audience_object
2614
+ command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
2615
+ command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience
2616
+ command.params['accountId'] = account_id unless account_id.nil?
2617
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2618
+ command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_id.nil?
2619
+ command.query['fields'] = fields unless fields.nil?
2620
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2621
+ command.query['userIp'] = user_ip unless user_ip.nil?
2622
+ execute_or_queue_command(command, &block)
2623
+ end
2624
+
2625
+ # Lists segments to which the user has access.
2626
+ # @param [Fixnum] max_results
2627
+ # The maximum number of segments to include in this response.
2628
+ # @param [Fixnum] start_index
2629
+ # An index of the first segment to retrieve. Use this parameter as a pagination
2630
+ # mechanism along with the max-results parameter.
2631
+ # @param [String] fields
2632
+ # Selector specifying which fields to include in a partial response.
2633
+ # @param [String] quota_user
2634
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2635
+ # characters.
2636
+ # @param [String] user_ip
2637
+ # Deprecated. Please use quotaUser instead.
2638
+ # @param [Google::Apis::RequestOptions] options
2639
+ # Request-specific options
2640
+ #
2641
+ # @yield [result, err] Result & error if block supplied
2642
+ # @yieldparam result [Google::Apis::AnalyticsV3::Segments] parsed result object
2643
+ # @yieldparam err [StandardError] error object if request failed
2644
+ #
2645
+ # @return [Google::Apis::AnalyticsV3::Segments]
2646
+ #
2647
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2648
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2649
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2650
+ def list_segments(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2651
+ command = make_simple_command(:get, 'management/segments', options)
2652
+ command.response_representation = Google::Apis::AnalyticsV3::Segments::Representation
2653
+ command.response_class = Google::Apis::AnalyticsV3::Segments
2654
+ command.query['max-results'] = max_results unless max_results.nil?
2655
+ command.query['start-index'] = start_index unless start_index.nil?
2656
+ command.query['fields'] = fields unless fields.nil?
2657
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2658
+ command.query['userIp'] = user_ip unless user_ip.nil?
2659
+ execute_or_queue_command(command, &block)
2660
+ end
2661
+
2662
+ # Deletes an unsampled report.
2663
+ # @param [String] account_id
2664
+ # Account ID to delete the unsampled report for.
2665
+ # @param [String] web_property_id
2666
+ # Web property ID to delete the unsampled reports for.
2667
+ # @param [String] profile_id
2668
+ # View (Profile) ID to delete the unsampled report for.
2669
+ # @param [String] unsampled_report_id
2670
+ # ID of the unsampled report to be deleted.
2671
+ # @param [String] fields
2672
+ # Selector specifying which fields to include in a partial response.
2673
+ # @param [String] quota_user
2674
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2675
+ # characters.
2676
+ # @param [String] user_ip
2677
+ # Deprecated. Please use quotaUser instead.
2678
+ # @param [Google::Apis::RequestOptions] options
2679
+ # Request-specific options
2680
+ #
2681
+ # @yield [result, err] Result & error if block supplied
2682
+ # @yieldparam result [NilClass] No result returned for this method
2683
+ # @yieldparam err [StandardError] error object if request failed
2684
+ #
2685
+ # @return [void]
2686
+ #
2687
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2688
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2689
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2690
+ def delete_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2691
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}', options)
2692
+ command.params['accountId'] = account_id unless account_id.nil?
2693
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2694
+ command.params['profileId'] = profile_id unless profile_id.nil?
2695
+ command.params['unsampledReportId'] = unsampled_report_id unless unsampled_report_id.nil?
2696
+ command.query['fields'] = fields unless fields.nil?
2697
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2698
+ command.query['userIp'] = user_ip unless user_ip.nil?
2699
+ execute_or_queue_command(command, &block)
2700
+ end
2701
+
2702
+ # Returns a single unsampled report.
2703
+ # @param [String] account_id
2704
+ # Account ID to retrieve unsampled report for.
2705
+ # @param [String] web_property_id
2706
+ # Web property ID to retrieve unsampled reports for.
2707
+ # @param [String] profile_id
2708
+ # View (Profile) ID to retrieve unsampled report for.
2709
+ # @param [String] unsampled_report_id
2710
+ # ID of the unsampled report to retrieve.
2711
+ # @param [String] fields
2712
+ # Selector specifying which fields to include in a partial response.
2713
+ # @param [String] quota_user
2714
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2715
+ # characters.
2716
+ # @param [String] user_ip
2717
+ # Deprecated. Please use quotaUser instead.
2718
+ # @param [Google::Apis::RequestOptions] options
2719
+ # Request-specific options
2720
+ #
2721
+ # @yield [result, err] Result & error if block supplied
2722
+ # @yieldparam result [Google::Apis::AnalyticsV3::UnsampledReport] parsed result object
2723
+ # @yieldparam err [StandardError] error object if request failed
2724
+ #
2725
+ # @return [Google::Apis::AnalyticsV3::UnsampledReport]
2726
+ #
2727
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2728
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2729
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2730
+ def get_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2731
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}', options)
2732
+ command.response_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation
2733
+ command.response_class = Google::Apis::AnalyticsV3::UnsampledReport
2734
+ command.params['accountId'] = account_id unless account_id.nil?
2735
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2736
+ command.params['profileId'] = profile_id unless profile_id.nil?
2737
+ command.params['unsampledReportId'] = unsampled_report_id unless unsampled_report_id.nil?
2738
+ command.query['fields'] = fields unless fields.nil?
2739
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2740
+ command.query['userIp'] = user_ip unless user_ip.nil?
2741
+ execute_or_queue_command(command, &block)
2742
+ end
2743
+
2744
+ # Create a new unsampled report.
2745
+ # @param [String] account_id
2746
+ # Account ID to create the unsampled report for.
2747
+ # @param [String] web_property_id
2748
+ # Web property ID to create the unsampled report for.
2749
+ # @param [String] profile_id
2750
+ # View (Profile) ID to create the unsampled report for.
2751
+ # @param [Google::Apis::AnalyticsV3::UnsampledReport] unsampled_report_object
2752
+ # @param [String] fields
2753
+ # Selector specifying which fields to include in a partial response.
2754
+ # @param [String] quota_user
2755
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2756
+ # characters.
2757
+ # @param [String] user_ip
2758
+ # Deprecated. Please use quotaUser instead.
2759
+ # @param [Google::Apis::RequestOptions] options
2760
+ # Request-specific options
2761
+ #
2762
+ # @yield [result, err] Result & error if block supplied
2763
+ # @yieldparam result [Google::Apis::AnalyticsV3::UnsampledReport] parsed result object
2764
+ # @yieldparam err [StandardError] error object if request failed
2765
+ #
2766
+ # @return [Google::Apis::AnalyticsV3::UnsampledReport]
2767
+ #
2768
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2769
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2770
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2771
+ def insert_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2772
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports', options)
2773
+ command.request_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation
2774
+ command.request_object = unsampled_report_object
2775
+ command.response_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation
2776
+ command.response_class = Google::Apis::AnalyticsV3::UnsampledReport
2777
+ command.params['accountId'] = account_id unless account_id.nil?
2778
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2779
+ command.params['profileId'] = profile_id unless profile_id.nil?
2780
+ command.query['fields'] = fields unless fields.nil?
2781
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2782
+ command.query['userIp'] = user_ip unless user_ip.nil?
2783
+ execute_or_queue_command(command, &block)
2784
+ end
2785
+
2786
+ # Lists unsampled reports to which the user has access.
2787
+ # @param [String] account_id
2788
+ # Account ID to retrieve unsampled reports for. Must be a specific account ID, ~
2789
+ # all is not supported.
2790
+ # @param [String] web_property_id
2791
+ # Web property ID to retrieve unsampled reports for. Must be a specific web
2792
+ # property ID, ~all is not supported.
2793
+ # @param [String] profile_id
2794
+ # View (Profile) ID to retrieve unsampled reports for. Must be a specific view (
2795
+ # profile) ID, ~all is not supported.
2796
+ # @param [Fixnum] max_results
2797
+ # The maximum number of unsampled reports to include in this response.
2798
+ # @param [Fixnum] start_index
2799
+ # An index of the first unsampled report to retrieve. Use this parameter as a
2800
+ # pagination mechanism along with the max-results parameter.
2801
+ # @param [String] fields
2802
+ # Selector specifying which fields to include in a partial response.
2803
+ # @param [String] quota_user
2804
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2805
+ # characters.
2806
+ # @param [String] user_ip
2807
+ # Deprecated. Please use quotaUser instead.
2808
+ # @param [Google::Apis::RequestOptions] options
2809
+ # Request-specific options
2810
+ #
2811
+ # @yield [result, err] Result & error if block supplied
2812
+ # @yieldparam result [Google::Apis::AnalyticsV3::UnsampledReports] parsed result object
2813
+ # @yieldparam err [StandardError] error object if request failed
2814
+ #
2815
+ # @return [Google::Apis::AnalyticsV3::UnsampledReports]
2816
+ #
2817
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2818
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2819
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2820
+ def list_unsampled_reports(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2821
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports', options)
2822
+ command.response_representation = Google::Apis::AnalyticsV3::UnsampledReports::Representation
2823
+ command.response_class = Google::Apis::AnalyticsV3::UnsampledReports
2824
+ command.params['accountId'] = account_id unless account_id.nil?
2825
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2826
+ command.params['profileId'] = profile_id unless profile_id.nil?
2827
+ command.query['max-results'] = max_results unless max_results.nil?
2828
+ command.query['start-index'] = start_index unless start_index.nil?
2829
+ command.query['fields'] = fields unless fields.nil?
2830
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2831
+ command.query['userIp'] = user_ip unless user_ip.nil?
2832
+ execute_or_queue_command(command, &block)
2833
+ end
2834
+
2835
+ # Delete data associated with a previous upload.
2836
+ # @param [String] account_id
2837
+ # Account Id for the uploads to be deleted.
2838
+ # @param [String] web_property_id
2839
+ # Web property Id for the uploads to be deleted.
2840
+ # @param [String] custom_data_source_id
2841
+ # Custom data source Id for the uploads to be deleted.
2842
+ # @param [Google::Apis::AnalyticsV3::DeleteUploadDataRequest] delete_upload_data_request_object
2843
+ # @param [String] fields
2844
+ # Selector specifying which fields to include in a partial response.
2845
+ # @param [String] quota_user
2846
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2847
+ # characters.
2848
+ # @param [String] user_ip
2849
+ # Deprecated. Please use quotaUser instead.
2850
+ # @param [Google::Apis::RequestOptions] options
2851
+ # Request-specific options
2852
+ #
2853
+ # @yield [result, err] Result & error if block supplied
2854
+ # @yieldparam result [NilClass] No result returned for this method
2855
+ # @yieldparam err [StandardError] error object if request failed
2856
+ #
2857
+ # @return [void]
2858
+ #
2859
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2860
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2861
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2862
+ def delete_upload_data(account_id, web_property_id, custom_data_source_id, delete_upload_data_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2863
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData', options)
2864
+ command.request_representation = Google::Apis::AnalyticsV3::DeleteUploadDataRequest::Representation
2865
+ command.request_object = delete_upload_data_request_object
2866
+ command.params['accountId'] = account_id unless account_id.nil?
2867
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2868
+ command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
2869
+ command.query['fields'] = fields unless fields.nil?
2870
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2871
+ command.query['userIp'] = user_ip unless user_ip.nil?
2872
+ execute_or_queue_command(command, &block)
2873
+ end
2874
+
2875
+ # List uploads to which the user has access.
2876
+ # @param [String] account_id
2877
+ # Account Id for the upload to retrieve.
2878
+ # @param [String] web_property_id
2879
+ # Web property Id for the upload to retrieve.
2880
+ # @param [String] custom_data_source_id
2881
+ # Custom data source Id for upload to retrieve.
2882
+ # @param [String] upload_id
2883
+ # Upload Id to retrieve.
2884
+ # @param [String] fields
2885
+ # Selector specifying which fields to include in a partial response.
2886
+ # @param [String] quota_user
2887
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2888
+ # characters.
2889
+ # @param [String] user_ip
2890
+ # Deprecated. Please use quotaUser instead.
2891
+ # @param [Google::Apis::RequestOptions] options
2892
+ # Request-specific options
2893
+ #
2894
+ # @yield [result, err] Result & error if block supplied
2895
+ # @yieldparam result [Google::Apis::AnalyticsV3::Upload] parsed result object
2896
+ # @yieldparam err [StandardError] error object if request failed
2897
+ #
2898
+ # @return [Google::Apis::AnalyticsV3::Upload]
2899
+ #
2900
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2901
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2902
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2903
+ def get_upload(account_id, web_property_id, custom_data_source_id, upload_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2904
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}', options)
2905
+ command.response_representation = Google::Apis::AnalyticsV3::Upload::Representation
2906
+ command.response_class = Google::Apis::AnalyticsV3::Upload
2907
+ command.params['accountId'] = account_id unless account_id.nil?
2908
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2909
+ command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
2910
+ command.params['uploadId'] = upload_id unless upload_id.nil?
2911
+ command.query['fields'] = fields unless fields.nil?
2912
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2913
+ command.query['userIp'] = user_ip unless user_ip.nil?
2914
+ execute_or_queue_command(command, &block)
2915
+ end
2916
+
2917
+ # List uploads to which the user has access.
2918
+ # @param [String] account_id
2919
+ # Account Id for the uploads to retrieve.
2920
+ # @param [String] web_property_id
2921
+ # Web property Id for the uploads to retrieve.
2922
+ # @param [String] custom_data_source_id
2923
+ # Custom data source Id for uploads to retrieve.
2924
+ # @param [Fixnum] max_results
2925
+ # The maximum number of uploads to include in this response.
2926
+ # @param [Fixnum] start_index
2927
+ # A 1-based index of the first upload to retrieve. Use this parameter as a
2928
+ # pagination mechanism along with the max-results parameter.
2929
+ # @param [String] fields
2930
+ # Selector specifying which fields to include in a partial response.
2931
+ # @param [String] quota_user
2932
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2933
+ # characters.
2934
+ # @param [String] user_ip
2935
+ # Deprecated. Please use quotaUser instead.
2936
+ # @param [Google::Apis::RequestOptions] options
2937
+ # Request-specific options
2938
+ #
2939
+ # @yield [result, err] Result & error if block supplied
2940
+ # @yieldparam result [Google::Apis::AnalyticsV3::Uploads] parsed result object
2941
+ # @yieldparam err [StandardError] error object if request failed
2942
+ #
2943
+ # @return [Google::Apis::AnalyticsV3::Uploads]
2944
+ #
2945
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2946
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2947
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2948
+ def list_uploads(account_id, web_property_id, custom_data_source_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2949
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options)
2950
+ command.response_representation = Google::Apis::AnalyticsV3::Uploads::Representation
2951
+ command.response_class = Google::Apis::AnalyticsV3::Uploads
2952
+ command.params['accountId'] = account_id unless account_id.nil?
2953
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
2954
+ command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
2955
+ command.query['max-results'] = max_results unless max_results.nil?
2956
+ command.query['start-index'] = start_index unless start_index.nil?
2957
+ command.query['fields'] = fields unless fields.nil?
2958
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2959
+ command.query['userIp'] = user_ip unless user_ip.nil?
2960
+ execute_or_queue_command(command, &block)
2961
+ end
2962
+
2963
+ # Upload data for a custom data source.
2964
+ # @param [String] account_id
2965
+ # Account Id associated with the upload.
2966
+ # @param [String] web_property_id
2967
+ # Web property UA-string associated with the upload.
2968
+ # @param [String] custom_data_source_id
2969
+ # Custom data source Id to which the data being uploaded belongs.
2970
+ # @param [String] fields
2971
+ # Selector specifying which fields to include in a partial response.
2972
+ # @param [String] quota_user
2973
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
2974
+ # characters.
2975
+ # @param [String] user_ip
2976
+ # Deprecated. Please use quotaUser instead.
2977
+ # @param [IO, String] upload_source
2978
+ # IO stream or filename containing content to upload
2979
+ # @param [String] content_type
2980
+ # Content type of the uploaded content.
2981
+ # @param [Google::Apis::RequestOptions] options
2982
+ # Request-specific options
2983
+ #
2984
+ # @yield [result, err] Result & error if block supplied
2985
+ # @yieldparam result [Google::Apis::AnalyticsV3::Upload] parsed result object
2986
+ # @yieldparam err [StandardError] error object if request failed
2987
+ #
2988
+ # @return [Google::Apis::AnalyticsV3::Upload]
2989
+ #
2990
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2991
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2992
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2993
+ def upload_data(account_id, web_property_id, custom_data_source_id, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
2994
+ if upload_source.nil?
2995
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options)
2996
+ else
2997
+ command = make_upload_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options)
2998
+ command.upload_source = upload_source
2999
+ command.upload_content_type = content_type
3000
+ end
3001
+ command.response_representation = Google::Apis::AnalyticsV3::Upload::Representation
3002
+ command.response_class = Google::Apis::AnalyticsV3::Upload
3003
+ command.params['accountId'] = account_id unless account_id.nil?
3004
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3005
+ command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
3006
+ command.query['fields'] = fields unless fields.nil?
3007
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3008
+ command.query['userIp'] = user_ip unless user_ip.nil?
3009
+ execute_or_queue_command(command, &block)
3010
+ end
3011
+
3012
+ # Deletes a web property-Google Ads link.
3013
+ # @param [String] account_id
3014
+ # ID of the account which the given web property belongs to.
3015
+ # @param [String] web_property_id
3016
+ # Web property ID to delete the Google Ads link for.
3017
+ # @param [String] web_property_ad_words_link_id
3018
+ # Web property Google Ads link ID.
3019
+ # @param [String] fields
3020
+ # Selector specifying which fields to include in a partial response.
3021
+ # @param [String] quota_user
3022
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3023
+ # characters.
3024
+ # @param [String] user_ip
3025
+ # Deprecated. Please use quotaUser instead.
3026
+ # @param [Google::Apis::RequestOptions] options
3027
+ # Request-specific options
3028
+ #
3029
+ # @yield [result, err] Result & error if block supplied
3030
+ # @yieldparam result [NilClass] No result returned for this method
3031
+ # @yieldparam err [StandardError] error object if request failed
3032
+ #
3033
+ # @return [void]
3034
+ #
3035
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3036
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3037
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3038
+ def delete_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3039
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
3040
+ command.params['accountId'] = account_id unless account_id.nil?
3041
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3042
+ command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
3043
+ command.query['fields'] = fields unless fields.nil?
3044
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3045
+ command.query['userIp'] = user_ip unless user_ip.nil?
3046
+ execute_or_queue_command(command, &block)
3047
+ end
3048
+
3049
+ # Returns a web property-Google Ads link to which the user has access.
3050
+ # @param [String] account_id
3051
+ # ID of the account which the given web property belongs to.
3052
+ # @param [String] web_property_id
3053
+ # Web property ID to retrieve the Google Ads link for.
3054
+ # @param [String] web_property_ad_words_link_id
3055
+ # Web property-Google Ads link ID.
3056
+ # @param [String] fields
3057
+ # Selector specifying which fields to include in a partial response.
3058
+ # @param [String] quota_user
3059
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3060
+ # characters.
3061
+ # @param [String] user_ip
3062
+ # Deprecated. Please use quotaUser instead.
3063
+ # @param [Google::Apis::RequestOptions] options
3064
+ # Request-specific options
3065
+ #
3066
+ # @yield [result, err] Result & error if block supplied
3067
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object
3068
+ # @yieldparam err [StandardError] error object if request failed
3069
+ #
3070
+ # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink]
3071
+ #
3072
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3073
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3074
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3075
+ def get_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3076
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
3077
+ command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
3078
+ command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
3079
+ command.params['accountId'] = account_id unless account_id.nil?
3080
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3081
+ command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
3082
+ command.query['fields'] = fields unless fields.nil?
3083
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3084
+ command.query['userIp'] = user_ip unless user_ip.nil?
3085
+ execute_or_queue_command(command, &block)
3086
+ end
3087
+
3088
+ # Creates a webProperty-Google Ads link.
3089
+ # @param [String] account_id
3090
+ # ID of the Google Analytics account to create the link for.
3091
+ # @param [String] web_property_id
3092
+ # Web property ID to create the link for.
3093
+ # @param [Google::Apis::AnalyticsV3::EntityAdWordsLink] entity_ad_words_link_object
3094
+ # @param [String] fields
3095
+ # Selector specifying which fields to include in a partial response.
3096
+ # @param [String] quota_user
3097
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3098
+ # characters.
3099
+ # @param [String] user_ip
3100
+ # Deprecated. Please use quotaUser instead.
3101
+ # @param [Google::Apis::RequestOptions] options
3102
+ # Request-specific options
3103
+ #
3104
+ # @yield [result, err] Result & error if block supplied
3105
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object
3106
+ # @yieldparam err [StandardError] error object if request failed
3107
+ #
3108
+ # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink]
3109
+ #
3110
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3111
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3112
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3113
+ def insert_web_property_ad_words_link(account_id, web_property_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3114
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks', options)
3115
+ command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
3116
+ command.request_object = entity_ad_words_link_object
3117
+ command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
3118
+ command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
3119
+ command.params['accountId'] = account_id unless account_id.nil?
3120
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3121
+ command.query['fields'] = fields unless fields.nil?
3122
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3123
+ command.query['userIp'] = user_ip unless user_ip.nil?
3124
+ execute_or_queue_command(command, &block)
3125
+ end
3126
+
3127
+ # Lists webProperty-Google Ads links for a given web property.
3128
+ # @param [String] account_id
3129
+ # ID of the account which the given web property belongs to.
3130
+ # @param [String] web_property_id
3131
+ # Web property ID to retrieve the Google Ads links for.
3132
+ # @param [Fixnum] max_results
3133
+ # The maximum number of webProperty-Google Ads links to include in this response.
3134
+ # @param [Fixnum] start_index
3135
+ # An index of the first webProperty-Google Ads link to retrieve. Use this
3136
+ # parameter as a pagination mechanism along with the max-results parameter.
3137
+ # @param [String] fields
3138
+ # Selector specifying which fields to include in a partial response.
3139
+ # @param [String] quota_user
3140
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3141
+ # characters.
3142
+ # @param [String] user_ip
3143
+ # Deprecated. Please use quotaUser instead.
3144
+ # @param [Google::Apis::RequestOptions] options
3145
+ # Request-specific options
3146
+ #
3147
+ # @yield [result, err] Result & error if block supplied
3148
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLinks] parsed result object
3149
+ # @yieldparam err [StandardError] error object if request failed
3150
+ #
3151
+ # @return [Google::Apis::AnalyticsV3::EntityAdWordsLinks]
3152
+ #
3153
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3154
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3155
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3156
+ def list_web_property_ad_words_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3157
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks', options)
3158
+ command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLinks::Representation
3159
+ command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLinks
3160
+ command.params['accountId'] = account_id unless account_id.nil?
3161
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3162
+ command.query['max-results'] = max_results unless max_results.nil?
3163
+ command.query['start-index'] = start_index unless start_index.nil?
3164
+ command.query['fields'] = fields unless fields.nil?
3165
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3166
+ command.query['userIp'] = user_ip unless user_ip.nil?
3167
+ execute_or_queue_command(command, &block)
3168
+ end
3169
+
3170
+ # Updates an existing webProperty-Google Ads link. This method supports patch
3171
+ # semantics.
3172
+ # @param [String] account_id
3173
+ # ID of the account which the given web property belongs to.
3174
+ # @param [String] web_property_id
3175
+ # Web property ID to retrieve the Google Ads link for.
3176
+ # @param [String] web_property_ad_words_link_id
3177
+ # Web property-Google Ads link ID.
3178
+ # @param [Google::Apis::AnalyticsV3::EntityAdWordsLink] entity_ad_words_link_object
3179
+ # @param [String] fields
3180
+ # Selector specifying which fields to include in a partial response.
3181
+ # @param [String] quota_user
3182
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3183
+ # characters.
3184
+ # @param [String] user_ip
3185
+ # Deprecated. Please use quotaUser instead.
3186
+ # @param [Google::Apis::RequestOptions] options
3187
+ # Request-specific options
3188
+ #
3189
+ # @yield [result, err] Result & error if block supplied
3190
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object
3191
+ # @yieldparam err [StandardError] error object if request failed
3192
+ #
3193
+ # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink]
3194
+ #
3195
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3196
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3197
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3198
+ def patch_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3199
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
3200
+ command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
3201
+ command.request_object = entity_ad_words_link_object
3202
+ command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
3203
+ command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
3204
+ command.params['accountId'] = account_id unless account_id.nil?
3205
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3206
+ command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
3207
+ command.query['fields'] = fields unless fields.nil?
3208
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3209
+ command.query['userIp'] = user_ip unless user_ip.nil?
3210
+ execute_or_queue_command(command, &block)
3211
+ end
3212
+
3213
+ # Updates an existing webProperty-Google Ads link.
3214
+ # @param [String] account_id
3215
+ # ID of the account which the given web property belongs to.
3216
+ # @param [String] web_property_id
3217
+ # Web property ID to retrieve the Google Ads link for.
3218
+ # @param [String] web_property_ad_words_link_id
3219
+ # Web property-Google Ads link ID.
3220
+ # @param [Google::Apis::AnalyticsV3::EntityAdWordsLink] entity_ad_words_link_object
3221
+ # @param [String] fields
3222
+ # Selector specifying which fields to include in a partial response.
3223
+ # @param [String] quota_user
3224
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3225
+ # characters.
3226
+ # @param [String] user_ip
3227
+ # Deprecated. Please use quotaUser instead.
3228
+ # @param [Google::Apis::RequestOptions] options
3229
+ # Request-specific options
3230
+ #
3231
+ # @yield [result, err] Result & error if block supplied
3232
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityAdWordsLink] parsed result object
3233
+ # @yieldparam err [StandardError] error object if request failed
3234
+ #
3235
+ # @return [Google::Apis::AnalyticsV3::EntityAdWordsLink]
3236
+ #
3237
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3238
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3239
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3240
+ def update_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3241
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
3242
+ command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
3243
+ command.request_object = entity_ad_words_link_object
3244
+ command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
3245
+ command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
3246
+ command.params['accountId'] = account_id unless account_id.nil?
3247
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3248
+ command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
3249
+ command.query['fields'] = fields unless fields.nil?
3250
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3251
+ command.query['userIp'] = user_ip unless user_ip.nil?
3252
+ execute_or_queue_command(command, &block)
3253
+ end
3254
+
3255
+ # Gets a web property to which the user has access.
3256
+ # @param [String] account_id
3257
+ # Account ID to retrieve the web property for.
3258
+ # @param [String] web_property_id
3259
+ # ID to retrieve the web property for.
3260
+ # @param [String] fields
3261
+ # Selector specifying which fields to include in a partial response.
3262
+ # @param [String] quota_user
3263
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3264
+ # characters.
3265
+ # @param [String] user_ip
3266
+ # Deprecated. Please use quotaUser instead.
3267
+ # @param [Google::Apis::RequestOptions] options
3268
+ # Request-specific options
3269
+ #
3270
+ # @yield [result, err] Result & error if block supplied
3271
+ # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object
3272
+ # @yieldparam err [StandardError] error object if request failed
3273
+ #
3274
+ # @return [Google::Apis::AnalyticsV3::Webproperty]
3275
+ #
3276
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3277
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3278
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3279
+ def get_web_property(account_id, web_property_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3280
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options)
3281
+ command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3282
+ command.response_class = Google::Apis::AnalyticsV3::Webproperty
3283
+ command.params['accountId'] = account_id unless account_id.nil?
3284
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3285
+ command.query['fields'] = fields unless fields.nil?
3286
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3287
+ command.query['userIp'] = user_ip unless user_ip.nil?
3288
+ execute_or_queue_command(command, &block)
3289
+ end
3290
+
3291
+ # Create a new property if the account has fewer than 20 properties. Web
3292
+ # properties are visible in the Google Analytics interface only if they have at
3293
+ # least one profile.
3294
+ # @param [String] account_id
3295
+ # Account ID to create the web property for.
3296
+ # @param [Google::Apis::AnalyticsV3::Webproperty] webproperty_object
3297
+ # @param [String] fields
3298
+ # Selector specifying which fields to include in a partial response.
3299
+ # @param [String] quota_user
3300
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3301
+ # characters.
3302
+ # @param [String] user_ip
3303
+ # Deprecated. Please use quotaUser instead.
3304
+ # @param [Google::Apis::RequestOptions] options
3305
+ # Request-specific options
3306
+ #
3307
+ # @yield [result, err] Result & error if block supplied
3308
+ # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object
3309
+ # @yieldparam err [StandardError] error object if request failed
3310
+ #
3311
+ # @return [Google::Apis::AnalyticsV3::Webproperty]
3312
+ #
3313
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3314
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3315
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3316
+ def insert_web_property(account_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3317
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties', options)
3318
+ command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3319
+ command.request_object = webproperty_object
3320
+ command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3321
+ command.response_class = Google::Apis::AnalyticsV3::Webproperty
3322
+ command.params['accountId'] = account_id unless account_id.nil?
3323
+ command.query['fields'] = fields unless fields.nil?
3324
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3325
+ command.query['userIp'] = user_ip unless user_ip.nil?
3326
+ execute_or_queue_command(command, &block)
3327
+ end
3328
+
3329
+ # Lists web properties to which the user has access.
3330
+ # @param [String] account_id
3331
+ # Account ID to retrieve web properties for. Can either be a specific account ID
3332
+ # or '~all', which refers to all the accounts that user has access to.
3333
+ # @param [Fixnum] max_results
3334
+ # The maximum number of web properties to include in this response.
3335
+ # @param [Fixnum] start_index
3336
+ # An index of the first entity to retrieve. Use this parameter as a pagination
3337
+ # mechanism along with the max-results parameter.
3338
+ # @param [String] fields
3339
+ # Selector specifying which fields to include in a partial response.
3340
+ # @param [String] quota_user
3341
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3342
+ # characters.
3343
+ # @param [String] user_ip
3344
+ # Deprecated. Please use quotaUser instead.
3345
+ # @param [Google::Apis::RequestOptions] options
3346
+ # Request-specific options
3347
+ #
3348
+ # @yield [result, err] Result & error if block supplied
3349
+ # @yieldparam result [Google::Apis::AnalyticsV3::Webproperties] parsed result object
3350
+ # @yieldparam err [StandardError] error object if request failed
3351
+ #
3352
+ # @return [Google::Apis::AnalyticsV3::Webproperties]
3353
+ #
3354
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3355
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3356
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3357
+ def list_web_properties(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3358
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties', options)
3359
+ command.response_representation = Google::Apis::AnalyticsV3::Webproperties::Representation
3360
+ command.response_class = Google::Apis::AnalyticsV3::Webproperties
3361
+ command.params['accountId'] = account_id unless account_id.nil?
3362
+ command.query['max-results'] = max_results unless max_results.nil?
3363
+ command.query['start-index'] = start_index unless start_index.nil?
3364
+ command.query['fields'] = fields unless fields.nil?
3365
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3366
+ command.query['userIp'] = user_ip unless user_ip.nil?
3367
+ execute_or_queue_command(command, &block)
3368
+ end
3369
+
3370
+ # Updates an existing web property. This method supports patch semantics.
3371
+ # @param [String] account_id
3372
+ # Account ID to which the web property belongs
3373
+ # @param [String] web_property_id
3374
+ # Web property ID
3375
+ # @param [Google::Apis::AnalyticsV3::Webproperty] webproperty_object
3376
+ # @param [String] fields
3377
+ # Selector specifying which fields to include in a partial response.
3378
+ # @param [String] quota_user
3379
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3380
+ # characters.
3381
+ # @param [String] user_ip
3382
+ # Deprecated. Please use quotaUser instead.
3383
+ # @param [Google::Apis::RequestOptions] options
3384
+ # Request-specific options
3385
+ #
3386
+ # @yield [result, err] Result & error if block supplied
3387
+ # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object
3388
+ # @yieldparam err [StandardError] error object if request failed
3389
+ #
3390
+ # @return [Google::Apis::AnalyticsV3::Webproperty]
3391
+ #
3392
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3393
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3394
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3395
+ def patch_web_property(account_id, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3396
+ command = make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options)
3397
+ command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3398
+ command.request_object = webproperty_object
3399
+ command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3400
+ command.response_class = Google::Apis::AnalyticsV3::Webproperty
3401
+ command.params['accountId'] = account_id unless account_id.nil?
3402
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3403
+ command.query['fields'] = fields unless fields.nil?
3404
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3405
+ command.query['userIp'] = user_ip unless user_ip.nil?
3406
+ execute_or_queue_command(command, &block)
3407
+ end
3408
+
3409
+ # Updates an existing web property.
3410
+ # @param [String] account_id
3411
+ # Account ID to which the web property belongs
3412
+ # @param [String] web_property_id
3413
+ # Web property ID
3414
+ # @param [Google::Apis::AnalyticsV3::Webproperty] webproperty_object
3415
+ # @param [String] fields
3416
+ # Selector specifying which fields to include in a partial response.
3417
+ # @param [String] quota_user
3418
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3419
+ # characters.
3420
+ # @param [String] user_ip
3421
+ # Deprecated. Please use quotaUser instead.
3422
+ # @param [Google::Apis::RequestOptions] options
3423
+ # Request-specific options
3424
+ #
3425
+ # @yield [result, err] Result & error if block supplied
3426
+ # @yieldparam result [Google::Apis::AnalyticsV3::Webproperty] parsed result object
3427
+ # @yieldparam err [StandardError] error object if request failed
3428
+ #
3429
+ # @return [Google::Apis::AnalyticsV3::Webproperty]
3430
+ #
3431
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3432
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3433
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3434
+ def update_web_property(account_id, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3435
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options)
3436
+ command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3437
+ command.request_object = webproperty_object
3438
+ command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
3439
+ command.response_class = Google::Apis::AnalyticsV3::Webproperty
3440
+ command.params['accountId'] = account_id unless account_id.nil?
3441
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3442
+ command.query['fields'] = fields unless fields.nil?
3443
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3444
+ command.query['userIp'] = user_ip unless user_ip.nil?
3445
+ execute_or_queue_command(command, &block)
3446
+ end
3447
+
3448
+ # Removes a user from the given web property.
3449
+ # @param [String] account_id
3450
+ # Account ID to delete the user link for.
3451
+ # @param [String] web_property_id
3452
+ # Web Property ID to delete the user link for.
3453
+ # @param [String] link_id
3454
+ # Link ID to delete the user link for.
3455
+ # @param [String] fields
3456
+ # Selector specifying which fields to include in a partial response.
3457
+ # @param [String] quota_user
3458
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3459
+ # characters.
3460
+ # @param [String] user_ip
3461
+ # Deprecated. Please use quotaUser instead.
3462
+ # @param [Google::Apis::RequestOptions] options
3463
+ # Request-specific options
3464
+ #
3465
+ # @yield [result, err] Result & error if block supplied
3466
+ # @yieldparam result [NilClass] No result returned for this method
3467
+ # @yieldparam err [StandardError] error object if request failed
3468
+ #
3469
+ # @return [void]
3470
+ #
3471
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3472
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3473
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3474
+ def delete_web_property_user_link(account_id, web_property_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3475
+ command = make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}', options)
3476
+ command.params['accountId'] = account_id unless account_id.nil?
3477
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3478
+ command.params['linkId'] = link_id unless link_id.nil?
3479
+ command.query['fields'] = fields unless fields.nil?
3480
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3481
+ command.query['userIp'] = user_ip unless user_ip.nil?
3482
+ execute_or_queue_command(command, &block)
3483
+ end
3484
+
3485
+ # Adds a new user to the given web property.
3486
+ # @param [String] account_id
3487
+ # Account ID to create the user link for.
3488
+ # @param [String] web_property_id
3489
+ # Web Property ID to create the user link for.
3490
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
3491
+ # @param [String] fields
3492
+ # Selector specifying which fields to include in a partial response.
3493
+ # @param [String] quota_user
3494
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3495
+ # characters.
3496
+ # @param [String] user_ip
3497
+ # Deprecated. Please use quotaUser instead.
3498
+ # @param [Google::Apis::RequestOptions] options
3499
+ # Request-specific options
3500
+ #
3501
+ # @yield [result, err] Result & error if block supplied
3502
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
3503
+ # @yieldparam err [StandardError] error object if request failed
3504
+ #
3505
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
3506
+ #
3507
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3508
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3509
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3510
+ def insert_web_property_user_link(account_id, web_property_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3511
+ command = make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks', options)
3512
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
3513
+ command.request_object = entity_user_link_object
3514
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
3515
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
3516
+ command.params['accountId'] = account_id unless account_id.nil?
3517
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3518
+ command.query['fields'] = fields unless fields.nil?
3519
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3520
+ command.query['userIp'] = user_ip unless user_ip.nil?
3521
+ execute_or_queue_command(command, &block)
3522
+ end
3523
+
3524
+ # Lists webProperty-user links for a given web property.
3525
+ # @param [String] account_id
3526
+ # Account ID which the given web property belongs to.
3527
+ # @param [String] web_property_id
3528
+ # Web Property ID for the webProperty-user links to retrieve. Can either be a
3529
+ # specific web property ID or '~all', which refers to all the web properties
3530
+ # that user has access to.
3531
+ # @param [Fixnum] max_results
3532
+ # The maximum number of webProperty-user Links to include in this response.
3533
+ # @param [Fixnum] start_index
3534
+ # An index of the first webProperty-user link to retrieve. Use this parameter as
3535
+ # a pagination mechanism along with the max-results parameter.
3536
+ # @param [String] fields
3537
+ # Selector specifying which fields to include in a partial response.
3538
+ # @param [String] quota_user
3539
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3540
+ # characters.
3541
+ # @param [String] user_ip
3542
+ # Deprecated. Please use quotaUser instead.
3543
+ # @param [Google::Apis::RequestOptions] options
3544
+ # Request-specific options
3545
+ #
3546
+ # @yield [result, err] Result & error if block supplied
3547
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLinks] parsed result object
3548
+ # @yieldparam err [StandardError] error object if request failed
3549
+ #
3550
+ # @return [Google::Apis::AnalyticsV3::EntityUserLinks]
3551
+ #
3552
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3553
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3554
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3555
+ def list_web_property_user_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3556
+ command = make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks', options)
3557
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation
3558
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks
3559
+ command.params['accountId'] = account_id unless account_id.nil?
3560
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3561
+ command.query['max-results'] = max_results unless max_results.nil?
3562
+ command.query['start-index'] = start_index unless start_index.nil?
3563
+ command.query['fields'] = fields unless fields.nil?
3564
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3565
+ command.query['userIp'] = user_ip unless user_ip.nil?
3566
+ execute_or_queue_command(command, &block)
3567
+ end
3568
+
3569
+ # Updates permissions for an existing user on the given web property.
3570
+ # @param [String] account_id
3571
+ # Account ID to update the account-user link for.
3572
+ # @param [String] web_property_id
3573
+ # Web property ID to update the account-user link for.
3574
+ # @param [String] link_id
3575
+ # Link ID to update the account-user link for.
3576
+ # @param [Google::Apis::AnalyticsV3::EntityUserLink] entity_user_link_object
3577
+ # @param [String] fields
3578
+ # Selector specifying which fields to include in a partial response.
3579
+ # @param [String] quota_user
3580
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3581
+ # characters.
3582
+ # @param [String] user_ip
3583
+ # Deprecated. Please use quotaUser instead.
3584
+ # @param [Google::Apis::RequestOptions] options
3585
+ # Request-specific options
3586
+ #
3587
+ # @yield [result, err] Result & error if block supplied
3588
+ # @yieldparam result [Google::Apis::AnalyticsV3::EntityUserLink] parsed result object
3589
+ # @yieldparam err [StandardError] error object if request failed
3590
+ #
3591
+ # @return [Google::Apis::AnalyticsV3::EntityUserLink]
3592
+ #
3593
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3594
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3595
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3596
+ def update_web_property_user_link(account_id, web_property_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3597
+ command = make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}', options)
3598
+ command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
3599
+ command.request_object = entity_user_link_object
3600
+ command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
3601
+ command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
3602
+ command.params['accountId'] = account_id unless account_id.nil?
3603
+ command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
3604
+ command.params['linkId'] = link_id unless link_id.nil?
3605
+ command.query['fields'] = fields unless fields.nil?
3606
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3607
+ command.query['userIp'] = user_ip unless user_ip.nil?
3608
+ execute_or_queue_command(command, &block)
3609
+ end
3610
+
3611
+ # Lists all columns for a report type
3612
+ # @param [String] report_type
3613
+ # Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core
3614
+ # Reporting API
3615
+ # @param [String] fields
3616
+ # Selector specifying which fields to include in a partial response.
3617
+ # @param [String] quota_user
3618
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3619
+ # characters.
3620
+ # @param [String] user_ip
3621
+ # Deprecated. Please use quotaUser instead.
3622
+ # @param [Google::Apis::RequestOptions] options
3623
+ # Request-specific options
3624
+ #
3625
+ # @yield [result, err] Result & error if block supplied
3626
+ # @yieldparam result [Google::Apis::AnalyticsV3::Columns] parsed result object
3627
+ # @yieldparam err [StandardError] error object if request failed
3628
+ #
3629
+ # @return [Google::Apis::AnalyticsV3::Columns]
3630
+ #
3631
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3632
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3633
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3634
+ def list_metadata_columns(report_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3635
+ command = make_simple_command(:get, 'metadata/{reportType}/columns', options)
3636
+ command.response_representation = Google::Apis::AnalyticsV3::Columns::Representation
3637
+ command.response_class = Google::Apis::AnalyticsV3::Columns
3638
+ command.params['reportType'] = report_type unless report_type.nil?
3639
+ command.query['fields'] = fields unless fields.nil?
3640
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3641
+ command.query['userIp'] = user_ip unless user_ip.nil?
3642
+ execute_or_queue_command(command, &block)
3643
+ end
3644
+
3645
+ # Creates an account ticket.
3646
+ # @param [Google::Apis::AnalyticsV3::AccountTicket] account_ticket_object
3647
+ # @param [String] fields
3648
+ # Selector specifying which fields to include in a partial response.
3649
+ # @param [String] quota_user
3650
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3651
+ # characters.
3652
+ # @param [String] user_ip
3653
+ # Deprecated. Please use quotaUser instead.
3654
+ # @param [Google::Apis::RequestOptions] options
3655
+ # Request-specific options
3656
+ #
3657
+ # @yield [result, err] Result & error if block supplied
3658
+ # @yieldparam result [Google::Apis::AnalyticsV3::AccountTicket] parsed result object
3659
+ # @yieldparam err [StandardError] error object if request failed
3660
+ #
3661
+ # @return [Google::Apis::AnalyticsV3::AccountTicket]
3662
+ #
3663
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3664
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3665
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3666
+ def create_account_ticket(account_ticket_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3667
+ command = make_simple_command(:post, 'provisioning/createAccountTicket', options)
3668
+ command.request_representation = Google::Apis::AnalyticsV3::AccountTicket::Representation
3669
+ command.request_object = account_ticket_object
3670
+ command.response_representation = Google::Apis::AnalyticsV3::AccountTicket::Representation
3671
+ command.response_class = Google::Apis::AnalyticsV3::AccountTicket
3672
+ command.query['fields'] = fields unless fields.nil?
3673
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3674
+ command.query['userIp'] = user_ip unless user_ip.nil?
3675
+ execute_or_queue_command(command, &block)
3676
+ end
3677
+
3678
+ # Provision account.
3679
+ # @param [Google::Apis::AnalyticsV3::AccountTreeRequest] account_tree_request_object
3680
+ # @param [String] fields
3681
+ # Selector specifying which fields to include in a partial response.
3682
+ # @param [String] quota_user
3683
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3684
+ # characters.
3685
+ # @param [String] user_ip
3686
+ # Deprecated. Please use quotaUser instead.
3687
+ # @param [Google::Apis::RequestOptions] options
3688
+ # Request-specific options
3689
+ #
3690
+ # @yield [result, err] Result & error if block supplied
3691
+ # @yieldparam result [Google::Apis::AnalyticsV3::AccountTreeResponse] parsed result object
3692
+ # @yieldparam err [StandardError] error object if request failed
3693
+ #
3694
+ # @return [Google::Apis::AnalyticsV3::AccountTreeResponse]
3695
+ #
3696
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3697
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3698
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3699
+ def create_provisioning_account_tree(account_tree_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3700
+ command = make_simple_command(:post, 'provisioning/createAccountTree', options)
3701
+ command.request_representation = Google::Apis::AnalyticsV3::AccountTreeRequest::Representation
3702
+ command.request_object = account_tree_request_object
3703
+ command.response_representation = Google::Apis::AnalyticsV3::AccountTreeResponse::Representation
3704
+ command.response_class = Google::Apis::AnalyticsV3::AccountTreeResponse
3705
+ command.query['fields'] = fields unless fields.nil?
3706
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3707
+ command.query['userIp'] = user_ip unless user_ip.nil?
3708
+ execute_or_queue_command(command, &block)
3709
+ end
3710
+
3711
+ # Insert or update a user deletion requests.
3712
+ # @param [Google::Apis::AnalyticsV3::UserDeletionRequest] user_deletion_request_object
3713
+ # @param [String] fields
3714
+ # Selector specifying which fields to include in a partial response.
3715
+ # @param [String] quota_user
3716
+ # An opaque string that represents a user for quota purposes. Must not exceed 40
3717
+ # characters.
3718
+ # @param [String] user_ip
3719
+ # Deprecated. Please use quotaUser instead.
3720
+ # @param [Google::Apis::RequestOptions] options
3721
+ # Request-specific options
3722
+ #
3723
+ # @yield [result, err] Result & error if block supplied
3724
+ # @yieldparam result [Google::Apis::AnalyticsV3::UserDeletionRequest] parsed result object
3725
+ # @yieldparam err [StandardError] error object if request failed
3726
+ #
3727
+ # @return [Google::Apis::AnalyticsV3::UserDeletionRequest]
3728
+ #
3729
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3730
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3731
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3732
+ def upsert_user_deletion_user_deletion_request(user_deletion_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3733
+ command = make_simple_command(:post, 'userDeletion/userDeletionRequests:upsert', options)
3734
+ command.request_representation = Google::Apis::AnalyticsV3::UserDeletionRequest::Representation
3735
+ command.request_object = user_deletion_request_object
3736
+ command.response_representation = Google::Apis::AnalyticsV3::UserDeletionRequest::Representation
3737
+ command.response_class = Google::Apis::AnalyticsV3::UserDeletionRequest
3738
+ command.query['fields'] = fields unless fields.nil?
3739
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3740
+ command.query['userIp'] = user_ip unless user_ip.nil?
3741
+ execute_or_queue_command(command, &block)
3742
+ end
3743
+
3744
+ protected
3745
+
3746
+ def apply_command_defaults(command)
3747
+ command.query['key'] = key unless key.nil?
3748
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3749
+ command.query['userIp'] = user_ip unless user_ip.nil?
3750
+ end
3751
+ end
3752
+ end
3753
+ end
3754
+ end