Class: Google::Apis::AnalyticsV3::Profile

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/analytics_v3/classes.rb,
generated/google/apis/analytics_v3/representations.rb,
generated/google/apis/analytics_v3/representations.rb

Overview

JSON template for an Analytics view (profile).

Defined Under Namespace

Classes: ChildLink, ParentLink, Permissions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Profile

Returns a new instance of Profile



4015
4016
4017
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4015

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_id ⇒ String

Account ID to which this view (profile) belongs. Corresponds to the JSON property accountId

Returns:

  • (String) 


3871
3872
3873
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3871

def 
  @account_id
end

#bot_filtering_enabled ⇒ Boolean Also known as: bot_filtering_enabled?

Indicates whether bot filtering is enabled for this view (profile). Corresponds to the JSON property botFilteringEnabled

Returns:

  • (Boolean) 


3876
3877
3878
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3876

def bot_filtering_enabled
  @bot_filtering_enabled
end

#child_link ⇒ Google::Apis::AnalyticsV3::Profile::ChildLink

Child link for this view (profile). Points to the list of goals for this view ( profile). Corresponds to the JSON property childLink

Returns:



3883
3884
3885
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3883

def child_link
  @child_link
end

#created ⇒ DateTime

Time this view (profile) was created. Corresponds to the JSON property created

Returns:

  • (DateTime) 


3888
3889
3890
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3888

def created
  @created
end

#currency ⇒ String

The currency type associated with this view (profile), defaults to USD. The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL Corresponds to the JSON property currency

Returns:

  • (String) 


3898
3899
3900
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3898

def currency
  @currency
end

#default_page ⇒ String

Default page for this view (profile). Corresponds to the JSON property defaultPage

Returns:

  • (String) 


3903
3904
3905
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3903

def default_page
  @default_page
end

#e_commerce_tracking ⇒ Boolean Also known as: e_commerce_tracking?

Indicates whether ecommerce tracking is enabled for this view (profile). Corresponds to the JSON property eCommerceTracking

Returns:

  • (Boolean) 


3908
3909
3910
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3908

def e_commerce_tracking
  @e_commerce_tracking
end

#enhanced_e_commerce_tracking ⇒ Boolean Also known as: enhanced_e_commerce_tracking?

Indicates whether enhanced ecommerce tracking is enabled for this view ( profile). This property can only be enabled if ecommerce tracking is enabled. Corresponds to the JSON property enhancedECommerceTracking

Returns:

  • (Boolean) 


3915
3916
3917
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3915

def enhanced_e_commerce_tracking
  @enhanced_e_commerce_tracking
end

#exclude_query_parameters ⇒ String

The query parameters that are excluded from this view (profile). Corresponds to the JSON property excludeQueryParameters

Returns:

  • (String) 


3921
3922
3923
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3921

def exclude_query_parameters
  @exclude_query_parameters
end

#id ⇒ String

View (Profile) ID. Corresponds to the JSON property id

Returns:

  • (String) 


3926
3927
3928
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3926

def id
  @id
end

#internal_web_property_id ⇒ String

Internal ID for the web property to which this view (profile) belongs. Corresponds to the JSON property internalWebPropertyId

Returns:

  • (String) 


3931
3932
3933
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3931

def internal_web_property_id
  @internal_web_property_id
end

#kind ⇒ String

Resource type for Analytics view (profile). Corresponds to the JSON property kind

Returns:

  • (String) 


3936
3937
3938
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3936

def kind
  @kind
end

#name ⇒ String

Name of this view (profile). Corresponds to the JSON property name

Returns:

  • (String) 


3941
3942
3943
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3941

def name
  @name
end

#parent_link ⇒ Google::Apis::AnalyticsV3::Profile::ParentLink

Parent link for this view (profile). Points to the web property to which this view (profile) belongs. Corresponds to the JSON property parentLink

Returns:



3947
3948
3949
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3947

def parent_link
  @parent_link
end

#permissions ⇒ Google::Apis::AnalyticsV3::Profile::Permissions

Permissions the user has for this view (profile). Corresponds to the JSON property permissions

Returns:



3952
3953
3954
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3952

def permissions
  @permissions
end

#self_link ⇒ String

Link for this view (profile). Corresponds to the JSON property selfLink

Returns:

  • (String) 


3957
3958
3959
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3957

