Class: Google::Apis::DfareportingV2_3::RemarketingList

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_3/classes.rb,
generated/google/apis/dfareporting_v2_3/representations.rb,
generated/google/apis/dfareporting_v2_3/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::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ RemarketingList

Returns a new instance of RemarketingList.


8747
8748
8749
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8747

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)

8679
8680
8681
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8679

def 
  @account_id
end

#activeBoolean Also known as: active?

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

Returns:

  • (Boolean)

8684
8685
8686
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8684

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)

8691
8692
8693
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8691

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue


8696
8697
8698
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8696

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#descriptionString

Remarketing list description. Corresponds to the JSON property description

Returns:

  • (String)

8701
8702
8703
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8701

def description
  @description
end

#idString

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

Returns:

  • (String)

8706
8707
8708
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8706

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)

8712
8713
8714
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8712

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)

8718
8719
8720
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8718

def life_span
  @life_span
end

#list_population_ruleGoogle::Apis::DfareportingV2_3::ListPopulationRule

Remarketing List Population Rule. Corresponds to the JSON property listPopulationRule


8723
8724
8725
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8723

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)

8728
8729
8730
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8728

def list_size
  @list_size
end

#list_sourceString

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

Returns:

  • (String)

8733
8734
8735
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8733

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)

8739
8740
8741
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8739

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)

8745
8746
8747
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8745

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 8752

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