Class: Google::Apis::DfareportingV2_1::RemarketingList

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable
Defined in:
generated/google/apis/dfareporting_v2_1/classes.rb,
generated/google/apis/dfareporting_v2_1/representations.rb,
generated/google/apis/dfareporting_v2_1/representations.rb

Overview

Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ RemarketingList

Returns a new instance of RemarketingList.


8717
8718
8719
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8717

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

Instance Attribute Details

#account_idString

Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. Corresponds to the JSON property accountId

Returns:

  • (String)

8649
8650
8651
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8649

def 
  @account_id
end

#activeBoolean Also known as: active?

Whether this remarketing list is active. Corresponds to the JSON property active

Returns:

  • (Boolean)

8654
8655
8656
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8654

def active
  @active
end

#advertiser_idString

Dimension value for the advertiser ID that owns this remarketing list. This is a required field. Corresponds to the JSON property advertiserId

Returns:

  • (String)

8661
8662
8663
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8661

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue


8666
8667
8668
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8666

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#descriptionString

Remarketing list description. Corresponds to the JSON property description

Returns:

  • (String)

8671
8672
8673
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8671

def description
  @description
end

#idString

Remarketing list ID. This is a read-only, auto-generated field. Corresponds to the JSON property id

Returns:

  • (String)

8676
8677
8678
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8676

def id
  @id
end

#kindString

Identifies what kind of resource this is. Value: the fixed string " dfareporting#remarketingList". Corresponds to the JSON property kind

Returns:

  • (String)

8682
8683
8684
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8682

def kind
  @kind
end

#life_spanString

Number of days that a user should remain in the remarketing list without an impression. Corresponds to the JSON property lifeSpan

Returns:

  • (String)

8688
8689
8690
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8688

def life_span
  @life_span
end

#list_population_ruleGoogle::Apis::DfareportingV2_1::ListPopulationRule

Remarketing List Population Rule. Corresponds to the JSON property listPopulationRule


8693
8694
8695
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8693

def list_population_rule
  @list_population_rule
end

#list_sizeString

Number of users currently in the list. This is a read-only field. Corresponds to the JSON property listSize

Returns:

  • (String)

8698
8699
8700
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8698

def list_size
  @list_size
end

#list_sourceString

Product from which this remarketing list was originated. Corresponds to the JSON property listSource

Returns:

  • (String)

8703
8704
8705
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8703

def list_source
  @list_source
end

#nameString

Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. Corresponds to the JSON property name

Returns:

  • (String)

8709
8710
8711
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8709

def name
  @name
end

#subaccount_idString

Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests. Corresponds to the JSON property subaccountId

Returns:

  • (String)

8715
8716
8717
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8715

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 8722

def update!(**args)
  @account_id = args[:account_id] unless args[:account_id].nil?
  @active = args[:active] unless args[:active].nil?
  @advertiser_id = args[:advertiser_id] unless args[:advertiser_id].nil?
  @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] unless args[:advertiser_id_dimension_value].nil?
  @description = args[:description] unless args[:description].nil?
  @id = args[:id] unless args[:id].nil?
  @kind = args[:kind] unless args[:kind].nil?
  @life_span = args[:life_span] unless args[:life_span].nil?
  @list_population_rule = args[:list_population_rule] unless args[:list_population_rule].nil?
  @list_size = args[:list_size] unless args[:list_size].nil?
  @list_source = args[:list_source] unless args[:list_source].nil?
  @name = args[:name] unless args[:name].nil?
  @subaccount_id = args[:subaccount_id] unless args[:subaccount_id].nil?
end