def self_link
  @self_link
end

#site_search_category_parameters ⇒ String

Site search category parameters for this view (profile). Corresponds to the JSON property siteSearchCategoryParameters

Returns:

  • (String) 


3962
3963
3964
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3962

def site_search_category_parameters
  @site_search_category_parameters
end

#site_search_query_parameters ⇒ String

The site search query parameters for this view (profile). Corresponds to the JSON property siteSearchQueryParameters

Returns:

  • (String) 


3967
3968
3969
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3967

def site_search_query_parameters
  @site_search_query_parameters
end

#starred ⇒ Boolean Also known as: starred?

Indicates whether this view (profile) is starred or not. Corresponds to the JSON property starred

Returns:

  • (Boolean) 


3972
3973
3974
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3972

def starred
  @starred
end

#strip_site_search_category_parameters ⇒ Boolean Also known as: strip_site_search_category_parameters?

Whether or not Analytics will strip search category parameters from the URLs in your reports. Corresponds to the JSON property stripSiteSearchCategoryParameters

Returns:

  • (Boolean) 


3979
3980
3981
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3979

def strip_site_search_category_parameters
  @strip_site_search_category_parameters
end

#strip_site_search_query_parameters ⇒ Boolean Also known as: strip_site_search_query_parameters?

Whether or not Analytics will strip search query parameters from the URLs in your reports. Corresponds to the JSON property stripSiteSearchQueryParameters

Returns:

  • (Boolean) 


3986
3987
3988
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3986

def strip_site_search_query_parameters
  @strip_site_search_query_parameters
end

#timezone ⇒ String

Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. Corresponds to the JSON property timezone

Returns:

  • (String) 


3993
3994
3995
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3993

def timezone
  @timezone
end

#type ⇒ String

View (Profile) type. Supported types: WEB or APP. Corresponds to the JSON property type

Returns:

  • (String) 


3998
3999
4000
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3998

def type
  @type
end

#updated ⇒ DateTime

Time this view (profile) was last modified. Corresponds to the JSON property updated

Returns:

  • (DateTime) 


4003
4004
4005
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4003

def updated
  @updated
end

#web_property_id ⇒ String

Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. Corresponds to the JSON property webPropertyId

Returns:

  • (String) 


4008
4009
4010
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4008

def web_property_id
  @web_property_id
end

#website_url ⇒ String

Website URL for this view (profile). Corresponds to the JSON property websiteUrl

Returns:

  • (String) 


4013
4014
4015
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4013

def website_url
  @website_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4020

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @bot_filtering_enabled = args[:bot_filtering_enabled] if args.key?(:bot_filtering_enabled)
  @child_link = args[:child_link] if args.key?(:child_link)
  @created = args[:created] if args.key?(:created)
  @currency = args[:currency] if args.key?(:currency)
  @default_page = args[:default_page] if args.key?(:default_page)
  @e_commerce_tracking = args[:e_commerce_tracking] if args.key?(:e_commerce_tracking)
  @enhanced_e_commerce_tracking = args[:enhanced_e_commerce_tracking] if args.key?(:enhanced_e_commerce_tracking)
  @exclude_query_parameters = args[:exclude_query_parameters] if args.key?(:exclude_query_parameters)
  @id = args[:id] if args.key?(:id)
  @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @parent_link = args[:parent_link] if args.key?(:parent_link)
  @permissions = args[:permissions] if args.key?(:permissions)
  @self_link = args[:self_link] if args.key?(:self_link)
  @site_search_category_parameters = args[:site_search_category_parameters] if args.key?(:site_search_category_parameters)
  @site_search_query_parameters = args[:site_search_query_parameters] if args.key?(:site_search_query_parameters)
  @starred = args[:starred] if args.key?(:starred)
  @strip_site_search_category_parameters = args[:strip_site_search_category_parameters] if args.key?(:strip_site_search_category_parameters)
  @strip_site_search_query_parameters = args[:strip_site_search_query_parameters] if args.key?(:strip_site_search_query_parameters)
  @timezone = args[:timezone] if args.key?(:timezone)
  @type = args[:type] if args.key?(:type)
  @updated = args[:updated] if args.key?(:updated)
  @web_property_id = args[:web_property_id] if args.key?(:web_property_id)
  @website_url = args[:website_url] if args.key?(:website_url)
end