Class: Google::Apis::DfareportingV3_3::RemarketingList
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_3::RemarketingList
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/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_3::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_3::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.
9640 9641 9642 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9640 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
9572 9573 9574 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9572 def account_id @account_id end |
#active ⇒ Boolean Also known as: active?
Whether this remarketing list is active.
Corresponds to the JSON property active
9577 9578 9579 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9577 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
9584 9585 9586 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9584 def advertiser_id @advertiser_id end |
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property advertiserIdDimensionValue
9589 9590 9591 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9589 def advertiser_id_dimension_value @advertiser_id_dimension_value end |
#description ⇒ String
Remarketing list description.
Corresponds to the JSON property description
9594 9595 9596 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9594 def description @description end |
#id ⇒ Fixnum
Remarketing list ID. This is a read-only, auto-generated field.
Corresponds to the JSON property id
9599 9600 9601 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9599 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
9605 9606 9607 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9605 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
9611 9612 9613 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9611 def life_span @life_span end |
#list_population_rule ⇒ Google::Apis::DfareportingV3_3::ListPopulationRule
Remarketing List Population Rule.
Corresponds to the JSON property listPopulationRule
9616 9617 9618 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9616 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
9621 9622 9623 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9621 def list_size @list_size end |
#list_source ⇒ String
Product from which this remarketing list was originated.
Corresponds to the JSON property listSource
9626 9627 9628 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9626 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
9632 9633 9634 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9632 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
9638 9639 9640 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9638 def subaccount_id @subaccount_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 9645 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 |