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

Inherits:

Core::BaseService

Object
Core::BaseService
Google::Apis::AnalyticsV3::AnalyticsService

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

Instance Attribute Summary collapse

#key ⇒ String
API key.
#quota_user ⇒ String
An opaque string that represents a user for quota purposes.
#user_ip ⇒ String
Deprecated.

Attributes inherited from Core::BaseService

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

Instance Method Summary collapse

#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.
#create_provisioning_account_tree(account_tree_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::AccountTreeResponse
Provision account.
#delete_account_user_link(account_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Removes a user from the given account.
#delete_experiment(account_id, web_property_id, profile_id, experiment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Delete an experiment.
#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.
#delete_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Delete a remarketing audience.
#delete_profile(account_id, web_property_id, profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes a view (profile).
#delete_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Delete a profile filter link.
#delete_profile_user_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Removes a user from the given view (profile).
#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| ... }
Deletes an unsampled report.
#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| ... }
Delete data associated with a previous upload.
#delete_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes a web property-Google Ads link.
#delete_web_property_user_link(account_id, web_property_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Removes a user from the given web property.
#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.
#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.
#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.
#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.
#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).
#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.
#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.
#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).
#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.
#get_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::ProfileFilterLink
Returns a single profile filter link.
#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).
#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.
#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.
#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.
#get_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityAdWordsLink
Returns a web property-Google Ads link to which the user has access.
#hash_client_id(hash_client_id_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::HashClientIdResponse
Hashes the given Client ID.
#initialize ⇒ AnalyticsService constructor
A new instance of AnalyticsService.
#insert_account_user_link(account_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityUserLink
Adds a new user to the given account.
#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.
#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.
#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.
#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.
#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.
#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.
#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).
#insert_profile_filter_link(account_id, web_property_id, profile_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::ProfileFilterLink
Create a new profile filter link.
#insert_profile_user_link(account_id, web_property_id, profile_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityUserLink
Adds a new user to the given view (profile).
#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.
#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.
#insert_web_property_ad_words_link(account_id, web_property_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityAdWordsLink
Creates a webProperty-Google Ads link.
#insert_web_property_user_link(account_id, web_property_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityUserLink
Adds a new user to the given web property.
#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.
#list_account_user_links(account_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityUserLinks
Lists account-user links for a given account.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#list_profile_filter_links(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::ProfileFilterLinks
Lists all profile filter links for a profile.
#list_profile_user_links(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityUserLinks
Lists profile-user links for a given view (profile).
#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.
#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.
#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.
#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.
#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.
#list_web_property_ad_words_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityAdWordsLinks
Lists webProperty-Google Ads links for a given web property.
#list_web_property_user_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityUserLinks
Lists webProperty-user links for a given web property.
#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.
#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.
#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.
#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.
#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.
#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.
#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).
#patch_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::ProfileFilterLink
Update an existing profile filter link.
#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.
#patch_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityAdWordsLink
Updates an existing webProperty-Google Ads link.
#update_account_user_link(account_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityUserLink
Updates permissions for an existing user on the given account.
#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.
#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.
#update_experiment(account_id, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Experiment
Update an existing experiment.
#update_filter(account_id, filter_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Filter
Updates an existing filter.
#update_goal(account_id, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Goal
Updates an existing goal.
#update_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::RemarketingAudience
Updates an existing remarketing audience.
#update_profile(account_id, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Profile
Updates an existing view (profile).
#update_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::ProfileFilterLink
Update an existing profile filter link.
#update_profile_user_link(account_id, web_property_id, profile_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityUserLink
Updates permissions for an existing user on the given view (profile).
#update_web_property(account_id, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Webproperty
Updates an existing web property.
#update_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityAdWordsLink
Updates an existing webProperty-Google Ads link.
#update_web_property_user_link(account_id, web_property_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityUserLink
Updates permissions for an existing user on the given web property.
#upload_data(account_id, web_property_id, custom_data_source_id, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::Upload
Upload data for a custom data source.
#upsert_user_deletion_user_deletion_request(user_deletion_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::UserDeletionRequest
Insert or update a user deletion requests.

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ `AnalyticsService`

