Class: AdzerkDecisionSdk::UserdbApi

Inherits:
Object
  • Object
show all
Defined in:
lib/adzerk_decision_sdk/api/userdb_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserdbApi

Returns a new instance of UserdbApi.



19
20
21
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_custom_properties(network_id, user_key, opts = {}) ⇒ File

Add Custom Properties to a User

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User's UserDB Key

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

    the optional parameters

Options Hash (opts):

  • :body (Object)

Returns:

  • (File) 


28
29
30
31
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 28

def add_custom_properties(network_id, user_key, opts = {})
  data, _status_code, _headers = add_custom_properties_with_http_info(network_id, user_key, opts)
  data
end

#add_custom_properties_with_http_info(network_id, user_key, opts = {}) ⇒ Array<(File, Integer, Hash)>

Add Custom Properties to a User

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

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

    the optional parameters

Options Hash (opts):

  • :body (Object)

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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/api/userdb_api.rb', line 39

def add_custom_properties_with_http_info(network_id, user_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserdbApi.add_custom_properties ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling UserdbApi.add_custom_properties"
  end
  # verify the required parameter 'user_key' is set
  if @api_client.config.client_side_validation && user_key.nil?
    fail ArgumentError, "Missing the required parameter 'user_key' when calling UserdbApi.add_custom_properties"
  end
  # resource path
  local_var_path = '/udb/{networkId}/custom'.sub('{' + 'networkId' + '}', CGI.escape(network_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'userKey'] = user_key

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/gif'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"UserdbApi.add_custom_properties",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserdbApi#add_custom_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_interests(network_id, user_key, interest, opts = {}) ⇒ File

Add Interests to a User

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

  • interest (String) —

    Comma Seperated list of interests

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

    the optional parameters

Returns:

  • (File) 


100
101
102
103
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 100

def add_interests(network_id, user_key, interest, opts = {})
  data, _status_code, _headers = add_interests_with_http_info(network_id, user_key, interest, opts)
  data
end

#add_interests_with_http_info(network_id, user_key, interest, opts = {}) ⇒ Array<(File, Integer, Hash)>

Add Interests to a User

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

  • interest (String) —

    Comma Seperated list of interests

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 111

def add_interests_with_http_info(network_id, user_key, interest, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserdbApi.add_interests ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling UserdbApi.add_interests"
  end
  # verify the required parameter 'user_key' is set
  if @api_client.config.client_side_validation && user_key.nil?
    fail ArgumentError, "Missing the required parameter 'user_key' when calling UserdbApi.add_interests"
  end
  # verify the required parameter 'interest' is set
  if @api_client.config.client_side_validation && interest.nil?
    fail ArgumentError, "Missing the required parameter 'interest' when calling UserdbApi.add_interests"
  end
  # resource path
  local_var_path = '/udb/{networkId}/interest/i.gif'.sub('{' + 'networkId' + '}', CGI.escape(network_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'userKey'] = user_key
  query_params[:'interest'] = interest

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/gif'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"UserdbApi.add_interests",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserdbApi#add_interests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_retargeting_segment(network_id, advertiser_id, retargeting_segment_id, user_key, opts = {}) ⇒ File

Add User to a Retargeting Segment

Parameters:

  • network_id (Integer) —

    Your Network Id

  • advertiser_id (Integer) —

    The Advertiser&#39;s ID

  • retargeting_segment_id (Integer) —

    The Segment&#39;s ID

  • user_key (String) —

    The User&#39;s UserDB Key

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

    the optional parameters

Returns:

  • (File) 


176
177
178
179
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 176

def add_retargeting_segment(network_id, advertiser_id, retargeting_segment_id, user_key, opts = {})
  data, _status_code, _headers = add_retargeting_segment_with_http_info(network_id, advertiser_id, retargeting_segment_id, user_key, opts)
  data
end

#add_retargeting_segment_with_http_info(network_id, advertiser_id, retargeting_segment_id, user_key, opts = {}) ⇒ Array<(File, Integer, Hash)>

Add User to a Retargeting Segment

Parameters:

  • network_id (Integer) —

    Your Network Id

  • advertiser_id (Integer) —

    The Advertiser&#39;s ID

  • retargeting_segment_id (Integer) —

    The Segment&#39;s ID

  • user_key (String) —

    The User&#39;s UserDB Key

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
244
245
246
247
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 188

def add_retargeting_segment_with_http_info(network_id, advertiser_id, retargeting_segment_id, user_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserdbApi.add_retargeting_segment ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling UserdbApi.add_retargeting_segment"
  end
  # verify the required parameter 'advertiser_id' is set
  if @api_client.config.client_side_validation && advertiser_id.nil?
    fail ArgumentError, "Missing the required parameter 'advertiser_id' when calling UserdbApi.add_retargeting_segment"
  end
  # verify the required parameter 'retargeting_segment_id' is set
  if @api_client.config.client_side_validation && retargeting_segment_id.nil?
    fail ArgumentError, "Missing the required parameter 'retargeting_segment_id' when calling UserdbApi.add_retargeting_segment"
  end
  # verify the required parameter 'user_key' is set
  if @api_client.config.client_side_validation && user_key.nil?
    fail ArgumentError, "Missing the required parameter 'user_key' when calling UserdbApi.add_retargeting_segment"
  end
  # resource path
  local_var_path = '/udb/{networkId}/rt/{advertiserId}/{retargetingSegmentId}/i.gif'.sub('{' + 'networkId' + '}', CGI.escape(network_id.to_s)).sub('{' + 'advertiserId' + '}', CGI.escape(advertiser_id.to_s)).sub('{' + 'retargetingSegmentId' + '}', CGI.escape(retargeting_segment_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'userKey'] = user_key

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/gif'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"UserdbApi.add_retargeting_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserdbApi#add_retargeting_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#forget(network_id, user_key, opts = {}) ⇒ nil

Forget User

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

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

    the optional parameters

Returns:

  • (nil) 


254
255
256
257
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 254

def forget(network_id, user_key, opts = {})
  forget_with_http_info(network_id, user_key, opts)
  nil
end

#forget_with_http_info(network_id, user_key, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Forget User

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 264

def forget_with_http_info(network_id, user_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserdbApi.forget ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling UserdbApi.forget"
  end
  # verify the required parameter 'user_key' is set
  if @api_client.config.client_side_validation && user_key.nil?
    fail ArgumentError, "Missing the required parameter 'user_key' when calling UserdbApi.forget"
  end
  # resource path
  local_var_path = '/udb/{networkId}'.sub('{' + 'networkId' + '}', CGI.escape(network_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'userKey'] = user_key

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"UserdbApi.forget",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserdbApi#forget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#gdpr_consent(network_id, opts = {}) ⇒ File

GDPR Consent

Parameters:

  • network_id (Integer) —

    Your Network Id

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

    the optional parameters

Options Hash (opts):

Returns:

  • (File) 


320
321
322
323
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 320

def gdpr_consent(network_id, opts = {})
  data, _status_code, _headers = gdpr_consent_with_http_info(network_id, opts)
  data
end

#gdpr_consent_with_http_info(network_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

GDPR Consent

Parameters:

  • network_id (Integer) —

    Your Network Id

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



330
331
332
333
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
372
373
374
375
376
377
378
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 330

def gdpr_consent_with_http_info(network_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserdbApi.gdpr_consent ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling UserdbApi.gdpr_consent"
  end
  # resource path
  local_var_path = '/udb/{networkId}/consent'.sub('{' + 'networkId' + '}', CGI.escape(network_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/gif'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'consent_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"UserdbApi.gdpr_consent",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserdbApi#gdpr_consent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ip_override(network_id, user_key, ip, opts = {}) ⇒ File

IP Address Override

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

  • ip (String) —

    This is the IP to exclude

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

    the optional parameters

Returns:

  • (File) 


386
387
388
389
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 386

def ip_override(network_id, user_key, ip, opts = {})
  data, _status_code, _headers = ip_override_with_http_info(network_id, user_key, ip, opts)
  data
end

#ip_override_with_http_info(network_id, user_key, ip, opts = {}) ⇒ Array<(File, Integer, Hash)>

IP Address Override

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

  • ip (String) —

    This is the IP to exclude

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 397

def ip_override_with_http_info(network_id, user_key, ip, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserdbApi.ip_override ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling UserdbApi.ip_override"
  end
  # verify the required parameter 'user_key' is set
  if @api_client.config.client_side_validation && user_key.nil?
    fail ArgumentError, "Missing the required parameter 'user_key' when calling UserdbApi.ip_override"
  end
  # verify the required parameter 'ip' is set
  if @api_client.config.client_side_validation && ip.nil?
    fail ArgumentError, "Missing the required parameter 'ip' when calling UserdbApi.ip_override"
  end
  # resource path
  local_var_path = '/udb/{networkId}/ip/i.gif'.sub('{' + 'networkId' + '}', CGI.escape(network_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'userKey'] = user_key
  query_params[:'ip'] = ip

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/gif'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"UserdbApi.ip_override",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserdbApi#ip_override\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#match_user(network_id, user_key, partner_id, user_id, opts = {}) ⇒ File

User Matching

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

  • partner_id (Integer) —

    The ID of the RTB provider in Adzerk. Contact Support if you don&#39;t have the ID.

  • user_id (Integer) —

    This is the UserID the individual RTB provider has of the user. This is NOT the UserDB userkey.

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

    the optional parameters

Returns:

  • (File) 


462
463
464
465
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 462

def match_user(network_id, user_key, partner_id, user_id, opts = {})
  data, _status_code, _headers = match_user_with_http_info(network_id, user_key, partner_id, user_id, opts)
  data
end

#match_user_with_http_info(network_id, user_key, partner_id, user_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

User Matching

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

  • partner_id (Integer) —

    The ID of the RTB provider in Adzerk. Contact Support if you don&#39;t have the ID.

  • user_id (Integer) —

    This is the UserID the individual RTB provider has of the user. This is NOT the UserDB userkey.

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 474

def match_user_with_http_info(network_id, user_key, partner_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserdbApi.match_user ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling UserdbApi.match_user"
  end
  # verify the required parameter 'user_key' is set
  if @api_client.config.client_side_validation && user_key.nil?
    fail ArgumentError, "Missing the required parameter 'user_key' when calling UserdbApi.match_user"
  end
  # verify the required parameter 'partner_id' is set
  if @api_client.config.client_side_validation && partner_id.nil?
    fail ArgumentError, "Missing the required parameter 'partner_id' when calling UserdbApi.match_user"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling UserdbApi.match_user"
  end
  # resource path
  local_var_path = '/udb/{networkId}/sync/i.gif'.sub('{' + 'networkId' + '}', CGI.escape(network_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'userKey'] = user_key
  query_params[:'partnerId'] = partner_id
  query_params[:'userId'] = user_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/gif'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"UserdbApi.match_user",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserdbApi#match_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#opt_out(network_id, user_key, opts = {}) ⇒ File

Opt-Out a User

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

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

    the optional parameters

Returns:

  • (File) 


542
543
544
545
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 542

def opt_out(network_id, user_key, opts = {})
  data, _status_code, _headers = opt_out_with_http_info(network_id, user_key, opts)
  data
end

#opt_out_with_http_info(network_id, user_key, opts = {}) ⇒ Array<(File, Integer, Hash)>

Opt-Out a User

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

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

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 552

def opt_out_with_http_info(network_id, user_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserdbApi.opt_out ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling UserdbApi.opt_out"
  end
  # verify the required parameter 'user_key' is set
  if @api_client.config.client_side_validation && user_key.nil?
    fail ArgumentError, "Missing the required parameter 'user_key' when calling UserdbApi.opt_out"
  end
  # resource path
  local_var_path = '/udb/{networkId}/optout/i.gif'.sub('{' + 'networkId' + '}', CGI.escape(network_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'userKey'] = user_key

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['image/gif'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"UserdbApi.opt_out",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserdbApi#opt_out\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(network_id, user_key, opts = {}) ⇒ Object

Read a User's UserDB Record

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

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

    the optional parameters

Returns:

  • (Object) 


610
611
612
613
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 610

def read(network_id, user_key, opts = {})
  data, _status_code, _headers = read_with_http_info(network_id, user_key, opts)
  data
end

#read_with_http_info(network_id, user_key, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Read a User&#39;s UserDB Record

Parameters:

  • network_id (Integer) —

    Your Network Id

  • user_key (String) —

    The User&#39;s UserDB Key

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

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/adzerk_decision_sdk/api/userdb_api.rb', line 620

def read_with_http_info(network_id, user_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserdbApi.read ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling UserdbApi.read"
  end
  # verify the required parameter 'user_key' is set
  if @api_client.config.client_side_validation && user_key.nil?
    fail ArgumentError, "Missing the required parameter 'user_key' when calling UserdbApi.read"
  end
  # resource path
  local_var_path = '/udb/{networkId}/read'.sub('{' + 'networkId' + '}', CGI.escape(network_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'userKey'] = user_key

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"UserdbApi.read",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserdbApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end