Class: Google::Apis::DfareportingV3_4::RemarketingList

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



10044
10045
10046
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10044

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

Returns:

  • (Fixnum) 


9976
9977
9978
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 9976

def 
  @account_id
end

#active ⇒ Boolean Also known as: active?

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

Returns:

  • (Boolean) 


9981
9982
9983
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 9981

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

Returns:

  • (Fixnum) 


9988
9989
9990
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 9988

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



9993
9994
9995
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 9993

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#description ⇒ String

Remarketing list description. Corresponds to the JSON property description

Returns:

  • (String) 


9998
9999
10000
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 9998

def description
  @description
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


10003
10004
10005
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10003

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

Returns:

  • (String) 


10009
10010
10011
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10009

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

Returns:

  • (Fixnum) 


10015
10016
10017
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10015

def life_span
  @life_span
end

#list_population_rule ⇒ Google::Apis::DfareportingV3_4::ListPopulationRule

Remarketing List Population Rule. Corresponds to the JSON property listPopulationRule

Returns:



10020
10021
10022
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10020

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

Returns:

  • (Fixnum) 


10025
10026
10027
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10025

def list_size
  @list_size
end

#list_source ⇒ String

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

Returns:

  • (String) 


10030
10031
10032
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10030

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

Returns:

  • (String) 


10036
10037
10038
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10036

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

Returns:

  • (Fixnum) 


10042
10043
10044
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10042

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10049

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