Class: Google::Apis::DfareportingV3_5::ListPopulationTerm

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

Overview

Remarketing List Population Rule Term.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ListPopulationTerm

Returns a new instance of ListPopulationTerm.



7135
7136
7137
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 7135

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) 


7084
7085
7086
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 7084

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) 


7092
7093
7094
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 7092

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) 


7099
7100
7101
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 7099

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) 


7105
7106
7107
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 7105

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) 


7114
7115
7116
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 7114

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) 


7120
7121
7122
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 7120

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) 


7127
7128
7129
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 7127

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) 


7133
7134
7135
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 7133

def variable_name
  @variable_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 7140

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