adzerk_decision_sdk 1.0.0.pre.beta.7 → 1.0.0.pre.beta.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69c2c3f742c3359a34c6a15ea195143430e194a6206f2a8b0080b74232ec9f34
-  data.tar.gz: 9530944f24b7c30a63a65650daf88ecf6feb2806fee2299838bb25fb3d19c2e6
+  metadata.gz: d3c1fa1975fc4fcfd55306fd13622738720961b229b85f309fea506f0f1d450f
+  data.tar.gz: 53914caaa486d34f102326193f719d0a29e819f6b3917d0fbf7e0917eee6d4c5
 SHA512:
-  metadata.gz: 3759cc220044e90f877b03a1e54ae693781a1a04a9cef28b76b9a1ca0237c56d8ffd952282ee641aa155b9eb6539ae90c68a74e5a88a33b080b419e5beeb0acf
-  data.tar.gz: c59f853bd03677cebe2f6fbcc5e6364173f216ed326d3824b01984467f92fc5679c34e6440ab7f0e2645e4ad56ef825f032ec2f4c5463ab575901cf7d6f7380e
+  metadata.gz: 6fc835f013c0781ed26da9f40e4f95d6d594d8d1cea3528d0d61643b6e8925581526ef3cc1c8670f3992d50f70b2aecf51cb4475779fa078115fe19779974d05
+  data.tar.gz: 1a2523d2a2499da3a4aff92b1dd9492d2587a775b7dfe90ca82be33c08bbb650c32d91731a2003bd2fc70d015931dfb6a7ce3b21f5022183944377cce05ea947

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adzerk_decision_sdk (1.0.0.pre.beta.7)
+    adzerk_decision_sdk (1.0.0.pre.beta.8)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -13,7 +13,7 @@ GEM
     diff-lcs (1.3)
     ethon (0.14.0)
       ffi (>= 1.15.0)
-    ffi (1.15.1)
+    ffi (1.15.3)
     jaro_winkler (1.5.4)
     method_source (0.9.2)
     parallel (1.19.1)
@@ -65,4 +65,4 @@ DEPENDENCIES
   rubocop (~> 0.66.0)
 
 BUNDLED WITH
-   2.2.17
+   2.2.21

data/README.md

