Class: Google::Apis::DfareportingV3_0::TargetableRemarketingList

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



11265
11266
11267
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11265

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) 


11202
11203
11204
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11202

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) 


11207
11208
11209
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11207

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) 


11214
11215
11216
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11214

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_0::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



11219
11220
11221
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11219

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#description ⇒ String

Targetable remarketing list description. Corresponds to the JSON property description

Returns:

  • (String) 


11224
11225
11226
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11224

def description
  @description
end

#id ⇒ Fixnum

Targetable remarketing list ID. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


11229
11230
11231
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11229

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) 


11235
11236
11237
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11235

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) 


11241
11242
11243
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11241

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) 


11246
11247
11248
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11246

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) 


11251
11252
11253
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11251

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) 


11257
11258
11259
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11257

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) 


11263
11264
11265
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11263

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 11270

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