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

Constructor Details

#initializeAnalyticsService

Returns a new instance of AnalyticsService.


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

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

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


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

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.


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

def quota_user
  @quota_user
end

#user_ipString

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.


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

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.

Parameters:

  • account_ticket_object (Google::Apis::AnalyticsV3::AccountTicket) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
# File 'generated/google/apis/analytics_v3/service.rb', line 3763

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

This method returns an undefined value.

Removes a user from the given account.

Parameters:

  • account_id (String)

    Account ID to delete the user link for.

  • link_id (String)

    Link ID to delete the user link for.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

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:


330
331
332
333
334
335
336
337
338
# File 'generated/google/apis/analytics_v3/service.rb', line 330

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.

Parameters:

  • account_id (String)

    Account ID to which the experiment belongs

  • web_property_id (String)

    Web property ID to which the experiment belongs

  • profile_id (String)

    View (Profile) ID to which the experiment belongs

  • experiment_id (String)

    ID of the experiment to delete

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

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:


1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'generated/google/apis/analytics_v3/service.rb', line 1021

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.

Parameters:

  • account_id (String)

    Account ID to delete the filter for.

  • filter_id (String)

    ID of the filter to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
# File 'generated/google/apis/analytics_v3/service.rb', line 1289

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_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).

Parameters:

  • account_id (String)

    Account ID to delete the view (profile) for.

  • web_property_id (String)

    Web property ID to delete the view (profile) for.

  • profile_id (String)

    ID of the view (profile) to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

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:


2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
# File 'generated/google/apis/analytics_v3/service.rb', line 2223

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.

Parameters:

  • account_id (String)

    Account ID to which the profile filter link belongs.

  • web_property_id (String)

    Web property Id to which the profile filter link belongs.

  • profile_id (String)

    Profile ID to which the filter link belongs.

  • link_id (String)

    ID of the profile filter link to delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

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:


1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
# File 'generated/google/apis/analytics_v3/service.rb', line 1765

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).

Parameters:

  • account_id (String)

    Account ID to delete the user link for.

  • web_property_id (String)

    Web Property ID to delete the user link for.

  • profile_id (String)

    View (Profile) ID to delete the user link for.

  • link_id (String)

    Link ID to delete the user link for.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

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:


2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
# File 'generated/google/apis/analytics_v3/service.rb', line 2040

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.

Parameters:

  • account_id (String)

    Account ID to delete the unsampled report for.

  • web_property_id (String)

    Web property ID to delete the unsampled reports for.

  • profile_id (String)

    View (Profile) ID to delete the unsampled report for.

  • unsampled_report_id (String)

    ID of the unsampled report to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

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:


2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
# File 'generated/google/apis/analytics_v3/service.rb', line 2739

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.

Parameters:

  • account_id (String)

    Account Id for the uploads to be deleted.

  • web_property_id (String)

    Web property Id for the uploads to be deleted.

  • custom_data_source_id (String)

    Custom data source Id for the uploads to be deleted.

  • delete_upload_data_request_object (Google::Apis::AnalyticsV3::DeleteUploadDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

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:


2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
# File 'generated/google/apis/analytics_v3/service.rb', line 2919

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-AdWords link.

Parameters:

  • account_id (String)

    ID of the account which the given web property belongs to.

  • web_property_id (String)

    Web property ID to delete the AdWords link for.

  • web_property_ad_words_link_id (String)

    Web property AdWords link ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

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:


3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
# File 'generated/google/apis/analytics_v3/service.rb', line 3103

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.

Parameters:

  • account_id (String)

    Account ID to delete the user link for.

  • web_property_id (String)

    Web Property ID to delete the user link for.

  • link_id (String)

    Link ID to delete the user link for.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

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:


3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
# File 'generated/google/apis/analytics_v3/service.rb', line 3561

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.

Parameters:

  • account_id (String)

    Account ID for the custom dimension to retrieve.

  • web_property_id (String)

    Web property ID for the custom dimension to retrieve.

  • custom_dimension_id (String)

    The ID of the custom dimension to retrieve.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


573
574
575
576
577
578
579
580
581
582
583
584
# File 'generated/google/apis/analytics_v3/service.rb', line 573

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.

Parameters:

  • account_id (String)

    Account ID for the custom metric to retrieve.

  • web_property_id (String)

    Web property ID for the custom metric to retrieve.

  • custom_metric_id (String)

    The ID of the custom metric to retrieve.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

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.

Parameters:

  • account_id (String)

    Account ID to retrieve the experiment for.

  • web_property_id (String)

    Web property ID to retrieve the experiment for.

  • profile_id (String)

    View (Profile) ID to retrieve the experiment for.

  • experiment_id (String)

    Experiment ID to retrieve the experiment for.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
# File 'generated/google/apis/analytics_v3/service.rb', line 1063

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.

Parameters:

  • account_id (String)

    Account ID to retrieve filters for.

  • filter_id (String)

    Filter ID to retrieve filters for.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
# File 'generated/google/apis/analytics_v3/service.rb', line 1327

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).

Parameters:

  • ids (String)

    Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.

  • start_date (String)

    Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.

  • end_date (String)

    End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.

  • metrics (String)

    A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.

  • dimensions (String) (defaults to: nil)

    A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.

  • filters (String) (defaults to: nil)

    A comma-separated list of dimension or metric filters to be applied to Analytics data.

  • include_empty_rows (Boolean) (defaults to: nil)

    The response will include empty rows if this parameter is set to true, the default is true

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of entries to include in this feed.

  • output (String) (defaults to: nil)

    The selected format for the response. Default format is JSON.

  • sampling_level (String) (defaults to: nil)

    The desired sampling level.

  • segment (String) (defaults to: nil)

    An Analytics segment to be applied to data.

  • sort (String) (defaults to: nil)

    A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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.

Parameters:

  • account_id (String)

    Account ID to retrieve the goal for.

  • web_property_id (String)

    Web property ID to retrieve the goal for.

  • profile_id (String)

    View (Profile) ID to retrieve the goal for.

  • goal_id (String)

    Goal ID to retrieve the goal for.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'generated/google/apis/analytics_v3/service.rb', line 1531

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.

Parameters:

  • account_id (String)

    The account ID of the remarketing audience to retrieve.

  • web_property_id (String)

    The web property ID of the remarketing audience to retrieve.

  • remarketing_audience_id (String)

    The ID of the remarketing audience to retrieve.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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).

Parameters:

  • ids (String)

    Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.

  • start_date (String)

    Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.

  • end_date (String)

    End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.

  • metrics (String)

    A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf: totalConversions,mcf:totalConversionValue'. At least one metric must be specified.

  • dimensions (String) (defaults to: nil)

    A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source, mcf:medium'.

  • filters (String) (defaults to: nil)

    A comma-separated list of dimension or metric filters to be applied to the Analytics data.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of entries to include in this feed.

  • sampling_level (String) (defaults to: nil)

    The desired sampling level.

  • sort (String) (defaults to: nil)

    A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'generated/google/apis/analytics_v3/service.rb', line 189

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.

Parameters:

  • account_id (String)

    Account ID to retrieve the view (profile) for.

  • web_property_id (String)

    Web property ID to retrieve the view (profile) for.

  • profile_id (String)

    View (Profile) ID to retrieve the view (profile) for.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
# File 'generated/google/apis/analytics_v3/service.rb', line 2262

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.

Parameters:

  • account_id (String)

    Account ID to retrieve profile filter link for.

  • web_property_id (String)

    Web property Id to retrieve profile filter link for.

  • profile_id (String)

    Profile ID to retrieve filter link for.

  • link_id (String)

    ID of the profile filter link.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
# File 'generated/google/apis/analytics_v3/service.rb', line 1807

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).

Parameters:

  • ids (String)

    Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.

  • metrics (String)

    A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.

  • dimensions (String) (defaults to: nil)

    A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.

  • filters (String) (defaults to: nil)

    A comma-separated list of dimension or metric filters to be applied to real time data.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of entries to include in this feed.

  • sort (String) (defaults to: nil)

    A comma-separated list of dimensions or metrics that determine the sort order for real time data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'generated/google/apis/analytics_v3/service.rb', line 247

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.