@@ -9,7 +9,7 @@ Requires [Ruby 2.5](https://en.wikipedia.org/wiki/Ruby_(programming_language)#Ta
 [RubyGem Package](https://rubygems.org/gems/adzerk_decision_sdk)
 
 ```shell
-gem install adzerk_decision_sdk
+gem install adzerk_decision_sdk --pre
 ```
 
 Or add to your `Gemfile`:
@@ -92,10 +92,50 @@ client.user_db.set_custom_properties("abc", props)
 require "adzerk_decision_sdk"
 
 # Demo network ID and API key; find your own via the Adzerk UI!
-client = AdzerkDecisionSdk::Client.new(network_id: 23, api_key: "YOUR_API_KEY")
+client = AdzerkDecisionSdk::Client.new(network_id: 23, api_key: ENV["ADZERK_API_KEY"])
 client.user_db.forget("abc")
 ```
 
+### Decision Explainer
+
+The Decision Explainer returns information on a Decision API request explaining why each candidate ad was or was not chosen. 
+
+```ruby
+require "adzerk_decision_sdk"
+
+# Demo network, site, and ad type IDs; find your own via the Adzerk UI!
+client = AdzerkDecisionSdk::Client.new(network_id: 23, site_id: 667480)
+
+request = {
+  placements: [{ adTypes: [5] }],
+  user: { key: "abc" },
+  keywords: ["keyword1", "keyword2"],
+}
+
+options = {
+  include_explanation: true,
+  api_key: ENV["ADZERK_API_KEY"]
+}
+
+pp client.decisions.get(request, options)
+```
+
+The response returns a decision object with placement, buckets, rtb logs, and result information.
+``` json
+{
+  "div0": {
+    "placement": {},
+    "buckets": [],
+    "rtb_log": [],
+    "results": []
+  }
+}
+```
+The "placement" object represents a decision in which an ad may be served. A Explainer Request can have multiple placements in the request.
+The "buckets" array contains channel and priority information.
+The "rtb_logs" array contains information about Real Time Bidding.
+The "results" array contains the list of candidate ads that did and did not serve, along with a brief explanation.
+
 ### Logging
 
 Our logging implementation is meant to be flexible enough to fit into any common Ruby logging framework.

data/lib/adzerk_decision_sdk/client.rb

@@ -25,8 +25,9 @@ module AdzerkDecisionSdk
       configuration = Configuration.new
       configuration.scheme = protocol
       configuration.host = host
-      configuration.api_key['X-Adzerk-ApiKey'] = api_key
+      configuration.api_key['ApiKeyAuth'] = api_key
       configuration.debugging = is_debug
+      configuration.server_index = nil
 
       unless logger.nil?
         configuration.logger = logger

data/lib/adzerk_decision_sdk/decision_client.rb

@@ -14,17 +14,17 @@ module AdzerkDecisionSdk
     def get(request, opts = {})
       opts ||= {}
       header_params = opts[:header_params] || {}
-      opts[:body] ||= request.respond_to?('to_hash') ? request.to_hash() : request
+      opts[:debug_body] ||= request.respond_to?('to_hash') ? request.to_hash() : request
 
-      @logger.info("Processing request: #{opts[:body]}")
+      @logger.info("Processing request: #{opts[:debug_body]}")
 
-      opts[:body][:enableBotFiltering] = false if not opts[:body].has_key?(:enableBotFiltering)
+      opts[:debug_body][:enableBotFiltering] = false if not opts[:debug_body].has_key?(:enableBotFiltering)
 
-      if !opts[:body].has_key?(:placements) or !opts[:body][:placements] or opts[:body][:placements].length() == 0
+      if !opts[:debug_body].has_key?(:placements) or !opts[:debug_body][:placements] or opts[:debug_body][:placements].length() == 0
         fail ArgumentError, "Each request requires at least one placement"
       end
 
-      opts[:body][:placements].each_with_index do |placement, idx|
+      opts[:debug_body][:placements].each_with_index do |placement, idx|
         if !placement.has_key?(:adTypes) or !placement[:adTypes] or placement[:adTypes].length() == 0
           fail ArgumentError, "Each placement needs at least one ad type"
         end
@@ -56,7 +56,7 @@ module AdzerkDecisionSdk
 
       opts[:header_params] = header_params
 
-      @logger.info("Processed request: #{opts[:body]}")
+      @logger.info("Processed request: #{opts[:debug_body]}")
       @logger.info("Requesting with headers: #{opts[:header_params]}")
 
       response = @api.get_decisions(opts)

data/lib/adzerk_decision_sdk/user_db_client.rb

@@ -10,7 +10,7 @@ module AdzerkDecisionSdk
 
     def set_custom_properties(user_key, properties, network_id: nil)
       @logger.info("Setting custom properties for #{user_key} on #{network_id || @network_id} to: #{properties}")
-      @api.add_custom_properties(network_id || @network_id, user_key, { body: properties })
+      @api.add_custom_properties(network_id || @network_id, user_key, { debug_body: properties })
     end
 
     def add_interest(user_key, interest, network_id: nil)
@@ -31,7 +31,7 @@ module AdzerkDecisionSdk
     def gdpr_consent(gdpr_consent, network_id: nil)
       body = gdpr_consent.respond_to?('to_hash') ? gdpr_consent.to_hash() : gdpr_consent
       @logger.info("Setting GDPR consent on #{network_id || @network_id} with: #{body}")
-      @api.gdpr_consent(network_id || @network_id, { body: body })
+      @api.gdpr_consent(network_id || @network_id, { debug_body: body })
     end
 
     def ip_override(user_key, ip, network_id: nil)

data/lib/adzerk_decision_sdk/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module AdzerkDecisionSdk
-  VERSION = '1.0.0-beta.7'
+  VERSION = '1.0.0-beta.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adzerk_decision_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.7
+  version: 1.0.0.pre.beta.8
 platform: ruby
 authors:
 - Adzerk, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus