Class: Google::Apis::DfareportingV2_6::RemarketingList

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_6/classes.rb,
generated/google/apis/dfareporting_v2_6/representations.rb,
generated/google/apis/dfareporting_v2_6/representations.rb

Overview

Contains properties of a 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 can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists 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) ⇒ RemarketingList

Returns a new instance of RemarketingList.


9329
9330
9331
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9329

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)

9261
9262
9263
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9261

def 
  @account_id
end

#activeBoolean Also known as: active?

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

Returns:

  • (Boolean)

9266
9267
9268
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9266

def active
  @active
end

#advertiser_idString

Dimension value for the advertiser ID that owns this remarketing list. This is a required field. Corresponds to the JSON property advertiserId

Returns:

  • (String)

9273
9274
9275
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9273

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue


9278
9279
9280
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9278

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#descriptionString

Remarketing list description. Corresponds to the JSON property description

Returns:

  • (String)

9283
9284
9285
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9283

def description
  @description
end

#idString

Remarketing list ID. This is a read-only, auto-generated field. Corresponds to the JSON property id

Returns:

  • (String)

9288
9289
9290
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9288

def id
  @id
end

#kindString

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

Returns:

  • (String)

9294
9295
9296
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9294

def kind
  @kind
end

#life_spanString

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

Returns:

  • (String)

9300
9301
9302
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9300

def life_span
  @life_span
end

#list_population_ruleGoogle::Apis::DfareportingV2_6::ListPopulationRule

Remarketing List Population Rule. Corresponds to the JSON property listPopulationRule


9305
9306
9307
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9305

def list_population_rule
  @list_population_rule
end

#list_sizeString

Number of users currently in the list. This is a read-only field. Corresponds to the JSON property listSize

Returns:

  • (String)

9310
9311
9312
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9310

def list_size
  @list_size
end

#list_sourceString

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

Returns:

  • (String)

9315
9316
9317
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9315

def list_source
  @list_source
end

#nameString

Name of the remarketing list. This is a required field. Must be no greater than 128 characters long. Corresponds to the JSON property name

Returns:

  • (String)

9321
9322
9323
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9321

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)

9327
9328
9329
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9327

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9334

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_population_rule = args[:list_population_rule] if args.key?(:list_population_rule)
  @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