Parameters:

  • account_id (String)

    Account ID to retrieve unsampled report for.

  • web_property_id (String)

    Web property ID to retrieve unsampled reports for.

  • profile_id (String)

    View (Profile) ID to retrieve unsampled report for.

  • unsampled_report_id (String)

    ID of the unsampled report to retrieve.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
# File 'generated/google/apis/analytics_v3/service.rb', line 2781

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.

Parameters:

  • account_id (String)

    Account Id for the upload to retrieve.

  • web_property_id (String)

    Web property Id for the upload to retrieve.

  • custom_data_source_id (String)

    Custom data source Id for upload to retrieve.

  • upload_id (String)

    Upload Id to retrieve.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
# File 'generated/google/apis/analytics_v3/service.rb', line 2962

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.

Parameters:

  • account_id (String)

    Account ID to retrieve the web property for.

  • web_property_id (String)

    ID to retrieve the web property for.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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-AdWords link to which the user has access.

Parameters:

  • account_id (String)

    ID of the account which the given web property belongs to.

  • web_property_id (String)

    Web property ID to retrieve the AdWords link for.

  • web_property_ad_words_link_id (String)

    Web property-AdWords link ID.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
# File 'generated/google/apis/analytics_v3/service.rb', line 3142

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

Adds a new user to the given account.

Parameters:

  • account_id (String)

    Account ID to create the user link for.

  • entity_user_link_object (Google::Apis::AnalyticsV3::EntityUserLink) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


365
366
367
368
369
370
371
372
373
374
375
376
# File 'generated/google/apis/analytics_v3/service.rb', line 365

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.

Parameters:

  • account_id (String)

    Account ID for the custom dimension to create.

  • web_property_id (String)

    Web property ID for the custom dimension to create.

  • custom_dimension_object (Google::Apis::AnalyticsV3::CustomDimension) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


613
614
615
616
617
618
619
620
621
622
623
624
625
# File 'generated/google/apis/analytics_v3/service.rb', line 613

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.

Parameters:

  • account_id (String)

    Account ID for the custom metric to create.

  • web_property_id (String)

    Web property ID for the custom dimension to create.

  • custom_metric_object (Google::Apis::AnalyticsV3::CustomMetric) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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.

Parameters:

  • account_id (String)

    Account ID to create the experiment for.

  • web_property_id (String)

    Web property ID to create the experiment for.

  • profile_id (String)

    View (Profile) ID to create the experiment for.

  • experiment_object (Google::Apis::AnalyticsV3::Experiment) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
# File 'generated/google/apis/analytics_v3/service.rb', line 1106

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.

Parameters:

  • account_id (String)

    Account ID to create filter for.

  • filter_object (Google::Apis::AnalyticsV3::Filter) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
# File 'generated/google/apis/analytics_v3/service.rb', line 1364

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.

Parameters:

  • account_id (String)

    Account ID to create the goal for.

  • web_property_id (String)

    Web property ID to create the goal for.

  • profile_id (String)

    View (Profile) ID to create the goal for.

  • goal_object (Google::Apis::AnalyticsV3::Goal) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
# File 'generated/google/apis/analytics_v3/service.rb', line 1574

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.

Parameters:

  • account_id (String)

    The account ID for which to create the remarketing audience.

  • web_property_id (String)

    Web property ID for which to create the remarketing audience.

  • remarketing_audience_object (Google::Apis::AnalyticsV3::RemarketingAudience) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
# File 'generated/google/apis/analytics_v3/service.rb', line 2521

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).

Parameters:

  • account_id (String)

    Account ID to create the view (profile) for.

  • web_property_id (String)

    Web property ID to create the view (profile) for.

  • profile_object (Google::Apis::AnalyticsV3::Profile) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
# File 'generated/google/apis/analytics_v3/service.rb', line 2302

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.

