Class: Google::Apis::DfareportingV2_1::TargetableRemarketingList

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

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ TargetableRemarketingList

Returns a new instance of TargetableRemarketingList.


10268
10269
10270
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10268

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)

10205
10206
10207
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10205

def 
  @account_id
end

#activeBoolean Also known as: active?

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

Returns:

  • (Boolean)

10210
10211
10212
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10210

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)

10217
10218
10219
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10217

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue


10222
10223
10224
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10222

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#descriptionString

Targetable remarketing list description. Corresponds to the JSON property description

Returns:

  • (String)

10227
10228
10229
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10227

def description
  @description
end

#idString

Targetable remarketing list ID. Corresponds to the JSON property id

Returns:

  • (String)

10232
10233
10234
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10232

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)

10238
10239
10240
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10238

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)

10244
10245
10246
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10244

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)

10249
10250
10251
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10249

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)

10254
10255
10256
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10254

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)

10260
10261
10262
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10260

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)

10266
10267
10268
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10266

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 10273

def update!(**args)
  @account_id = args[:account_id] unless args[:account_id].nil?
  @active = args[:active] unless args[:active].nil?
  @advertiser_id = args[:advertiser_id] unless args[:advertiser_id].nil?
  @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] unless args[:advertiser_id_dimension_value].nil?
  @description = args[:description] unless args[:description].nil?
  @id = args[:id] unless args[:id].nil?
  @kind = args[:kind] unless args[:kind].nil?
  @life_span = args[:life_span] unless args[:life_span].nil?
  @list_size = args[:list_size] unless args[:list_size].nil?
  @list_source = args[:list_source] unless args[:list_source].nil?
  @name = args[:name] unless args[:name].nil?
  @subaccount_id = args[:subaccount_id] unless args[:subaccount_id].nil?
end