Returns a new instance of AnalyticsService

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

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

Instance Attribute Details

#key ⇒ `String`

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_user ⇒ `String`

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

(String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



43
44
45

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

def quota_user
  @quota_user
end

#user_ip ⇒ `String`

Returns Deprecated. Please use quotaUser instead.

Returns:

(String) —
Deprecated. Please use quotaUser instead.



47
48
49

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

def user_ip
  @user_ip
end

Instance Method Details

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

Creates an account ticket.

Parameters:

account_ticket_object (Google::Apis::AnalyticsV3::AccountTicket) (defaults to: nil)
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::AccountTicket) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::AccountTicket)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3664

def create_account_ticket(account_ticket_object = 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 = account_ticket_object
  command.response_representation = Google::Apis::AnalyticsV3::AccountTicket::Representation
  command.response_class = Google::Apis::AnalyticsV3::AccountTicket
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Provision account.

Parameters:

account_tree_request_object (Google::Apis::AnalyticsV3::AccountTreeRequest) (defaults to: nil)
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::AccountTreeResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::AccountTreeResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3697

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

#delete_account_user_link(account_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
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:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 319

def delete_account_user_link(account_id, 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'] = account_id unless account_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_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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
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:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1011

def delete_experiment(account_id, 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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Filter) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Filter)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1267

def delete_filter(account_id, 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'] = account_id unless account_id.nil?
  command.params['filterId'] = filter_id unless filter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Delete a remarketing audience.

Parameters:

account_id (String) —
Account ID to which the remarketing audience belongs.
web_property_id (String) —
Web property ID to which the remarketing audience belongs.
remarketing_audience_id (String) —
The ID of the remarketing audience to delete.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
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:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2405

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

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

This method returns an undefined value.

Deletes a view (profile).

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
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:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2159

def delete_profile(account_id, 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'] = account_id unless account_id.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

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

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
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:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1721

def delete_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}', options)
  command.params['accountId'] = account_id unless account_id.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_profile_user_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
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:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1984

def delete_profile_user_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}', options)
  command.params['accountId'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
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:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2688

def delete_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}', options)
  command.params['accountId'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
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:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2860

def delete_upload_data(account_id, web_property_id, custom_data_source_id, delete_upload_data_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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

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

This method returns an undefined value.

Deletes a web property-Google Ads 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 Google Ads link for.
web_property_ad_words_link_id (String) —
Web property Google Ads link ID.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
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:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3036

def delete_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}', options)
  command.params['accountId'] = account_id unless account_id.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

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

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
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:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3472

def delete_web_property_user_link(account_id, 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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::CustomDimension) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::CustomDimension)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 583

def get_custom_dimension(account_id, 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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::CustomMetric) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::CustomMetric)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 796

def get_custom_metric(account_id, 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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Experiment) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Experiment)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1051

def get_experiment(account_id, 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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Filter) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Filter)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1303

def get_filter(account_id, 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'] = account_id unless account_id.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) —
A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
filters (String) —
A comma-separated list of dimension or metric filters to be applied to Analytics data.
include_empty_rows (Boolean) —
The response will include empty rows if this parameter is set to true, the default is true
max_results (Fixnum) —
The maximum number of entries to include in this feed.
output (String) —
The selected format for the response. Default format is JSON.
sampling_level (String) —
The desired sampling level.
segment (String) —
An Analytics segment to be applied to data.
sort (String) —
A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
start_index (Fixnum) —
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::GaData) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::GaData)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 110

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

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

Gets a goal to which the user has access.

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Goal) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Goal)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1497

def get_goal(account_id, 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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::RemarketingAudience) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::RemarketingAudience)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2442