Parameters:

  • account_id (String)

    Account ID to create profile filter link for.

  • web_property_id (String)

    Web property Id to create profile filter link for.

  • profile_id (String)

    Profile ID to create filter link for.

  • profile_filter_link_object (Google::Apis::AnalyticsV3::ProfileFilterLink) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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).

Parameters:

  • account_id (String)

    Account ID to create the user link for.

  • web_property_id (String)

    Web Property ID to create the user link for.

  • profile_id (String)

    View (Profile) ID to create the user link for.

  • entity_user_link_object (Google::Apis::AnalyticsV3::EntityUserLink) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
# File 'generated/google/apis/analytics_v3/service.rb', line 2081

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.

Parameters:

  • account_id (String)

    Account ID to create the unsampled report for.

  • web_property_id (String)

    Web property ID to create the unsampled report for.

  • profile_id (String)

    View (Profile) ID to create the unsampled report for.

  • unsampled_report_object (Google::Apis::AnalyticsV3::UnsampledReport) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
# File 'generated/google/apis/analytics_v3/service.rb', line 2824

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.

Parameters:

  • account_id (String)

    Account ID to create the web property for.

  • webproperty_object (Google::Apis::AnalyticsV3::Webproperty) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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-AdWords link.

Parameters:

  • account_id (String)

    ID of the Google Analytics account to create the link for.

  • web_property_id (String)

    Web property ID to create the link for.

  • entity_ad_words_link_object (Google::Apis::AnalyticsV3::EntityAdWordsLink) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'generated/google/apis/analytics_v3/service.rb', line 3182

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.

Parameters:

  • account_id (String)

    Account ID to create the user link for.

  • web_property_id (String)

    Web Property ID to create the user link for.

  • entity_user_link_object (Google::Apis::AnalyticsV3::EntityUserLink) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
# File 'generated/google/apis/analytics_v3/service.rb', line 3599

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.

Parameters:

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


292
293
294
295
296
297
298
299
300
301
302
# File 'generated/google/apis/analytics_v3/service.rb', line 292

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.

Parameters:

  • account_id (String)

    Account ID to retrieve the user links for.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of account-user links to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


407
408
409
410
411
412
413
414
415
416
417
418
# File 'generated/google/apis/analytics_v3/service.rb', line 407

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.

Parameters:

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of accounts to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


488
489
490
491
492
493
494
495
496
497
498
# File 'generated/google/apis/analytics_v3/service.rb', line 488

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.

Parameters:

  • account_id (String)

    Account Id for the custom data sources to retrieve.

  • web_property_id (String)

    Web property Id for the custom data sources to retrieve.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of custom data sources to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


531
532
533
534
535
536
537
538
539
540
541
542
543
# File 'generated/google/apis/analytics_v3/service.rb', line 531

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.

Parameters:

  • account_id (String)

    Account ID for the custom dimensions to retrieve.

  • web_property_id (String)

    Web property ID for the custom dimensions to retrieve.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of custom dimensions to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


658
659
660
661
662
663
664
665
666
667
668
669
670
# File 'generated/google/apis/analytics_v3/service.rb', line 658

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.

Parameters:

  • account_id (String)

    Account ID for the custom metrics to retrieve.

  • web_property_id (String)

    Web property ID for the custom metrics to retrieve.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of custom metrics to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


881
882
883
884
885
886
887
888
889
890
891
892
893
# File 'generated/google/apis/analytics_v3/service.rb', line 881

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.

Parameters:

  • account_id (String)

    Account ID to retrieve experiments for.

  • web_property_id (String)

    Web property ID to retrieve experiments for.

  • profile_id (String)

    View (Profile) ID to retrieve experiments for.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of experiments to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
# File 'generated/google/apis/analytics_v3/service.rb', line 1154

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

Parameters:

  • account_id (String)

    Account ID to retrieve filters for.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of filters to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
# File 'generated/google/apis/analytics_v3/service.rb', line 1406

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.

