Class: Google::Apis::DfareportingV2_3::TargetableRemarketingList

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


10311
10312
10313
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10311

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)

10248
10249
10250
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10248

def 
  @account_id
end

#activeBoolean Also known as: active?

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

Returns:

  • (Boolean)

10253
10254
10255
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10253

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)

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

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue


10265
10266
10267
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10265

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#descriptionString

Targetable remarketing list description. Corresponds to the JSON property description

Returns:

  • (String)

10270
10271
10272
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10270

def description
  @description
end

#idString

Targetable remarketing list ID. Corresponds to the JSON property id

Returns:

  • (String)

10275
10276
10277
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10275

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)

10281
10282
10283
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10281

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)

10287
10288
10289
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10287

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)

10292
10293
10294
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10292

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)

10297
10298
10299
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10297

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)

10303
10304
10305
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10303

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)

10309
10310
10311
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10309

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 10316

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