Class: Google::Apis::DfareportingV2_5::TargetableRemarketingList

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

Overview

Contains properties of a targetable 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 is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists 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) ⇒ TargetableRemarketingList

Returns a new instance of TargetableRemarketingList.



10697
10698
10699
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10697

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)


10634
10635
10636
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10634

def 
  @account_id
end

#activeBoolean Also known as: active?

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

Returns:

  • (Boolean)


10639
10640
10641
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10639

def active
  @active
end

#advertiser_idString

Dimension value for the advertiser ID that owns this targetable remarketing list. Corresponds to the JSON property advertiserId

Returns:

  • (String)


10646
10647
10648
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10646

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue



10651
10652
10653
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10651

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#descriptionString

Targetable remarketing list description. Corresponds to the JSON property description

Returns:

  • (String)


10656
10657
10658
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10656

def description
  @description
end

#idString

Targetable remarketing list ID. Corresponds to the JSON property id

Returns:

  • (String)


10661
10662
10663
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10661

def id
  @id
end

#kindString

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

Returns:

  • (String)


10667
10668
10669
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10667

def kind
  @kind
end

#life_spanString

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

Returns:

  • (String)


10673
10674
10675
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10673

def life_span
  @life_span
end

#list_sizeString

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

Returns:

  • (String)


10678
10679
10680
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10678

def list_size
  @list_size
end

#list_sourceString

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

Returns:

  • (String)


10683
10684
10685
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10683

def list_source
  @list_source
end

#nameString

Name of the targetable remarketing list. Is no greater than 128 characters long. Corresponds to the JSON property name

Returns:

  • (String)


10689
10690
10691
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10689

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)


10695
10696
10697
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10695

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 10702

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_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