Class: Google::Apis::DfareportingV3_1::RemarketingList
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_1::RemarketingList
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_1/classes.rb,
generated/google/apis/dfareporting_v3_1/representations.rb,
generated/google/apis/dfareporting_v3_1/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
-
#account_id ⇒ Fixnum
Account ID of this remarketing list.
-
#active ⇒ Boolean
(also: #active?)
Whether this remarketing list is active.
-
#advertiser_id ⇒ Fixnum
Dimension value for the advertiser ID that owns this remarketing list.
-
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_1::DimensionValue
Represents a DimensionValue resource.
-
#description ⇒ String
Remarketing list description.
-
#id ⇒ Fixnum
Remarketing list ID.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#life_span ⇒ Fixnum
Number of days that a user should remain in the remarketing list without an impression.
-
#list_population_rule ⇒ Google::Apis::DfareportingV3_1::ListPopulationRule
Remarketing List Population Rule.
-
#list_size ⇒ Fixnum
Number of users currently in the list.
-
#list_source ⇒ String
Product from which this remarketing list was originated.
-
#name ⇒ String
Name of the remarketing list.
-
#subaccount_id ⇒ Fixnum
Subaccount ID of this remarketing list.
Instance Method Summary collapse
-
#initialize(**args) ⇒ RemarketingList
constructor
A new instance of RemarketingList.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ RemarketingList
Returns a new instance of RemarketingList
9751 9752 9753 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9751 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
9683 9684 9685 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9683 def account_id @account_id end |
#active ⇒ Boolean Also known as: active?
Whether this remarketing list is active.
Corresponds to the JSON property active
9688 9689 9690 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9688 def active @active end |
#advertiser_id ⇒ Fixnum
Dimension value for the advertiser ID that owns this remarketing list. This is
a required field.
Corresponds to the JSON property advertiserId
9695 9696 9697 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9695 def advertiser_id @advertiser_id end |
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_1::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property advertiserIdDimensionValue
9700 9701 9702 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9700 def advertiser_id_dimension_value @advertiser_id_dimension_value end |
#description ⇒ String
Remarketing list description.
Corresponds to the JSON property description
9705 9706 9707 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9705 def description @description end |
#id ⇒ Fixnum
Remarketing list ID. This is a read-only, auto-generated field.
Corresponds to the JSON property id
9710 9711 9712 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9710 def id @id end |
#kind ⇒ String
Identifies what kind of resource this is. Value: the fixed string "
dfareporting#remarketingList".
Corresponds to the JSON property kind
9716 9717 9718 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9716 def kind @kind end |
#life_span ⇒ Fixnum
Number of days that a user should remain in the remarketing list without an
impression. Acceptable values are 1 to 540, inclusive.
Corresponds to the JSON property lifeSpan
9722 9723 9724 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9722 def life_span @life_span end |
#list_population_rule ⇒ Google::Apis::DfareportingV3_1::ListPopulationRule
Remarketing List Population Rule.
Corresponds to the JSON property listPopulationRule
9727 9728 9729 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9727 def list_population_rule @list_population_rule end |
#list_size ⇒ Fixnum
Number of users currently in the list. This is a read-only field.
Corresponds to the JSON property listSize
9732 9733 9734 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9732 def list_size @list_size end |
#list_source ⇒ String
Product from which this remarketing list was originated.
Corresponds to the JSON property listSource
9737 9738 9739 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9737 def list_source @list_source end |
#name ⇒ String
Name of the remarketing list. This is a required field. Must be no greater
than 128 characters long.
Corresponds to the JSON property name
9743 9744 9745 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9743 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
9749 9750 9751 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9749 def subaccount_id @subaccount_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 |
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 9756 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 |