Class: Google::Apis::AnalyticsV3::AnalyticsService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/analytics_v3/service.rb

Overview

Google Analytics API

Views and manages your Google Analytics data.

Examples:

require 'google/apis/analytics_v3'

Analytics = Google::Apis::AnalyticsV3 # Alias the module
service = Analytics::AnalyticsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeAnalyticsService


49
50
51
52
# File 'generated/google/apis/analytics_v3/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'analytics/v3/')
  @batch_path = 'batch/analytics/v3'
end

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/analytics_v3/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/analytics_v3/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString


47
48
49
# File 'generated/google/apis/analytics_v3/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#create_account_ticket(account_ticket_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::AccountTicket

Creates an account ticket.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
# File 'generated/google/apis/analytics_v3/service.rb', line 3664

def ( = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'provisioning/createAccountTicket', options)
  command.request_representation = Google::Apis::AnalyticsV3::AccountTicket::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AnalyticsV3::AccountTicket::Representation
  command.response_class = Google::Apis::AnalyticsV3::AccountTicket
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#create_provisioning_account_tree(account_tree_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::AccountTreeResponse

Provision account.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
# File 'generated/google/apis/analytics_v3/service.rb', line 3697

def ( = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'provisioning/createAccountTree', options)
  command.request_representation = Google::Apis::AnalyticsV3::AccountTreeRequest::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AnalyticsV3::AccountTreeResponse::Representation
  command.response_class = Google::Apis::AnalyticsV3::AccountTreeResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

This method returns an undefined value.

Removes a user from the given account.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


319
320
321
322
323
324
325
326
327
# File 'generated/google/apis/analytics_v3/service.rb', line 319