def get_management_remarketing_audience(account_id, 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'] = account_id unless account_id.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) —
A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source, mcf:medium'.
filters (String) —
A comma-separated list of dimension or metric filters to be applied to the Analytics data.
max_results (Fixnum) —
The maximum number of entries to include in this feed.
sampling_level (String) —
The desired sampling level.
sort (String) —
A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.
start_index (Fixnum) —
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::McfData) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::McfData)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 184

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

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

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

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Profile) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Profile)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2196

def get_profile(account_id, 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'] = account_id unless account_id.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

#get_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::ProfileFilterLink`

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::ProfileFilterLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::ProfileFilterLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1761

def get_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.
filters (String) —
A comma-separated list of dimension or metric filters to be applied to real time data.
max_results (Fixnum) —
The maximum number of entries to include in this feed.
sort (String) —
A comma-separated list of dimensions or metrics that determine the sort order for real time data.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::RealtimeData) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::RealtimeData)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 240

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

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

Returns a single unsampled report.

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::UnsampledReport) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::UnsampledReport)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2728

def get_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Upload) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Upload)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2901

def get_upload(account_id, web_property_id, custom_data_source_id, upload_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Webproperty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Webproperty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3277

def get_web_property(account_id, 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'] = account_id unless account_id.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

#get_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityAdWordsLink`

Returns a web property-Google Ads 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 Google Ads link for.
web_property_ad_words_link_id (String) —
Web property-Google Ads link ID.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityAdWordsLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityAdWordsLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3073

def get_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.nil?
  command.params['webPropertyId'] = web_property_id unless web_property_id.nil?
  command.params['webPropertyAdWordsLinkId'] = web_property_ad_words_link_id unless web_property_ad_words_link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Hashes the given Client ID.

Parameters:

hash_client_id_request_object (Google::Apis::AnalyticsV3::HashClientIdRequest) (defaults to: nil)
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::HashClientIdResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::HashClientIdResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 502

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

#insert_account_user_link(account_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityUserLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityUserLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 352

def insert_account_user_link(account_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}/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'] = account_id unless account_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_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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::CustomDimension) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::CustomDimension)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 621

def insert_custom_dimension(account_id, 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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::CustomMetric) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::CustomMetric)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 834

def insert_custom_metric(account_id, 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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Experiment) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Experiment)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1092

def insert_experiment(account_id, 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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Filter) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Filter)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1338

def insert_filter(account_id, 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'] = account_id unless account_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_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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Goal) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Goal)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1538

def insert_goal(account_id, 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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::RemarketingAudience) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::RemarketingAudience)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2480

def insert_management_remarketing_audience(account_id, web_property_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Profile) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Profile)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2234

def insert_profile(account_id, 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'] = account_id unless account_id.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_filter_link(account_id, web_property_id, profile_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::ProfileFilterLink`

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::ProfileFilterLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::ProfileFilterLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1802

def insert_profile_filter_link(account_id, web_property_id, profile_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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_profile_user_link(account_id, web_property_id, profile_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityUserLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityUserLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2023

def insert_profile_user_link(account_id, web_property_id, profile_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::UnsampledReport) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::UnsampledReport)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2769

def insert_unsampled_report(account_id, web_property_id, profile_id, unsampled_report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Webproperty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Webproperty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3314

def insert_web_property(account_id, 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'] = account_id unless account_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_ad_words_link(account_id, web_property_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityAdWordsLink`

Creates a webProperty-Google Ads 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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityAdWordsLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityAdWordsLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3111

def insert_web_property_ad_words_link(account_id, web_property_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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_web_property_user_link(account_id, web_property_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityUserLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityUserLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3508

def insert_web_property_user_link(account_id, web_property_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.
start_index (Fixnum) —
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::AccountSummaries) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::AccountSummaries)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 283

def list_account_summaries(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

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

Lists account-user links for a given account.

Parameters:

account_id (String) —
Account ID to retrieve the user links for.
max_results (Fixnum) —
The maximum number of account-user links to include in this response.
start_index (Fixnum) —
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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityUserLinks) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityUserLinks)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 392

def list_account_user_links(account_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}/entityUserLinks', options)
  command.response_representation = Google::Apis::AnalyticsV3::EntityUserLinks::Representation
  command.response_class = Google::Apis::AnalyticsV3::EntityUserLinks
  command.params['accountId'] = account_id unless account_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_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) —
The maximum number of accounts to include in this response.
start_index (Fixnum) —
An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Accounts) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Accounts)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 469

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

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

List custom data sources to which the user has access.

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) —
The maximum number of custom data sources to include in this response.
start_index (Fixnum) —
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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::CustomDataSources) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::CustomDataSources)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 543

