Class: Google::Apis::DfareportingV4::TargetableRemarketingList

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

Constructor Details

#initialize(**args) ⇒ TargetableRemarketingList

Returns a new instance of TargetableRemarketingList.



12451
12452
12453
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12451

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) 


12388
12389
12390
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12388

def 
  @account_id
end

#active ⇒ Boolean Also known as: active?

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

Returns:

  • (Boolean) 


12393
12394
12395
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12393

def active
  @active
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


12400
12401
12402
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12400

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



12405
12406
12407
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12405

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#description ⇒ String

Targetable remarketing list description. Corresponds to the JSON property description

Returns:

  • (String) 


12410
12411
12412
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12410

def description
  @description
end

#id ⇒ Fixnum

Targetable remarketing list ID. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


12415
12416
12417
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12415

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


12421
12422
12423
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12421

def kind
  @kind
end

#life_span ⇒ Fixnum

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

Returns:

  • (Fixnum) 


12427
12428
12429
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12427

def life_span
  @life_span
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) 


12432
12433
12434
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12432

def list_size
  @list_size
end

#list_source ⇒ String

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

Returns:

  • (String) 


12437
12438
12439
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12437

def list_source
  @list_source
end

#name ⇒ String

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

Returns:

  • (String) 


12443
12444
12445
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12443

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) 


12449
12450
12451
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12449

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12456

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