Class: Google::Apis::AnalyticsV3::Webproperty

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 web property.

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) ⇒ Webproperty

Returns a new instance of Webproperty



5692
5693
5694
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5692

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

Instance Attribute Details

#account_id ⇒ String

Account ID to which this web property belongs. Corresponds to the JSON property accountId

Returns:

  • (String) 


5590
5591
5592
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5590

def 
  @account_id
end

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

Child link for this web property. Points to the list of views (profiles) for this web property. Corresponds to the JSON property childLink

Returns:



5596
5597
5598
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5596

def child_link
  @child_link
end

#created ⇒ DateTime

Time this web property was created. Corresponds to the JSON property created

Returns:

  • (DateTime) 


5601
5602
5603
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5601

def created
  @created
end

#data_retention_reset_on_new_activity ⇒ Boolean Also known as: data_retention_reset_on_new_activity?

Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). Set to false to delete data associated with the user identifer automatically after the rentention period. This property cannot be set on insert. Corresponds to the JSON property dataRetentionResetOnNewActivity

Returns:

  • (Boolean) 


5611
5612
5613
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5611

def data_retention_reset_on_new_activity
  @data_retention_reset_on_new_activity
end

#data_retention_ttl ⇒ String

The length of time for which user and event data is retained. This property cannot be set on insert. Corresponds to the JSON property dataRetentionTtl

Returns:

  • (String) 


5618
5619
5620
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5618

def data_retention_ttl
  @data_retention_ttl
end

#default_profile_id ⇒ Fixnum

Default view (profile) ID. Corresponds to the JSON property defaultProfileId

Returns:

  • (Fixnum) 


5623
5624
5625
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5623

def default_profile_id
  @default_profile_id
end

#id ⇒ String

Web property ID of the form UA-XXXXX-YY. Corresponds to the JSON property id

Returns:

  • (String) 


5628
5629
5630
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5628

def id
  @id
end

#industry_vertical ⇒ String

The industry vertical/category selected for this web property. Corresponds to the JSON property industryVertical

Returns:

  • (String) 


5633
5634
5635
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5633

def industry_vertical
  @industry_vertical
end

#internal_web_property_id ⇒ String

Internal ID for this web property. Corresponds to the JSON property internalWebPropertyId

Returns:

  • (String) 


5638
5639
5640
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5638

def internal_web_property_id
  @internal_web_property_id
end

#kind ⇒ String

Resource type for Analytics WebProperty. Corresponds to the JSON property kind

Returns:

  • (String) 


5643
5644
5645
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5643

def kind
  @kind
end

#level ⇒ String

Level for this web property. Possible values are STANDARD or PREMIUM. Corresponds to the JSON property level

Returns:

  • (String) 


5648
5649
5650
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5648

def level
  @level
end

#name ⇒ String

Name of this web property. Corresponds to the JSON property name

Returns:

  • (String) 


5653
5654
5655
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5653

def name
  @name
end

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

Parent link for this web property. Points to the account to which this web property belongs. Corresponds to the JSON property parentLink

Returns:



5659
5660
5661
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5659

def parent_link
  @parent_link
end

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

Permissions the user has for this web property. Corresponds to the JSON property permissions

Returns:



5664
5665
5666
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5664

def permissions
  @permissions
end

#profile_count ⇒ Fixnum

View (Profile) count for this web property. Corresponds to the JSON property profileCount

Returns:

  • (Fixnum) 


5669
5670
5671
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5669

def profile_count
  @profile_count
end

#self_link ⇒ String

Link for this web property. Corresponds to the JSON property selfLink

Returns:

  • (String) 


5674
5675
5676
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5674

def self_link
  @self_link
end

#starred ⇒ Boolean Also known as: starred?

Indicates whether this web property is starred or not. Corresponds to the JSON property starred

Returns:

  • (Boolean) 


5679
5680
5681
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5679

def starred
  @starred
end

#updated ⇒ DateTime

Time this web property was last modified. Corresponds to the JSON property updated

Returns:

  • (DateTime) 


5685
5686
5687
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5685

def updated
  @updated
end

#website_url ⇒ String

Website url for this web property. Corresponds to the JSON property websiteUrl

Returns:

  • (String) 


5690
5691
5692
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5690

def website_url
  @website_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 5697

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @child_link = args[:child_link] if args.key?(:child_link)
  @created = args[:created] if args.key?(:created)
  @data_retention_reset_on_new_activity = args[:data_retention_reset_on_new_activity] if args.key?(:data_retention_reset_on_new_activity)
  @data_retention_ttl = args[:data_retention_ttl] if args.key?(:data_retention_ttl)
  @default_profile_id = args[:default_profile_id] if args.key?(:default_profile_id)
  @id = args[:id] if args.key?(:id)
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
  @internal_web_property_id = args[:internal_web_property_id] if args.key?(:internal_web_property_id)
  @kind = args[:kind] if args.key?(:kind)
  @level = args[:level] if args.key?(:level)
  @name = args[:name] if args.key?(:name)
  @parent_link = args[:parent_link] if args.key?(:parent_link)
  @permissions = args[:permissions] if args.key?(:permissions)
  @profile_count = args[:profile_count] if args.key?(:profile_count)
  @self_link = args[:self_link] if args.key?(:self_link)
  @starred = args[:starred] if args.key?(:starred)
  @updated = args[:updated] if args.key?(:updated)
  @website_url = args[:website_url] if args.key?(:website_url)
end