def (, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/entityUserLinks/{linkId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['linkId'] = link_id unless link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_experiment(account_id, web_property_id, profile_id, experiment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete an experiment.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'generated/google/apis/analytics_v3/service.rb', line 1011

def delete_experiment(, web_property_id, profile_id, experiment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['experimentId'] = experiment_id unless experiment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_filter(account_id, filter_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Filter

Delete a filter.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
# File 'generated/google/apis/analytics_v3/service.rb', line 1267

def delete_filter(, filter_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/filters/{filterId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
  command.response_class = Google::Apis::AnalyticsV3::Filter
  command.params['accountId'] =  unless .nil?
  command.params['filterId'] = filter_id unless filter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Delete a remarketing audience.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
# File 'generated/google/apis/analytics_v3/service.rb', line 2405

def delete_management_remarketing_audience(, web_property_id, remarketing_audience_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_profile(account_id, web_property_id, profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a view (profile).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
# File 'generated/google/apis/analytics_v3/service.rb', line 2159

def delete_profile(, web_property_id, profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

This method returns an undefined value.

Delete a profile filter link.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'generated/google/apis/analytics_v3/service.rb', line 1721

def delete_profile_filter_link(, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['linkId'] = link_id unless link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

This method returns an undefined value.

Removes a user from the given view (profile).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
# File 'generated/google/apis/analytics_v3/service.rb', line 1984

def delete_profile_user_link(, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['linkId'] = link_id unless link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an unsampled report.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
# File 'generated/google/apis/analytics_v3/service.rb', line 2688

def delete_unsampled_report(, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['unsampledReportId'] = unsampled_report_id unless unsampled_report_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... }

This method returns an undefined value.

Delete data associated with a previous upload.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
# File 'generated/google/apis/analytics_v3/service.rb', line 2860

def delete_upload_data(, web_property_id, custom_data_source_id, delete_upload_data_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData', options)
  command.request_representation = Google::Apis::AnalyticsV3::DeleteUploadDataRequest::Representation
  command.request_object = delete_upload_data_request_object
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

This method returns an undefined value.

Deletes a web property-Google Ads link.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
# File 'generated/google/apis/analytics_v3/service.rb', line 3036

def delete_web_property_ad_words_link(, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

This method returns an undefined value.

Removes a user from the given web property.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'generated/google/apis/analytics_v3/service.rb', line 3472

def delete_web_property_user_link(, web_property_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}', options)
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['linkId'] = link_id unless link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_dimension(account_id, web_property_id, custom_dimension_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::CustomDimension

Get a custom dimension to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


583
584
585
586
587
588
589
590
591
592
593
594
# File 'generated/google/apis/analytics_v3/service.rb', line 583

def get_custom_dimension(, web_property_id, custom_dimension_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
  command.response_class = Google::Apis::AnalyticsV3::CustomDimension
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_custom_metric(account_id, web_property_id, custom_metric_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::CustomMetric

Get a custom metric to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


796
797
798
799
800
801
802
803
804
805
806
807
# File 'generated/google/apis/analytics_v3/service.rb', line 796

def get_custom_metric(, web_property_id, custom_metric_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
  command.response_class = Google::Apis::AnalyticsV3::CustomMetric
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['customMetricId'] = custom_metric_id unless custom_metric_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_experiment(account_id, web_property_id, profile_id, experiment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Experiment

Returns an experiment to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'generated/google/apis/analytics_v3/service.rb', line 1051

def get_experiment(, web_property_id, profile_id, experiment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
  command.response_class = Google::Apis::AnalyticsV3::Experiment
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['experimentId'] = experiment_id unless experiment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_filter(account_id, filter_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Filter

Returns a filters to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
# File 'generated/google/apis/analytics_v3/service.rb', line 1303

def get_filter(, filter_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/filters/{filterId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
  command.response_class = Google::Apis::AnalyticsV3::Filter
  command.params['accountId'] =  unless .nil?
  command.params['filterId'] = filter_id unless filter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::GaData

Returns Analytics data for a view (profile).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'generated/google/apis/analytics_v3/service.rb', line 110

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)
  command =  make_simple_command(:get, 'data/ga', options)
  command.response_representation = Google::Apis::AnalyticsV3::GaData::Representation
  command.response_class = Google::Apis::AnalyticsV3::GaData
  command.query['dimensions'] = dimensions unless dimensions.nil?
  command.query['end-date'] = end_date unless end_date.nil?
  command.query['filters'] = filters unless filters.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['include-empty-rows'] = include_empty_rows unless include_empty_rows.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['metrics'] = metrics unless metrics.nil?
  command.query['output'] = output unless output.nil?
  command.query['samplingLevel'] = sampling_level unless sampling_level.nil?
  command.query['segment'] = segment unless segment.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['start-date'] = start_date unless start_date.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_goal(account_id, web_property_id, profile_id, goal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Goal

Gets a goal to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
# File 'generated/google/apis/analytics_v3/service.rb', line 1497

def get_goal(, web_property_id, profile_id, goal_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
  command.response_class = Google::Apis::AnalyticsV3::Goal
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['goalId'] = goal_id unless goal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::RemarketingAudience

Gets a remarketing audience to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
# File 'generated/google/apis/analytics_v3/service.rb', line 2442

def get_management_remarketing_audience(, web_property_id, remarketing_audience_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
  command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::McfData

Returns Analytics Multi-Channel Funnels data for a view (profile).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# File 'generated/google/apis/analytics_v3/service.rb', line 184

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)
  command =  make_simple_command(:get, 'data/mcf', options)
  command.response_representation = Google::Apis::AnalyticsV3::McfData::Representation
  command.response_class = Google::Apis::AnalyticsV3::McfData
  command.query['dimensions'] = dimensions unless dimensions.nil?
  command.query['end-date'] = end_date unless end_date.nil?
  command.query['filters'] = filters unless filters.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['metrics'] = metrics unless metrics.nil?
  command.query['samplingLevel'] = sampling_level unless sampling_level.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['start-date'] = start_date unless start_date.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_profile(account_id, web_property_id, profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Profile

Gets a view (profile) to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
# File 'generated/google/apis/analytics_v3/service.rb', line 2196

def get_profile(, web_property_id, profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
  command.response_class = Google::Apis::AnalyticsV3::Profile
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Returns a single profile filter link.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
# File 'generated/google/apis/analytics_v3/service.rb', line 1761

def get_profile_filter_link(, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['linkId'] = link_id unless link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_realtime_data(ids, metrics, dimensions: nil, filters: nil, max_results: nil, sort: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::RealtimeData

Returns real time data for a view (profile).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'generated/google/apis/analytics_v3/service.rb', line 240

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)
  command =  make_simple_command(:get, 'data/realtime', options)
  command.response_representation = Google::Apis::AnalyticsV3::RealtimeData::Representation
  command.response_class = Google::Apis::AnalyticsV3::RealtimeData
  command.query['dimensions'] = dimensions unless dimensions.nil?
  command.query['filters'] = filters unless filters.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['metrics'] = metrics unless metrics.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::UnsampledReport

Returns a single unsampled report.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
# File 'generated/google/apis/analytics_v3/service.rb', line 2728

def get_unsampled_report(, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation
  command.response_class = Google::Apis::AnalyticsV3::UnsampledReport
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['unsampledReportId'] = unsampled_report_id unless unsampled_report_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_upload(account_id, web_property_id, custom_data_source_id, upload_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Upload

List uploads to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
# File 'generated/google/apis/analytics_v3/service.rb', line 2901

def get_upload(, web_property_id, custom_data_source_id, upload_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::Upload::Representation
  command.response_class = Google::Apis::AnalyticsV3::Upload
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
  command.params['uploadId'] = upload_id unless upload_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_web_property(account_id, web_property_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Webproperty

Gets a web property to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
# File 'generated/google/apis/analytics_v3/service.rb', line 3277

def get_web_property(, web_property_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
  command.response_class = Google::Apis::AnalyticsV3::Webproperty
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Returns a web property-Google Ads link to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
# File 'generated/google/apis/analytics_v3/service.rb', line 3073

def get_web_property_ad_words_link(, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
  command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#hash_client_id(hash_client_id_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::HashClientIdResponse

Hashes the given Client ID.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


502
503
504
505
506
507
508
509
510
511
512
# File 'generated/google/apis/analytics_v3/service.rb', line 502

def hash_client_id(hash_client_id_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/clientId:hashClientId', options)
  command.request_representation = Google::Apis::AnalyticsV3::HashClientIdRequest::Representation
  command.request_object = hash_client_id_request_object
  command.response_representation = Google::Apis::AnalyticsV3::HashClientIdResponse::Representation
  command.response_class = Google::Apis::AnalyticsV3::HashClientIdResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Adds a new user to the given account.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


352
353
354
355
356
357
358
359
360
361
362
363
# File 'generated/google/apis/analytics_v3/service.rb', line 352

def (, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/entityUserLinks', options)
  command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.request_object = entity_user_link_object
  command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_custom_dimension(account_id, web_property_id, custom_dimension_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::CustomDimension

Create a new custom dimension.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


621
622
623
624
625
626
627
628
629
630
631
632
633
# File 'generated/google/apis/analytics_v3/service.rb', line 621

def insert_custom_dimension(, web_property_id, custom_dimension_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions', options)
  command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
  command.request_object = custom_dimension_object
  command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
  command.response_class = Google::Apis::AnalyticsV3::CustomDimension
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_custom_metric(account_id, web_property_id, custom_metric_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::CustomMetric

Create a new custom metric.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


834
835
836
837
838
839
840
841
842
843
844
845
846
# File 'generated/google/apis/analytics_v3/service.rb', line 834

def insert_custom_metric(, web_property_id, custom_metric_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics', options)
  command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
  command.request_object = custom_metric_object
  command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
  command.response_class = Google::Apis::AnalyticsV3::CustomMetric
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_experiment(account_id, web_property_id, profile_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Experiment

Create a new experiment.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
# File 'generated/google/apis/analytics_v3/service.rb', line 1092

def insert_experiment(, web_property_id, profile_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments', options)
  command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation
  command.request_object = experiment_object
  command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
  command.response_class = Google::Apis::AnalyticsV3::Experiment
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_filter(account_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Filter

Create a new filter.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
# File 'generated/google/apis/analytics_v3/service.rb', line 1338

def insert_filter(, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/filters', options)
  command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation
  command.request_object = filter_object
  command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
  command.response_class = Google::Apis::AnalyticsV3::Filter
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_goal(account_id, web_property_id, profile_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Goal

Create a new goal.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
# File 'generated/google/apis/analytics_v3/service.rb', line 1538

def insert_goal(, web_property_id, profile_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals', options)
  command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation
  command.request_object = goal_object
  command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
  command.response_class = Google::Apis::AnalyticsV3::Goal
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_management_remarketing_audience(account_id, web_property_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::RemarketingAudience

Creates a new remarketing audience.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
# File 'generated/google/apis/analytics_v3/service.rb', line 2480

def insert_management_remarketing_audience(, web_property_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences', options)
  command.request_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
  command.request_object = remarketing_audience_object
  command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
  command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_profile(account_id, web_property_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Profile

Create a new view (profile).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
# File 'generated/google/apis/analytics_v3/service.rb', line 2234

def insert_profile(, web_property_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles', options)
  command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation
  command.request_object = profile_object
  command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
  command.response_class = Google::Apis::AnalyticsV3::Profile
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Create a new profile filter link.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'generated/google/apis/analytics_v3/service.rb', line 1802

def insert_profile_filter_link(, web_property_id, profile_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks', options)
  command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
  command.request_object = profile_filter_link_object
  command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Adds a new user to the given view (profile).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'generated/google/apis/analytics_v3/service.rb', line 2023

def insert_profile_user_link(, web_property_id, profile_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks', options)
  command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.request_object = entity_user_link_object
  command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::UnsampledReport

Create a new unsampled report.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
# File 'generated/google/apis/analytics_v3/service.rb', line 2769

def insert_unsampled_report(, web_property_id, profile_id, unsampled_report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports', options)
  command.request_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation
  command.request_object = unsampled_report_object
  command.response_representation = Google::Apis::AnalyticsV3::UnsampledReport::Representation
  command.response_class = Google::Apis::AnalyticsV3::UnsampledReport
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_web_property(account_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Webproperty

Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
# File 'generated/google/apis/analytics_v3/service.rb', line 3314

def insert_web_property(, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties', options)
  command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
  command.request_object = webproperty_object
  command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
  command.response_class = Google::Apis::AnalyticsV3::Webproperty
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Creates a webProperty-Google Ads link.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
# File 'generated/google/apis/analytics_v3/service.rb', line 3111

def insert_web_property_ad_words_link(, web_property_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks', options)
  command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
  command.request_object = entity_ad_words_link_object
  command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Adds a new user to the given web property.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
# File 'generated/google/apis/analytics_v3/service.rb', line 3508

def insert_web_property_user_link(, web_property_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks', options)
  command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.request_object = entity_user_link_object
  command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_account_summaries(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::AccountSummaries

Lists account summaries (lightweight tree comprised of accounts/properties/ profiles) to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


283
284
285
286
287
288
289
290
291
292
293
# File 'generated/google/apis/analytics_v3/service.rb', line 283

def (max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accountSummaries', options)
  command.response_representation = Google::Apis::AnalyticsV3::AccountSummaries::Representation
  command.response_class = Google::Apis::AnalyticsV3::AccountSummaries
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Lists account-user links for a given account.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


392
393
394
395
396
397
398
399
400
401
402
403
# File 'generated/google/apis/analytics_v3/service.rb', line 392

def (, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/entityUserLinks', options)
  command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks
  command.params['accountId'] =  unless .nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_accounts(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Accounts

Lists all accounts to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


469
470
471
472
473
474
475
476
477
478
479
# File 'generated/google/apis/analytics_v3/service.rb', line 469

def list_accounts(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts', options)
  command.response_representation = Google::Apis::AnalyticsV3::Accounts::Representation
  command.response_class = Google::Apis::AnalyticsV3::Accounts
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::CustomDataSources

List custom data sources to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


543
544
545
546
547
548
549
550
551
552
553
554
555
# File 'generated/google/apis/analytics_v3/service.rb', line 543

def list_custom_data_sources(, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources', options)
  command.response_representation = Google::Apis::AnalyticsV3::CustomDataSources::Representation
  command.response_class = Google::Apis::AnalyticsV3::CustomDataSources
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_dimensions(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::CustomDimensions

Lists custom dimensions to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


664
665
666
667
668
669
670
671
672
673
674
675
676
# File 'generated/google/apis/analytics_v3/service.rb', line 664

def list_custom_dimensions(, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions', options)
  command.response_representation = Google::Apis::AnalyticsV3::CustomDimensions::Representation
  command.response_class = Google::Apis::AnalyticsV3::CustomDimensions
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_custom_metrics(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::CustomMetrics

Lists custom metrics to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


877
878
879
880
881
882
883
884
885
886
887
888
889
# File 'generated/google/apis/analytics_v3/service.rb', line 877

def list_custom_metrics(, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics', options)
  command.response_representation = Google::Apis::AnalyticsV3::CustomMetrics::Representation
  command.response_class = Google::Apis::AnalyticsV3::CustomMetrics
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Experiments

Lists experiments to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
# File 'generated/google/apis/analytics_v3/service.rb', line 1138

def list_experiments(, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments', options)
  command.response_representation = Google::Apis::AnalyticsV3::Experiments::Representation
  command.response_class = Google::Apis::AnalyticsV3::Experiments
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_filters(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Filters

Lists all filters for an account

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
# File 'generated/google/apis/analytics_v3/service.rb', line 1378

def list_filters(, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/filters', options)
  command.response_representation = Google::Apis::AnalyticsV3::Filters::Representation
  command.response_class = Google::Apis::AnalyticsV3::Filters
  command.params['accountId'] =  unless .nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Goals

Lists goals to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
# File 'generated/google/apis/analytics_v3/service.rb', line 1588

def list_goals(, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals', options)
  command.response_representation = Google::Apis::AnalyticsV3::Goals::Representation
  command.response_class = Google::Apis::AnalyticsV3::Goals
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::RemarketingAudiences

Lists remarketing audiences to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
# File 'generated/google/apis/analytics_v3/service.rb', line 2524

def list_management_remarketing_audiences(, web_property_id, max_results: nil, start_index: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences', options)
  command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudiences::Representation
  command.response_class = Google::Apis::AnalyticsV3::RemarketingAudiences
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_metadata_columns(report_type, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Columns

Lists all columns for a report type

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
# File 'generated/google/apis/analytics_v3/service.rb', line 3632

def (report_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'metadata/{reportType}/columns', options)
  command.response_representation = Google::Apis::AnalyticsV3::Columns::Representation
  command.response_class = Google::Apis::AnalyticsV3::Columns
  command.params['reportType'] = report_type unless report_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Lists all profile filter links for a profile.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'generated/google/apis/analytics_v3/service.rb', line 1851

def list_profile_filter_links(, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks', options)
  command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLinks::Representation
  command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLinks
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Lists profile-user links for a given view (profile).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
# File 'generated/google/apis/analytics_v3/service.rb', line 2073

def list_profile_user_links(, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks', options)
  command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_profiles(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Profiles

Lists views (profiles) to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
# File 'generated/google/apis/analytics_v3/service.rb', line 2281

def list_profiles(, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles', options)
  command.response_representation = Google::Apis::AnalyticsV3::Profiles::Representation
  command.response_class = Google::Apis::AnalyticsV3::Profiles
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_segments(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Segments

Lists segments to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
# File 'generated/google/apis/analytics_v3/service.rb', line 2648

def list_segments(max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/segments', options)
  command.response_representation = Google::Apis::AnalyticsV3::Segments::Representation
  command.response_class = Google::Apis::AnalyticsV3::Segments
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::UnsampledReports

Lists unsampled reports to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
# File 'generated/google/apis/analytics_v3/service.rb', line 2818

def list_unsampled_reports(, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports', options)
  command.response_representation = Google::Apis::AnalyticsV3::UnsampledReports::Representation
  command.response_class = Google::Apis::AnalyticsV3::UnsampledReports
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Uploads

List uploads to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
# File 'generated/google/apis/analytics_v3/service.rb', line 2946

def list_uploads(, web_property_id, custom_data_source_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options)
  command.response_representation = Google::Apis::AnalyticsV3::Uploads::Representation
  command.response_class = Google::Apis::AnalyticsV3::Uploads
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_web_properties(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Webproperties

Lists web properties to which the user has access.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
# File 'generated/google/apis/analytics_v3/service.rb', line 3355

def list_web_properties(, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties', options)
  command.response_representation = Google::Apis::AnalyticsV3::Webproperties::Representation
  command.response_class = Google::Apis::AnalyticsV3::Webproperties
  command.params['accountId'] =  unless .nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Lists webProperty-Google Ads links for a given web property.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
# File 'generated/google/apis/analytics_v3/service.rb', line 3154

def list_web_property_ad_words_links(, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks', options)
  command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLinks::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLinks
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Lists webProperty-user links for a given web property.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
# File 'generated/google/apis/analytics_v3/service.rb', line 3553

def list_web_property_user_links(, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks', options)
  command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::CustomDimension

Updates an existing custom dimension. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
# File 'generated/google/apis/analytics_v3/service.rb', line 708

def patch_custom_dimension(, 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)
  command =  make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
  command.request_object = custom_dimension_object
  command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
  command.response_class = Google::Apis::AnalyticsV3::CustomDimension
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_id.nil?
  command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::CustomMetric

Updates an existing custom metric. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
# File 'generated/google/apis/analytics_v3/service.rb', line 921

def patch_custom_metric(, 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)
  command =  make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
  command.request_object = custom_metric_object
  command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
  command.response_class = Google::Apis::AnalyticsV3::CustomMetric
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['customMetricId'] = custom_metric_id unless custom_metric_id.nil?
  command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_experiment(account_id, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Experiment

Update an existing experiment. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
# File 'generated/google/apis/analytics_v3/service.rb', line 1182

def patch_experiment(, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation
  command.request_object = experiment_object
  command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
  command.response_class = Google::Apis::AnalyticsV3::Experiment
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['experimentId'] = experiment_id unless experiment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_filter(account_id, filter_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Filter

Updates an existing filter. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
# File 'generated/google/apis/analytics_v3/service.rb', line 1416

def patch_filter(, filter_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'management/accounts/{accountId}/filters/{filterId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation
  command.request_object = filter_object
  command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
  command.response_class = Google::Apis::AnalyticsV3::Filter
  command.params['accountId'] =  unless .nil?
  command.params['filterId'] = filter_id unless filter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_goal(account_id, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Goal

Updates an existing goal. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
# File 'generated/google/apis/analytics_v3/service.rb', line 1632

def patch_goal(, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation
  command.request_object = goal_object
  command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
  command.response_class = Google::Apis::AnalyticsV3::Goal
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['goalId'] = goal_id unless goal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::RemarketingAudience

Updates an existing remarketing audience. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
# File 'generated/google/apis/analytics_v3/service.rb', line 2566

def patch_management_remarketing_audience(, web_property_id, remarketing_audience_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
  command.request_object = remarketing_audience_object
  command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
  command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_profile(account_id, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Profile

Updates an existing view (profile). This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
# File 'generated/google/apis/analytics_v3/service.rb', line 2322

def patch_profile(, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation
  command.request_object = profile_object
  command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
  command.response_class = Google::Apis::AnalyticsV3::Profile
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Update an existing profile filter link. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
# File 'generated/google/apis/analytics_v3/service.rb', line 1895

def patch_profile_filter_link(, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
  command.request_object = profile_filter_link_object
  command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['linkId'] = link_id unless link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_web_property(account_id, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Webproperty

Updates an existing web property. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
# File 'generated/google/apis/analytics_v3/service.rb', line 3393

def patch_web_property(, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
  command.request_object = webproperty_object
  command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
  command.response_class = Google::Apis::AnalyticsV3::Webproperty
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Updates an existing webProperty-Google Ads link. This method supports patch semantics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'generated/google/apis/analytics_v3/service.rb', line 3196

def patch_web_property_ad_words_link(, 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)
  command =  make_simple_command(:patch, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
  command.request_object = entity_ad_words_link_object
  command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Updates permissions for an existing user on the given account.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


430
431
432
433
434
435
436
437
438
439
440
441
442
# File 'generated/google/apis/analytics_v3/service.rb', line 430

def (, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/entityUserLinks/{linkId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.request_object = entity_user_link_object
  command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
  command.params['accountId'] =  unless .nil?
  command.params['linkId'] = link_id unless link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::CustomDimension

Updates an existing custom dimension.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
# File 'generated/google/apis/analytics_v3/service.rb', line 754

def update_custom_dimension(, 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)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
  command.request_object = custom_dimension_object
  command.response_representation = Google::Apis::AnalyticsV3::CustomDimension::Representation
  command.response_class = Google::Apis::AnalyticsV3::CustomDimension
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['customDimensionId'] = custom_dimension_id unless custom_dimension_id.nil?
  command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::CustomMetric

Updates an existing custom metric.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
# File 'generated/google/apis/analytics_v3/service.rb', line 967

def update_custom_metric(, 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)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
  command.request_object = custom_metric_object
  command.response_representation = Google::Apis::AnalyticsV3::CustomMetric::Representation
  command.response_class = Google::Apis::AnalyticsV3::CustomMetric
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['customMetricId'] = custom_metric_id unless custom_metric_id.nil?
  command.query['ignoreCustomDataSourceLinks'] = ignore_custom_data_source_links unless ignore_custom_data_source_links.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_experiment(account_id, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Experiment

Update an existing experiment.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
# File 'generated/google/apis/analytics_v3/service.rb', line 1227

def update_experiment(, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Experiment::Representation
  command.request_object = experiment_object
  command.response_representation = Google::Apis::AnalyticsV3::Experiment::Representation
  command.response_class = Google::Apis::AnalyticsV3::Experiment
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['experimentId'] = experiment_id unless experiment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_filter(account_id, filter_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Filter

Updates an existing filter.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'generated/google/apis/analytics_v3/service.rb', line 1455

def update_filter(, filter_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/filters/{filterId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Filter::Representation
  command.request_object = filter_object
  command.response_representation = Google::Apis::AnalyticsV3::Filter::Representation
  command.response_class = Google::Apis::AnalyticsV3::Filter
  command.params['accountId'] =  unless .nil?
  command.params['filterId'] = filter_id unless filter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_goal(account_id, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Goal

Updates an existing goal.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
# File 'generated/google/apis/analytics_v3/service.rb', line 1677

def update_goal(, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Goal::Representation
  command.request_object = goal_object
  command.response_representation = Google::Apis::AnalyticsV3::Goal::Representation
  command.response_class = Google::Apis::AnalyticsV3::Goal
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['goalId'] = goal_id unless goal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::RemarketingAudience

Updates an existing remarketing audience.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
# File 'generated/google/apis/analytics_v3/service.rb', line 2608

def update_management_remarketing_audience(, web_property_id, remarketing_audience_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
  command.request_object = remarketing_audience_object
  command.response_representation = Google::Apis::AnalyticsV3::RemarketingAudience::Representation
  command.response_class = Google::Apis::AnalyticsV3::RemarketingAudience
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['remarketingAudienceId'] = remarketing_audience_id unless remarketing_audience_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_profile(account_id, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Profile

Updates an existing view (profile).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
# File 'generated/google/apis/analytics_v3/service.rb', line 2364

def update_profile(, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation
  command.request_object = profile_object
  command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
  command.response_class = Google::Apis::AnalyticsV3::Profile
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Update an existing profile filter link.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
# File 'generated/google/apis/analytics_v3/service.rb', line 1940

def update_profile_filter_link(, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
  command.request_object = profile_filter_link_object
  command.response_representation = Google::Apis::AnalyticsV3::ProfileFilterLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::ProfileFilterLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['linkId'] = link_id unless link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Updates permissions for an existing user on the given view (profile).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
# File 'generated/google/apis/analytics_v3/service.rb', line 2117

def update_profile_user_link(, web_property_id, profile_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.request_object = entity_user_link_object
  command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['profileId'] = profile_id unless profile_id.nil?
  command.params['linkId'] = link_id unless link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_web_property(account_id, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Webproperty

Updates an existing web property.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
# File 'generated/google/apis/analytics_v3/service.rb', line 3432

def update_web_property(, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
  command.request_object = webproperty_object
  command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
  command.response_class = Google::Apis::AnalyticsV3::Webproperty
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Updates an existing webProperty-Google Ads link.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
# File 'generated/google/apis/analytics_v3/service.rb', line 3238

def update_web_property_ad_words_link(, 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)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
  command.request_object = entity_ad_words_link_object
  command.response_representation = Google::Apis::AnalyticsV3::EntityAdWordsLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityAdWordsLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Updates permissions for an existing user on the given web property.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
# File 'generated/google/apis/analytics_v3/service.rb', line 3594

def update_web_property_user_link(, web_property_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.request_object = entity_user_link_object
  command.response_representation = Google::Apis::AnalyticsV3::EntityUserLink::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityUserLink
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['linkId'] = link_id unless link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Upload

Upload data for a custom data source.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
# File 'generated/google/apis/analytics_v3/service.rb', line 2991

def upload_data(, web_property_id, custom_data_source_id, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options)
  else
    command = make_upload_command(:post, 'management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.response_representation = Google::Apis::AnalyticsV3::Upload::Representation
  command.response_class = Google::Apis::AnalyticsV3::Upload
  command.params['accountId'] =  unless .nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['customDataSourceId'] = custom_data_source_id unless custom_data_source_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#upsert_user_deletion_user_deletion_request(user_deletion_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::UserDeletionRequest

Insert or update a user deletion requests.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
# File 'generated/google/apis/analytics_v3/service.rb', line 3730

def upsert_user_deletion_user_deletion_request(user_deletion_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'userDeletion/userDeletionRequests:upsert', options)
  command.request_representation = Google::Apis::AnalyticsV3::UserDeletionRequest::Representation
  command.request_object = user_deletion_request_object
  command.response_representation = Google::Apis::AnalyticsV3::UserDeletionRequest::Representation
  command.response_class = Google::Apis::AnalyticsV3::UserDeletionRequest
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end