Class: Google::Apis::DfareportingV2_8::RemarketingList

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



9538
9539
9540
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9538

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

Instance Attribute Details

#account_id ⇒ Fixnum

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:

  • (Fixnum) 


9470
9471
9472
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9470

def 
  @account_id
end

#active ⇒ Boolean Also known as: active?

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

Returns:

  • (Boolean) 


9475
9476
9477
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9475

def active
  @active
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9482
9483
9484
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9482

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_8::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



9487
9488
9489
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9487

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#description ⇒ String

Remarketing list description. Corresponds to the JSON property description

Returns:

  • (String) 


9492
9493
9494
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9492

def description
  @description
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9497
9498
9499
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9497

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


9503
9504
9505
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9503

def kind
  @kind
end

#life_span ⇒ Fixnum

Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive. Corresponds to the JSON property lifeSpan

Returns:

  • (Fixnum) 


9509
9510
9511
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9509

def life_span
  @life_span
end

#list_population_rule ⇒ Google::Apis::DfareportingV2_8::ListPopulationRule

Remarketing List Population Rule. Corresponds to the JSON property listPopulationRule

Returns:



9514
9515
9516
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9514

def list_population_rule
  @list_population_rule
end

#list_size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9519
9520
9521
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9519

def list_size
  @list_size
end

#list_source ⇒ String

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

Returns:

  • (String) 


9524
9525
9526
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9524

def list_source
  @list_source
end

#name ⇒ String

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) 


9530
9531
9532
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9530

def name
  @name
end

#subaccount_id ⇒ Fixnum

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:

  • (Fixnum) 


9536
9537
9538
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9536

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 9543

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