Parameters:

  • account_id (String)

    Account ID to retrieve goals for. Can either be a specific account ID or '~all' , which refers to all the accounts that user has access to.

  • web_property_id (String)

    Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.

  • profile_id (String)

    View (Profile) ID to retrieve goals for. Can either be a specific view ( profile) ID or '~all', which refers to all the views (profiles) that user has access to.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of goals to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'generated/google/apis/analytics_v3/service.rb', line 1626

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.

Parameters:

  • account_id (String)

    The account ID of the remarketing audiences to retrieve.

  • web_property_id (String)

    The web property ID of the remarketing audiences to retrieve.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of remarketing audiences to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • type (String) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

Parameters:

  • report_type (String)

    Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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.

Parameters:

  • account_id (String)

    Account ID to retrieve profile filter links for.

  • web_property_id (String)

    Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.

  • profile_id (String)

    Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of profile filter links to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
# File 'generated/google/apis/analytics_v3/service.rb', line 1901

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).

Parameters:

  • account_id (String)

    Account ID which the given view (profile) belongs to.

  • web_property_id (String)

    Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.

  • profile_id (String)

    View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of profile-user links to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
# File 'generated/google/apis/analytics_v3/service.rb', line 2133

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.

Parameters:

  • account_id (String)

    Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.

  • web_property_id (String)

    Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of views (profiles) to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
# File 'generated/google/apis/analytics_v3/service.rb', line 2351

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.

Parameters:

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of segments to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
# File 'generated/google/apis/analytics_v3/service.rb', line 2697

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.

Parameters:

  • account_id (String)

    Account ID to retrieve unsampled reports for. Must be a specific account ID, ~ all is not supported.

  • web_property_id (String)

    Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.

  • profile_id (String)

    View (Profile) ID to retrieve unsampled reports for. Must be a specific view ( profile) ID, ~all is not supported.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of unsampled reports to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
# File 'generated/google/apis/analytics_v3/service.rb', line 2875

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.

Parameters:

  • account_id (String)

    Account Id for the uploads to retrieve.

  • web_property_id (String)

    Web property Id for the uploads to retrieve.

  • custom_data_source_id (String)

    Custom data source Id for uploads to retrieve.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of uploads to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# File 'generated/google/apis/analytics_v3/service.rb', line 3009

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.

Parameters:

  • account_id (String)

    Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of web properties to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
# File 'generated/google/apis/analytics_v3/service.rb', line 3438

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-AdWords links for a given web property.

Parameters:

  • account_id (String)

    ID of the account which the given web property belongs to.

  • web_property_id (String)

    Web property ID to retrieve the AdWords links for.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of webProperty-AdWords links to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first webProperty-AdWords link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
# File 'generated/google/apis/analytics_v3/service.rb', line 3227

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.

Parameters:

  • account_id (String)

    Account ID which the given web property belongs to.

  • web_property_id (String)

    Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.

  • max_results (Fixnum) (defaults to: nil)

    The maximum number of webProperty-user Links to include in this response.

  • start_index (Fixnum) (defaults to: nil)

    An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
# File 'generated/google/apis/analytics_v3/service.rb', line 3646

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.

Parameters:

  • account_id (String)

    Account ID for the custom dimension to update.

  • web_property_id (String)

    Web property ID for the custom dimension to update.

  • custom_dimension_id (String)

    Custom dimension ID for the custom dimension to update.

  • custom_dimension_object (Google::Apis::AnalyticsV3::CustomDimension) (defaults to: nil)
  • ignore_custom_data_source_links (Boolean) (defaults to: nil)

    Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
# File 'generated/google/apis/analytics_v3/service.rb', line 704

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.

Parameters:

  • account_id (String)

    Account ID for the custom metric to update.

  • web_property_id (String)

    Web property ID for the custom metric to update.

  • custom_metric_id (String)

    Custom metric ID for the custom metric to update.

  • custom_metric_object (Google::Apis::AnalyticsV3::CustomMetric) (defaults to: nil)
  • ignore_custom_data_source_links (Boolean) (defaults to: nil)

    Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
# File 'generated/google/apis/analytics_v3/service.rb', line 927

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.

