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



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

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) 


3843
3844
3845
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3843

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) 


3848
3849
3850
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3848

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:



3855
3856
3857
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3855

def child_link
  @child_link
end

#created ⇒ DateTime

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

Returns:

  • (DateTime) 


3860
3861
3862
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3860

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) 


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

def currency
  @currency
end

#default_page ⇒ String

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

Returns:

  • (String) 


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

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) 


3880
3881
3882
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3880

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) 


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

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) 


3893
3894
3895
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3893

def exclude_query_parameters
  @exclude_query_parameters
end

#id ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


3913
3914
3915
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3913

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:



3919
3920
3921
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3919

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:



3924
3925
3926
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3924

def permissions
  @permissions
end

#self_link ⇒ String

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

Returns:

  • (String) 


3929
3930
3931
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3929

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) 


3934
3935
3936
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3934

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) 


3939
3940
3941
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3939

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) 


3944
3945
3946
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3944

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) 


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

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) 


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

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) 


3965
3966
3967
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3965

def timezone
  @timezone
end

#type ⇒ String

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

Returns:

  • (String) 


3970
3971
3972
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3970

def type
  @type
end

#updated ⇒ DateTime

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

Returns:

  • (DateTime) 


3975
3976
3977
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3975

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) 


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

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) 


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

def website_url
  @website_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3992

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