def list_custom_data_sources(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
The maximum number of custom dimensions to include in this response.
start_index (Fixnum) —
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::CustomDimensions) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::CustomDimensions)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 664

def list_custom_dimensions(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
The maximum number of custom metrics to include in this response.
start_index (Fixnum) —
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::CustomMetrics) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::CustomMetrics)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 877

def list_custom_metrics(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
The maximum number of experiments to include in this response.
start_index (Fixnum) —
An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Experiments) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Experiments)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1138

def list_experiments(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
The maximum number of filters to include in this response.
start_index (Fixnum) —
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Filters) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Filters)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1378

def list_filters(account_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}/filters', options)
  command.response_representation = Google::Apis::AnalyticsV3::Filters::Representation
  command.response_class = Google::Apis::AnalyticsV3::Filters
  command.params['accountId'] = account_id unless account_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_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) —
The maximum number of goals to include in this response.
start_index (Fixnum) —
An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Goals) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Goals)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1588

def list_goals(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
The maximum number of remarketing audiences to include in this response.
start_index (Fixnum) —
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
type (String)
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::RemarketingAudiences) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::RemarketingAudiences)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2524

def list_management_remarketing_audiences(account_id, web_property_id, max_results: nil, start_index: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Columns) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Columns)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3632

def list_metadata_columns(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

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

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) —
The maximum number of profile filter links to include in this response.
start_index (Fixnum) —
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::ProfileFilterLinks) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::ProfileFilterLinks)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1851

def list_profile_filter_links(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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_profile_user_links(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLinks`

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) —
The maximum number of profile-user links to include in this response.
start_index (Fixnum) —
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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityUserLinks) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityUserLinks)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2073

def list_profile_user_links(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
The maximum number of views (profiles) to include in this response.
start_index (Fixnum) —
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Profiles) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Profiles)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2281

def list_profiles(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
The maximum number of segments to include in this response.
start_index (Fixnum) —
An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Segments) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Segments)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2648

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

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

Lists unsampled reports to which the user has access.

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) —
The maximum number of unsampled reports to include in this response.
start_index (Fixnum) —
An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::UnsampledReports) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::UnsampledReports)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2818

def list_unsampled_reports(account_id, web_property_id, profile_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
The maximum number of uploads to include in this response.
start_index (Fixnum) —
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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Uploads) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Uploads)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2946

def list_uploads(account_id, web_property_id, custom_data_source_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
The maximum number of web properties to include in this response.
start_index (Fixnum) —
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Webproperties) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Webproperties)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3355

def list_web_properties(account_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', options)
  command.response_representation = Google::Apis::AnalyticsV3::Webproperties::Representation
  command.response_class = Google::Apis::AnalyticsV3::Webproperties
  command.params['accountId'] = account_id unless account_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_property_ad_words_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityAdWordsLinks`

Lists webProperty-Google Ads 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 Google Ads links for.
max_results (Fixnum) —
The maximum number of webProperty-Google Ads links to include in this response.
start_index (Fixnum) —
An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityAdWordsLinks) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityAdWordsLinks)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3154

