Class: Zernio::ValueRuleCriterion

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/value_rule_criterion.rb

Overview

One matching condition inside a value rule. criteriaValues and criteriaValueTypes are POSITIONALLY paired: same length, same order.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ValueRuleCriterion

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 96

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::ValueRuleCriterion` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::ValueRuleCriterion`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'criteria_type')
    self.criteria_type = attributes[:'criteria_type']
  else
    self.criteria_type = nil
  end

  if attributes.key?(:'operator')
    self.operator = attributes[:'operator']
  else
    self.operator = nil
  end

  if attributes.key?(:'criteria_values')
    if (value = attributes[:'criteria_values']).is_a?(Array)
      self.criteria_values = value
    end
  else
    self.criteria_values = nil
  end

  if attributes.key?(:'criteria_value_types')
    if (value = attributes[:'criteria_value_types']).is_a?(Array)
      self.criteria_value_types = value
    end
  else
    self.criteria_value_types = nil
  end
end

Instance Attribute Details

#criteria_type ⇒ Object

The dimension being matched. OMNI_CHANNEL (conversion location: APP, INSTANT_FORM, PHONE_CALL, WEBSITE) is accepted even though Meta's own enum table omits it.



23
24
25
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 23

def criteria_type
  @criteria_type
end

#criteria_value_types ⇒ Object

One entry per criteriaValues entry, in the same order. The literal \"NONE\" for every criteriaType except LOCATION, which uses LOCATION_COUNTRY, LOCATION_REGION, LOCATION_CITY or LOCATION_COMSCORE_MARKET and MAY mix them within one criterion. LOCATION_DMA was replaced by LOCATION_COMSCORE_MARKET on 2026-06-22 and is rejected by this API.



32
33
34
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 32

def criteria_value_types
  @criteria_value_types
end

#criteria_values ⇒ Object

The values to match. AGE takes ranges such as 18-24, 18+ or a custom 18-26; a range whose upper bound is 65 is NOT allowed (use 18+ instead of 18-65). LOCATION takes Targeting-Search keys: a two-letter country code for LOCATION_COUNTRY, a numeric key for region / city / comScore market. AUDIENCE_LABEL takes labels such as HIGH_VALUE, which are applied to a Custom Audience in Ads Manager: there is no API to provision them, so they are passed through unvalidated.



29
30
31
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 29

def criteria_values
  @criteria_values
end

#id ⇒ Object

Platform criterion id. Echo it on PUT to KEEP this criterion, omit it to CREATE a new one. A criterion left out of the array entirely is DELETED.



20
21
22
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 20

def id
  @id
end

#operator ⇒ Object

Required on every criterion. CONTAINS is currently the only value Meta supports.



26
27
28
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 26

def operator
  @operator
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



68
69
70
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 68

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 73

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



57
58
59
60
61
62
63
64
65
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 57

def self.attribute_map
  {
    :'id' => :'id',
    :'criteria_type' => :'criteriaType',
    :'operator' => :'operator',
    :'criteria_values' => :'criteriaValues',
    :'criteria_value_types' => :'criteriaValueTypes'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 267

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 89

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 78

def self.openapi_types
  {
    :'id' => :'String',
    :'criteria_type' => :'String',
    :'operator' => :'String',
    :'criteria_values' => :'Array<String>',
    :'criteria_value_types' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      criteria_type == o.criteria_type &&
      operator == o.operator &&
      criteria_values == o.criteria_values &&
      criteria_value_types == o.criteria_value_types
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 260

def hash
  [id, criteria_type, operator, criteria_values, criteria_value_types].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 145

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @criteria_type.nil?
    invalid_properties.push('invalid value for "criteria_type", criteria_type cannot be nil.')
  end

  if @operator.nil?
    invalid_properties.push('invalid value for "operator", operator cannot be nil.')
  end

  if @criteria_values.nil?
    invalid_properties.push('invalid value for "criteria_values", criteria_values cannot be nil.')
  end

  if @criteria_values.length < 1
    invalid_properties.push('invalid value for "criteria_values", number of items must be greater than or equal to 1.')
  end

  if @criteria_value_types.nil?
    invalid_properties.push('invalid value for "criteria_value_types", criteria_value_types cannot be nil.')
  end

  if @criteria_value_types.length < 1
    invalid_properties.push('invalid value for "criteria_value_types", number of items must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 289

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/zernio-sdk/models/value_rule_criterion.rb', line 177

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @criteria_type.nil?
  criteria_type_validator = EnumAttributeValidator.new('String', ["AGE", "GENDER", "OS_TYPE", "DEVICE_PLATFORM", "LOCATION", "PLACEMENT", "OMNI_CHANNEL", "AUDIENCE_LABEL"])
  return false unless criteria_type_validator.valid?(@criteria_type)
  return false if @operator.nil?
  operator_validator = EnumAttributeValidator.new('String', ["CONTAINS"])
  return false unless operator_validator.valid?(@operator)
  return false if @criteria_values.nil?
  return false if @criteria_values.length < 1
  return false if @criteria_value_types.nil?
  return false if @criteria_value_types.length < 1
  true
end