Class: AdzerkDecisionSdk::DecisionRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/adzerk_decision_sdk/models/decision_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DecisionRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 149

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#blocked_creatives ⇒ Object

Numeric creative ids to disregard for ad selection



36
37
38
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 36

def blocked_creatives
  @blocked_creatives
end

#consent ⇒ Object

Object that sets the data consent preferences. Other consent settings are available in the GDPR settings documentation.



54
55
56
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 54

def consent
  @consent
end

#device_id ⇒ Object

RTB requests only - sets an Identifier for Advertisers (IFA or IDFA)



57
58
59
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 57

def device_id
  @device_id
end

#enable_bot_filtering ⇒ Object

If making a client-side request, set to true. Defaults to false to ensure a server isn't seen as a bot. See [here](dev.adzerk.com/docs/tracking-overview#section-bot-filtering) for more info



48
49
50
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 48

def enable_bot_filtering
  @enable_bot_filtering
end

#enable_user_dbip ⇒ Object

If true, override the IP address of the request with the IP address supplied on the UserKey. If no IP address is found on the UserKey, this will fall back to the IP address on the request. Requires UserDB



51
52
53
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 51

def enable_user_dbip
  @enable_user_dbip
end

#include_matched_points ⇒ Object

Returns the value of attribute include_matched_points.



67
68
69
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 67

def include_matched_points
  @include_matched_points
end

#include_pricing_data ⇒ Object

If true, return pricing data for the decision in the response



42
43
44
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 42

def include_pricing_data
  @include_pricing_data
end

#intended_latitude ⇒ Object

Returns the value of attribute intended_latitude.



61
62
63
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 61

def intended_latitude
  @intended_latitude
end

#intended_longitude ⇒ Object

Returns the value of attribute intended_longitude.



63
64
65
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 63

def intended_longitude
  @intended_longitude
end

#ip ⇒ Object

The IP address. Required for [Geo-Targeting](dev.adzerk.com/docs/geo-location)



33
34
35
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 33

def ip
  @ip
end

#is_mobile ⇒ Object

If true, only ads containing a single image will be returned



39
40
41
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 39

def is_mobile
  @is_mobile
end

#keywords ⇒ Object

Keywords for keyword Targeting. Such as `"keywords": ["foo", "bar", "baz"]`.



24
25
26
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 24

def keywords
  @keywords
end

#notrack ⇒ Object

If true, only return ads that are set to honor Do Not Track



45
46
47
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 45

def notrack
  @notrack
end

#parallel ⇒ Object

Returns the value of attribute parallel.



59
60
61
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 59

def parallel
  @parallel
end

#placements ⇒ Object

One or more Placement objects



19
20
21
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 19

def placements
  @placements
end

#radius ⇒ Object

Returns the value of attribute radius.



65
66
67
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 65

def radius
  @radius
end

#referrer ⇒ Object

The referrer URL



30
31
32
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 30

def referrer
  @referrer
end

#url ⇒ Object

The current page URL



27
28
29
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 27

def url
  @url
end

#user ⇒ Object

Returns the value of attribute user.



21
22
23
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 21

def user
  @user
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 70

def self.attribute_map
  {
    :'placements' => :'placements',
    :'user' => :'user',
    :'keywords' => :'keywords',
    :'url' => :'url',
    :'referrer' => :'referrer',
    :'ip' => :'ip',
    :'blocked_creatives' => :'blockedCreatives',
    :'is_mobile' => :'isMobile',
    :'include_pricing_data' => :'includePricingData',
    :'notrack' => :'notrack',
    :'enable_bot_filtering' => :'enableBotFiltering',
    :'enable_user_dbip' => :'enableUserDBIP',
    :'consent' => :'consent',
    :'device_id' => :'deviceID',
    :'parallel' => :'parallel',
    :'intended_latitude' => :'intendedLatitude',
    :'intended_longitude' => :'intendedLongitude',
    :'radius' => :'radius',
    :'include_matched_points' => :'includeMatchedPoints'
  }
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



304
305
306
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 304

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 125

def self.openapi_nullable
  Set.new([
    :'keywords',
    :'url',
    :'referrer',
    :'ip',
    :'blocked_creatives',
    :'is_mobile',
    :'include_pricing_data',
    :'notrack',
    :'enable_bot_filtering',
    :'enable_user_dbip',
    :'consent',
    :'device_id',
    :'parallel',
    :'intended_latitude',
    :'intended_longitude',
    :'radius',
    :'include_matched_points'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 100

def self.openapi_types
  {
    :'placements' => :'Array<Placement>',
    :'user' => :'User',
    :'keywords' => :'Array<String>',
    :'url' => :'String',
    :'referrer' => :'String',
    :'ip' => :'String',
    :'blocked_creatives' => :'Array<Integer>',
    :'is_mobile' => :'Boolean',
    :'include_pricing_data' => :'Boolean',
    :'notrack' => :'Boolean',
    :'enable_bot_filtering' => :'Boolean',
    :'enable_user_dbip' => :'Boolean',
    :'consent' => :'Object',
    :'device_id' => :'String',
    :'parallel' => :'Boolean',
    :'intended_latitude' => :'Float',
    :'intended_longitude' => :'Float',
    :'radius' => :'Float',
    :'include_matched_points' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      placements == o.placements &&
      user == o.user &&
      keywords == o.keywords &&
      url == o.url &&
      referrer == o.referrer &&
      ip == o.ip &&
      blocked_creatives == o.blocked_creatives &&
      is_mobile == o.is_mobile &&
      include_pricing_data == o.include_pricing_data &&
      notrack == o.notrack &&
      enable_bot_filtering == o.enable_bot_filtering &&
      enable_user_dbip == o.enable_user_dbip &&
      consent == o.consent &&
      device_id == o.device_id &&
      parallel == o.parallel &&
      intended_latitude == o.intended_latitude &&
      intended_longitude == o.intended_longitude &&
      radius == o.radius &&
      include_matched_points == o.include_matched_points
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 334

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = AdzerkDecisionSdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 405

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 311

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


291
292
293
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



297
298
299
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 297

def hash
  [placements, user, keywords, url, referrer, ip, blocked_creatives, is_mobile, include_pricing_data, notrack, enable_bot_filtering, enable_user_dbip, consent, device_id, parallel, intended_latitude, intended_longitude, radius, include_matched_points].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



247
248
249
250
251
252
253
254
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 247

def list_invalid_properties
  invalid_properties = Array.new
  if @placements.nil?
    invalid_properties.push('invalid value for "placements", placements cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



381
382
383
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 381

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 387

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



375
376
377
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 375

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



258
259
260
261
 
# File 'lib/adzerk_decision_sdk/models/decision_request.rb', line 258

def valid?
  return false if @placements.nil?
  true
end