def list_web_property_ad_words_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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_web_property_user_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLinks`

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) —
The maximum number of webProperty-user Links to include in this response.
start_index (Fixnum) —
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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityUserLinks) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityUserLinks)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3553

def list_web_property_user_links(account_id, web_property_id, max_results: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::CustomDimension) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::CustomDimension)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 708

def patch_custom_dimension(account_id, web_property_id, custom_dimension_id, custom_dimension_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::CustomMetric) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::CustomMetric)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 921

def patch_custom_metric(account_id, web_property_id, custom_metric_id, custom_metric_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Experiment) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Experiment)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1182

def patch_experiment(account_id, web_property_id, profile_id, experiment_id, experiment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Filter) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Filter)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1416

def patch_filter(account_id, 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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Goal) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Goal)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1632

def patch_goal(account_id, web_property_id, profile_id, goal_id, goal_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::RemarketingAudience) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::RemarketingAudience)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2566

def patch_management_remarketing_audience(account_id, web_property_id, remarketing_audience_id, remarketing_audience_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Profile) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Profile)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2322

def patch_profile(account_id, 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'] = account_id unless account_id.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

#patch_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::ProfileFilterLink`

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::ProfileFilterLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::ProfileFilterLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1895

def patch_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Webproperty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Webproperty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3393

def patch_web_property(account_id, 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'] = account_id unless account_id.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

#patch_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityAdWordsLink`

Updates an existing webProperty-Google Ads 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 Google Ads link for.
web_property_ad_words_link_id (String) —
Web property-Google Ads link ID.
entity_ad_words_link_object (Google::Apis::AnalyticsV3::EntityAdWordsLink) (defaults to: nil)
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityAdWordsLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityAdWordsLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3196

def patch_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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

#update_account_user_link(account_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityUserLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityUserLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 430

def update_account_user_link(account_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.nil?
  command.params['linkId'] = link_id unless link_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_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) —
Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::CustomDimension) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::CustomDimension)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 754

def update_custom_dimension(account_id, web_property_id, custom_dimension_id, custom_dimension_object = nil, ignore_custom_data_source_links: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  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'] = account_id unless account_id.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.
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) —
Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::CustomMetric) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::CustomMetric)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 967

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

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

Update an existing experiment.

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Experiment) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Experiment)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1227

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

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

Updates an existing filter.

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Filter) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Filter)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1455

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

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

Updates an existing goal.

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Goal) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Goal)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1677

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

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

Updates an existing remarketing audience.

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::RemarketingAudience) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::RemarketingAudience)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2608

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

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

Updates an existing view (profile).

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Profile) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Profile)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2364

def update_profile(account_id, web_property_id, profile_id, profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Profile::Representation
  command.request_object = profile_object
  command.response_representation = Google::Apis::AnalyticsV3::Profile::Representation
  command.response_class = Google::Apis::AnalyticsV3::Profile
  command.params['accountId'] = account_id unless account_id.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_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::ProfileFilterLink`

Update an existing profile filter link.

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::ProfileFilterLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::ProfileFilterLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 1940

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

#update_profile_user_link(account_id, web_property_id, profile_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

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

Parameters:

account_id (String) —
Account ID to update the user link for.
web_property_id (String) —
Web Property ID to update the user link for.
profile_id (String) —
View (Profile ID) to update the user link for.
link_id (String) —
Link ID to update the user link for.
entity_user_link_object (Google::Apis::AnalyticsV3::EntityUserLink) (defaults to: nil)
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityUserLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityUserLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2117

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

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

Updates an existing web property.

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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Webproperty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Webproperty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3432

def update_web_property(account_id, web_property_id, webproperty_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'management/accounts/{accountId}/webproperties/{webPropertyId}', options)
  command.request_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
  command.request_object = webproperty_object
  command.response_representation = Google::Apis::AnalyticsV3::Webproperty::Representation
  command.response_class = Google::Apis::AnalyticsV3::Webproperty
  command.params['accountId'] = account_id unless account_id.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

#update_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityAdWordsLink`

Updates an existing webProperty-Google Ads link.

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 Google Ads link for.
web_property_ad_words_link_id (String) —
Web property-Google Ads link ID.
entity_ad_words_link_object (Google::Apis::AnalyticsV3::EntityAdWordsLink) (defaults to: nil)
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityAdWordsLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityAdWordsLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3238

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

#update_web_property_user_link(account_id, web_property_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

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

Parameters:

account_id (String) —
Account ID to update the account-user link for.
web_property_id (String) —
Web property 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) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::EntityUserLink) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::EntityUserLink)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3594

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

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

