Class: Google::Apis::DfareportingV3_0::ListPopulationTerm

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

Overview

Remarketing List Population Rule Term.

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) ⇒ ListPopulationTerm

Returns a new instance of ListPopulationTerm



7147
7148
7149
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 7147

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#contains ⇒ Boolean Also known as: contains?

Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. Corresponds to the JSON property contains

Returns:

  • (Boolean) 


7096
7097
7098
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 7096

def contains
  @contains
end

#negation ⇒ Boolean Also known as: negation?

Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. Corresponds to the JSON property negation

Returns:

  • (Boolean) 


7104
7105
7106
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 7104

def negation
  @negation
end

#operator ⇒ String

Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. Corresponds to the JSON property operator

Returns:

  • (String) 


7111
7112
7113
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 7111

def operator
  @operator
end

#remarketing_list_id ⇒ Fixnum

ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. Corresponds to the JSON property remarketingListId

Returns:

  • (Fixnum) 


7117
7118
7119
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 7117

def remarketing_list_id
  @remarketing_list_id
end

#type ⇒ String

List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. Corresponds to the JSON property type

Returns:

  • (String) 


7126
7127
7128
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 7126

def type
  @type
end

#value ⇒ String

Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. Corresponds to the JSON property value

Returns:

  • (String) 


7132
7133
7134
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 7132

def value
  @value
end

#variable_friendly_name ⇒ String

Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. Corresponds to the JSON property variableFriendlyName

Returns:

  • (String) 


7139
7140
7141
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 7139

def variable_friendly_name
  @variable_friendly_name
end

#variable_name ⇒ String

Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. Corresponds to the JSON property variableName

Returns:

  • (String) 


7145
7146
7147
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 7145

def variable_name
  @variable_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 7152

def update!(**args)
  @contains = args[:contains] if args.key?(:contains)
  @negation = args[:negation] if args.key?(:negation)
  @operator = args[:operator] if args.key?(:operator)
  @remarketing_list_id = args[:remarketing_list_id] if args.key?(:remarketing_list_id)
  @type = args[:type] if args.key?(:type)
  @value = args[:value] if args.key?(:value)
  @variable_friendly_name = args[:variable_friendly_name] if args.key?(:variable_friendly_name)
  @variable_name = args[:variable_name] if args.key?(:variable_name)
end