Parameters:

  • account_id (String)

    Account ID of the experiment to update.

  • web_property_id (String)

    Web property ID of the experiment to update.

  • profile_id (String)

    View (Profile) ID of the experiment to update.

  • experiment_id (String)

    Experiment ID of the experiment to update.

  • experiment_object (Google::Apis::AnalyticsV3::Experiment) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
# File 'generated/google/apis/analytics_v3/service.rb', line 1200

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.

Parameters:

  • account_id (String)

    Account ID to which the filter belongs.

  • filter_id (String)

    ID of the filter to be updated.

  • filter_object (Google::Apis::AnalyticsV3::Filter) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
# File 'generated/google/apis/analytics_v3/service.rb', line 1446

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.

Parameters:

  • account_id (String)

    Account ID to update the goal.

  • web_property_id (String)

    Web property ID to update the goal.

  • profile_id (String)

    View (Profile) ID to update the goal.

  • goal_id (String)

    Index of the goal to be updated.

  • goal_object (Google::Apis::AnalyticsV3::Goal) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
# File 'generated/google/apis/analytics_v3/service.rb', line 1672

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.

Parameters:

  • account_id (String)

    The account ID of the remarketing audience to update.

  • web_property_id (String)

    The web property ID of the remarketing audience to update.

  • remarketing_audience_id (String)

    The ID of the remarketing audience to update.

  • remarketing_audience_object (Google::Apis::AnalyticsV3::RemarketingAudience) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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.

Parameters:

  • account_id (String)

    Account ID to which the view (profile) belongs

  • web_property_id (String)

    Web property ID to which the view (profile) belongs

  • profile_id (String)

    ID of the view (profile) to be updated.

  • profile_object (Google::Apis::AnalyticsV3::Profile) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
# File 'generated/google/apis/analytics_v3/service.rb', line 2394

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.

Parameters:

  • account_id (String)

    Account ID to which profile filter link belongs.

  • web_property_id (String)

    Web property Id to which profile filter link belongs

  • profile_id (String)

    Profile ID to which filter link belongs

  • link_id (String)

    ID of the profile filter link to be updated.

  • profile_filter_link_object (Google::Apis::AnalyticsV3::ProfileFilterLink) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
# File 'generated/google/apis/analytics_v3/service.rb', line 1947

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.

Parameters:

  • account_id (String)

    Account ID to which the web property belongs

  • web_property_id (String)

    Web property ID

  • webproperty_object (Google::Apis::AnalyticsV3::Webproperty) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
# File 'generated/google/apis/analytics_v3/service.rb', line 3478

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-AdWords link. This method supports patch semantics.

Parameters:

  • account_id (String)

    ID of the account which the given web property belongs to.

  • web_property_id (String)

    Web property ID to retrieve the AdWords link for.

  • web_property_ad_words_link_id (String)

    Web property-AdWords link ID.

  • entity_ad_words_link_object (Google::Apis::AnalyticsV3::EntityAdWordsLink) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
# File 'generated/google/apis/analytics_v3/service.rb', line 3271

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.

Parameters:

  • account_id (String)

    Account ID to update the account-user link for.

  • link_id (String)

    Link ID to update the account-user link for.

  • entity_user_link_object (Google::Apis::AnalyticsV3::EntityUserLink) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


447
448
449
450
451
452
453
454
455
456
457
458
459
# File 'generated/google/apis/analytics_v3/service.rb', line 447

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.

Parameters:

  • account_id (String)

    Account ID for the custom dimension to update.

  • web_property_id (String)

    Web property ID for the custom dimension to update.

  • custom_dimension_id (String)

    Custom dimension ID for the custom dimension to update.

  • custom_dimension_object (Google::Apis::AnalyticsV3::CustomDimension) (defaults to: nil)
  • ignore_custom_data_source_links (Boolean) (defaults to: nil)

    Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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.

Parameters:

  • account_id (String)

    Account ID for the custom metric to update.

  • web_property_id (String)

    Web property ID for the custom metric to update.