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.


4646
4647
4648
# File 'generated/google/apis/analytics_v3/classes.rb', line 4646

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

Instance Attribute Details

#account_idString

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

Returns:

  • (String)

4575
4576
4577
# File 'generated/google/apis/analytics_v3/classes.rb', line 4575

def 
  @account_id
end

#audience_definitionGoogle::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


4581
4582
4583
# File 'generated/google/apis/analytics_v3/classes.rb', line 4581

def audience_definition
  @audience_definition
end

#audience_typeString

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

Returns:

  • (String)

4586
4587
4588
# File 'generated/google/apis/analytics_v3/classes.rb', line 4586

def audience_type
  @audience_type
end

#createdDateTime

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

Returns:

  • (DateTime)

4591
4592
4593
# File 'generated/google/apis/analytics_v3/classes.rb', line 4591

def created
  @created
end

#descriptionString

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

Returns:

  • (String)

4596
4597
4598
# File 'generated/google/apis/analytics_v3/classes.rb', line 4596

def description
  @description
end

#idString

Remarketing Audience ID. Corresponds to the JSON property id

Returns:

  • (String)

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

def id
  @id
end

#internal_web_property_idString

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

Returns:

  • (String)

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

def internal_web_property_id
  @internal_web_property_id
end

#kindString

Collection type. Corresponds to the JSON property kind

Returns:

  • (String)

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

def kind
  @kind
end

#linked_ad_accountsArray<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


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

def linked_ad_accounts
  @linked_ad_accounts
end

#linked_viewsArray<String>

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

Returns:

  • (Array<String>)

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

def linked_views
  @linked_views
end

#nameString

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

Returns:

  • (String)

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

def name
  @name
end

#state_based_audience_definitionGoogle::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


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

def state_based_audience_definition
  @state_based_audience_definition
end

#updatedDateTime

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

Returns:

  • (DateTime)

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

def updated
  @updated
end

#web_property_idString

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

Returns:

  • (String)

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

def web_property_id
  @web_property_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
# File 'generated/google/apis/analytics_v3/classes.rb', line 4651

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