Upload data for a custom data source.

Parameters:

account_id (String) —
Account Id associated with the upload.
web_property_id (String) —
Web property UA-string associated with the upload.
custom_data_source_id (String) —
Custom data source Id to which the data being uploaded belongs.
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
upload_source (IO, String) —
IO stream or filename containing content to upload
content_type (String) —
Content type of the uploaded content.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::Upload) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::Upload)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 2991

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

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

Insert or update a user deletion requests.

Parameters:

user_deletion_request_object (Google::Apis::AnalyticsV3::UserDeletionRequest) (defaults to: nil)
fields (String) —
Selector specifying which fields to include in a partial response.
quota_user (String) —
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
user_ip (String) —
Deprecated. Please use quotaUser instead.
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::AnalyticsV3::UserDeletionRequest) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::AnalyticsV3::UserDeletionRequest)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'generated/google/apis/analytics_v3/service.rb', line 3730

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

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

Overview

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

Instance Method Summary collapse

Methods inherited from Core::BaseService

Methods included from Core::Logging

Constructor Details

#initialize ⇒ AnalyticsService

Instance Attribute Details

#key ⇒ String

#quota_user ⇒ String

#user_ip ⇒ String

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

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

#delete_account_user_link(account_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

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

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

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

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

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

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

#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| ... }

#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| ... }

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

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

#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_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_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

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

#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

#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

#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

#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

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

#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

#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

#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

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

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

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

#insert_account_user_link(account_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityUserLink

#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

#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

#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

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

#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

#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

#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

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

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

#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

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

#insert_web_property_ad_words_link(account_id, web_property_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityAdWordsLink

#insert_web_property_user_link(account_id, web_property_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AnalyticsV3::EntityUserLink

#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

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

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

#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_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

#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

#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

#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

#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

#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

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

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

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

#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

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

#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

#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_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

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

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

#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

#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

#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

#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

#initialize ⇒ `AnalyticsService`

#key ⇒ `String`

#quota_user ⇒ `String`

#user_ip ⇒ `String`

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

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

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

#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_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_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`

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

#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`

#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`

#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`

#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`

#get_profile_filter_link(account_id, web_property_id, profile_id, link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::ProfileFilterLink`

#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`

#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`

#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`

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

#get_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityAdWordsLink`

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

#insert_account_user_link(account_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

#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`

#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`

#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`

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

#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`

#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`

#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`

#insert_profile_filter_link(account_id, web_property_id, profile_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::ProfileFilterLink`

#insert_profile_user_link(account_id, web_property_id, profile_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

#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`

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

#insert_web_property_ad_words_link(account_id, web_property_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityAdWordsLink`

#insert_web_property_user_link(account_id, web_property_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

#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`

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

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

#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_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`

#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`

#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`

#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`

#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`

#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`

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

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

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

#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`

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

#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`

#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_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`

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

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

#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`

#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`

#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`

#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`

#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`

#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`

#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`

#patch_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::ProfileFilterLink`

#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`

#patch_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityAdWordsLink`

#update_account_user_link(account_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

#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`

#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`

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

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

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

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

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

#update_profile_filter_link(account_id, web_property_id, profile_id, link_id, profile_filter_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::ProfileFilterLink`

#update_profile_user_link(account_id, web_property_id, profile_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

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

#update_web_property_ad_words_link(account_id, web_property_id, web_property_ad_words_link_id, entity_ad_words_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityAdWordsLink`

#update_web_property_user_link(account_id, web_property_id, link_id, entity_user_link_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::AnalyticsV3::EntityUserLink`

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