Class: Google::Apis::AnalyticsV3::RemarketingAudience

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 remarketing audience.

Defined Under Namespace

Classes: AudienceDefinition, StateBasedAudienceDefinition

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

Returns a new instance of RemarketingAudience



4672
4673
4674
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4672

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

Instance Attribute Details

#account_id ⇒ String

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

Returns:

  • (String) 


4601
4602
4603
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4601

def 
  @account_id
end

#audience_definition ⇒ Google::Apis::AnalyticsV3::RemarketingAudience::AudienceDefinition

The simple audience definition that will cause a user to be added to an audience. Corresponds to the JSON property audienceDefinition

Returns:



4607
4608
4609
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4607

def audience_definition
  @audience_definition
end

#audience_type ⇒ String

The type of audience, either SIMPLE or STATE_BASED. Corresponds to the JSON property audienceType

Returns:

  • (String) 


4612
4613
4614
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4612

def audience_type
  @audience_type
end

#created ⇒ DateTime

Time this remarketing audience was created. Corresponds to the JSON property created

Returns:

  • (DateTime) 


4617
4618
4619
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4617

def created
  @created
end

#description ⇒ String

The description of this remarketing audience. Corresponds to the JSON property description

Returns:

  • (String) 


4622
4623
4624
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4622

def description
  @description
end

#id ⇒ String

Remarketing Audience ID. Corresponds to the JSON property id

Returns:

  • (String) 


4627
4628
4629
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4627

def id
  @id
end

#internal_web_property_id ⇒ String

Internal ID for the web property to which this remarketing audience belongs. Corresponds to the JSON property internalWebPropertyId

Returns:

  • (String) 


4632
4633
4634
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4632

def internal_web_property_id
  @internal_web_property_id
end

#kind ⇒ String

Collection type. Corresponds to the JSON property kind

Returns:

  • (String) 


4637
4638
4639
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4637

def kind
  @kind
end

#linked_ad_accounts ⇒ Array<Google::Apis::AnalyticsV3::LinkedForeignAccount>

The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. Corresponds to the JSON property linkedAdAccounts

Returns:



4643
4644
4645
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4643

def linked_ad_accounts
  @linked_ad_accounts
end

#linked_views ⇒ Array<String>

The views (profiles) that this remarketing audience is linked to. Corresponds to the JSON property linkedViews

Returns:

  • (Array<String>) 


4648
4649
4650
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4648

def linked_views
  @linked_views
end

#name ⇒ String

The name of this remarketing audience. Corresponds to the JSON property name

Returns:

  • (String) 


4653
4654
4655
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4653

def name
  @name
end

#state_based_audience_definition ⇒ Google::Apis::AnalyticsV3::RemarketingAudience::StateBasedAudienceDefinition

A state based audience definition that will cause a user to be added or removed from an audience. Corresponds to the JSON property stateBasedAudienceDefinition

Returns:



4659
4660
4661
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4659

def state_based_audience_definition
  @state_based_audience_definition
end

#updated ⇒ DateTime

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

Returns:

  • (DateTime) 


4664
4665
4666
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4664

def updated
  @updated
end

#web_property_id ⇒ String

Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. Corresponds to the JSON property webPropertyId

Returns:

  • (String) 


4670
4671
4672
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4670

def web_property_id
  @web_property_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4677

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @audience_definition = args[:audience_definition] if args.key?(:audience_definition)
  @audience_type = args[:audience_type] if args.key?(:audience_type)
  @created = args[:created] if args.key?(:created)
  @description = args[:description] if args.key?(:description)
  @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)
  @linked_ad_accounts = args[:linked_ad_accounts] if args.key?(:linked_ad_accounts)
  @linked_views = args[:linked_views] if args.key?(:linked_views)
  @name = args[:name] if args.key?(:name)
  @state_based_audience_definition = args[:state_based_audience_definition] if args.key?(:state_based_audience_definition)
  @updated = args[:updated] if args.key?(:updated)
  @web_property_id = args[:web_property_id] if args.key?(:web_property_id)
end