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.



3790
3791
3792
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3790

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) 


3648
3649
3650
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3648

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) 


3653
3654
3655
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3653

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:



3660
3661
3662
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3660

def child_link
  @child_link
end

#created ⇒ DateTime

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

Returns:

  • (DateTime) 


3665
3666
3667
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3665

def created
  @created
end

#currency ⇒ String

The currency type associated with this view (profile), defaults to USD. The supported values are: ARS, AUD, BGN, BRL, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, HUF, IDR, INR, JPY, KRW, LTL, MXN, NOK, NZD, PHP, PLN, RUB, SEK, THB, TRY, TWD, USD, VND, ZAR Corresponds to the JSON property currency

Returns:

  • (String) 


3673
3674
3675
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3673

def currency
  @currency
end

#default_page ⇒ String

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

Returns:

  • (String) 


3678
3679
3680
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3678

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) 


3683
3684
3685
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3683

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) 


3690
3691
3692
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3690

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) 


3696
3697
3698
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3696

def exclude_query_parameters
  @exclude_query_parameters
end

#id ⇒ String

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

Returns:

  • (String) 


3701
3702
3703
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3701

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) 


3706
3707
3708
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3706

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) 


3711
3712
3713
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3711

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


3716
3717
3718
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3716

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:



3722
3723
3724
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3722

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:



3727
3728
3729
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3727

def permissions
  @permissions
end

#self_link ⇒ String

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

Returns:

  • (String) 


3732
3733
3734
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3732

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) 


3737
3738
3739
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3737

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) 


3742
3743
3744
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3742

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) 


3747
3748
3749
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3747

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) 


3754
3755
3756
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3754

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) 


3761
3762
3763
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3761

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) 


3768
3769
3770
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3768

def timezone
  @timezone
end

#type ⇒ String

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

Returns:

  • (String) 


3773
3774
3775
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3773

def type
  @type
end

#updated ⇒ DateTime

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

Returns:

  • (DateTime) 


3778
3779
3780
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3778

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) 


3783
3784
3785
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3783

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) 


3788
3789
3790
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3788

def website_url
  @website_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3795

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