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 facilitate 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.



12030
12031
12032
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12030

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) 


11967
11968
11969
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11967

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) 


11972
11973
11974
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11972

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) 


11979
11980
11981
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11979

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:



11984
11985
11986
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11984

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#description ⇒ String

Targetable remarketing list description. Corresponds to the JSON property description

Returns:

  • (String) 


11989
11990
11991
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11989

def description
  @description
end

#id ⇒ Fixnum

Targetable remarketing list ID. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


11994
11995
11996
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11994

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) 


12000
12001
12002
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12000

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) 


12006
12007
12008
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12006

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) 


12011
12012
12013
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12011

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) 


12016
12017
12018
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12016

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) 


12022
12023
12024
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12022

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) 


12028
12029
12030
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12028

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 12035

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