Class: Google::Apis::DfareportingV2_5::RemarketingList

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


9133
9134
9135
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9133

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)

9065
9066
9067
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9065

def 
  @account_id
end

#activeBoolean Also known as: active?

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

Returns:

  • (Boolean)

9070
9071
9072
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9070

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)

9077
9078
9079
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9077

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue


9082
9083
9084
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9082

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#descriptionString

Remarketing list description. Corresponds to the JSON property description

Returns:

  • (String)

9087
9088
9089
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9087

def description
  @description
end

#idString

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

Returns:

  • (String)

9092
9093
9094
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9092

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)

9098
9099
9100
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9098

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)

9104
9105
9106
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9104

def life_span
  @life_span
end

#list_population_ruleGoogle::Apis::DfareportingV2_5::ListPopulationRule

Remarketing List Population Rule. Corresponds to the JSON property listPopulationRule


9109
9110
9111
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9109

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)

9114
9115
9116
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9114

def list_size
  @list_size
end

#list_sourceString

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

Returns:

  • (String)

9119
9120
9121
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9119

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)

9125
9126
9127
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9125

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)

9131
9132
9133
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9131

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9138

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