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.


3796
3797
3798
# File 'generated/google/apis/analytics_v3/classes.rb', line 3796

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

Instance Attribute Details

#account_idString

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

Returns:

  • (String)

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

def 
  @account_id
end

#bot_filtering_enabledBoolean Also known as: bot_filtering_enabled?

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

Returns:

  • (Boolean)

3657
3658
3659
# File 'generated/google/apis/analytics_v3/classes.rb', line 3657

def bot_filtering_enabled
  @bot_filtering_enabled
end

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


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

def child_link
  @child_link
end

#createdDateTime

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

Returns:

  • (DateTime)

3669
3670
3671
# File 'generated/google/apis/analytics_v3/classes.rb', line 3669

def created
  @created
end

#currencyString

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)

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

def currency
  @currency
end

#default_pageString

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

Returns:

  • (String)

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

def default_page
  @default_page
end

#e_commerce_trackingBoolean Also known as: e_commerce_tracking?

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

Returns:

  • (Boolean)

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

def e_commerce_tracking
  @e_commerce_tracking
end

#enhanced_e_commerce_trackingBoolean 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)

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

def enhanced_e_commerce_tracking
  @enhanced_e_commerce_tracking
end

#exclude_query_parametersString

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

Returns:

  • (String)

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

def exclude_query_parameters
  @exclude_query_parameters
end

#idString

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

Returns:

  • (String)

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

def id
  @id
end

#internal_web_property_idString

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

Returns:

  • (String)

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

def internal_web_property_id
  @internal_web_property_id
end

#kindString

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

Returns:

  • (String)

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

def kind
  @kind
end

#nameString

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

Returns:

  • (String)

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

def name
  @name
end

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


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

def parent_link
  @parent_link
end

#permissionsGoogle::Apis::AnalyticsV3::Profile::Permissions

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


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

def permissions
  @permissions
end

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

Returns:

  • (String)

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

def self_link
  @self_link
end

#site_search_category_parametersString

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

Returns:

  • (String)

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

def site_search_category_parameters
  @site_search_category_parameters
end

#site_search_query_parametersString

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

Returns:

  • (String)

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

def site_search_query_parameters
  @site_search_query_parameters
end

#starredBoolean Also known as: starred?

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

Returns:

  • (Boolean)

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

def starred
  @starred
end

#strip_site_search_category_parametersBoolean 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)

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

def strip_site_search_category_parameters
  @strip_site_search_category_parameters
end

#strip_site_search_query_parametersBoolean 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)

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

def strip_site_search_query_parameters
  @strip_site_search_query_parameters
end

#timezoneString

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)

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

def timezone
  @timezone
end

#typeString

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

Returns:

  • (String)

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

def type
  @type
end

#updatedDateTime

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

Returns:

  • (DateTime)

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

def updated
  @updated
end

#web_property_idString

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

Returns:

  • (String)

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

def web_property_id
  @web_property_id
end

#website_urlString

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

Returns:

  • (String)

3794
3795
3796
# File 'generated/google/apis/analytics_v3/classes.rb', line 3794

def website_url
  @website_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
# File 'generated/google/apis/analytics_v3/classes.rb', line 3801

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