adzerk_decision_sdk 1.0.0.pre.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ffb53d3459cdf483d870b18c2618046e331e7c36ca40f2e3205892be67f3cd22
+  data.tar.gz: 5f915af0222e96de0adfdedebb06f29836afdb4fa4f9417d5182f8f9aa679ad3
+SHA512:
+  metadata.gz: 82d3aff0c40659a1fcbde114ac394170e0ed0e6406884cb3cda09ed966a5e5c7cf32482913ad57be0a7a6d3e4922217b22d5155143093d06606effc2d7691509
+  data.tar.gz: a080a10d094e60e3dcb94b434c04ba52ca85c5d5b6930c76a688fc012067a26c02b08dfc53ac1bb447b500285bdf05747d29622513f5cb3300b79564ddfc3b27

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    adzerk_decision_sdk (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.1.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.12.2)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
+    method_source (0.9.2)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (12.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.1)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  adzerk_decision_sdk!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -0,0 +1,97 @@
+# Adzerk Ruby Decision SDK
+
+Ruby Software Development Kit for Adzerk Decision & UserDB APIs
+
+## Installation
+
+Requires [Ruby 2.5](https://en.wikipedia.org/wiki/Ruby_(programming_language)#Table_of_versions) or higher.
+
+```shell
+gem install adzerk_decision_sdk
+```
+
+Or add to your `Gemfile`:
+
+```ruby
+gem 'adzerk_decision_sdk', '~> 1.0.0'
+```
+
+## Examples
+
+### API Credentials & Required IDs
+
+- Network ID: Log into [Adzerk UI](https://app.adzerk.com/) & use the "circle-i" help menu in upper right corner to find Network ID. Required for all SDK operations.
+- Site ID: Go to [Manage Sites page](https://app.adzerk.com/#!/sites/) to find site IDs. Required when fetching an ad decision.
+- Ad Type ID: Go to [Ad Sizes page](https://app.adzerk.com/#!/ad-sizes/) to find Ad Type IDs. Required when fetching an ad decision.
+- API Key: Go to [API Keys page](https://app.adzerk.com/#!/api-keys/) find active API keys. Required when writing to UserDB.
+- User Key: UserDB IDs are [specified or generated for each user](https://dev.adzerk.com/reference/userdb#passing-the-userkey).
+
+### Fetching an Ad Decision
+
+```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"],
+}
+
+pp client.decisions.get(request)
+```
+
+### UserDB: Reading User Record
+
+```ruby
+require "adzerk_decision_sdk"
+
+# Demo network ID; find your own via the Adzerk UI!
+client = AdzerkDecisionSdk::Client.new(network_id: 23)
+pp client.user_db.read("abc")
+```
+
+### UserDB: Setting Custom Properties
+
+```ruby
+require "adzerk_decision_sdk"
+
+# Demo network ID; find your own via the Adzerk UI!
+client = AdzerkDecisionSdk::Client.new(network_id: 23, api_key: "YOUR_API_KEY")
+
+props = {
+  favoriteColor: "blue",
+  favoriteNumber: 42,
+  favoriteFoods: ["strawberries", "chocolate"],
+}
+
+client.user_db.set_custom_properties("abc", props)
+```
+
+<!-- ### Logging Example
+
+TBD: ....... -->
+
+## Documentation
+
+- [Adzerk API Documentation](https://dev.adzerk.com/reference)
+- [Adzerk User & Developer Documentation](https://dev.adzerk.com/docs)
+
+## Contributing
+
+### Reporting Issues
+
+- For bug fixes and improvements to this SDK please use Github to [open an issue](https://github.com/adzerk/adzerk-decision-sdk-ruby/issues) or send us a [pull request](https://github.com/adzerk/adzerk-decision-sdk-ruby/pulls).
+- For questions or issues regarding Adzerk functionality, please [contact Adzerk support](https://adzerk.com/help/).
+
+### Building
+
+To install dependencies and run the builds associated with this SDK, please use:
+
+```
+bundler install
+rake spec
+gem build adzerk_decision_sdk.gemspec
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/adzerk_decision_sdk.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Adzerk Decision API
+
+#Adzerk Decision API
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "adzerk_decision_sdk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "adzerk_decision_sdk"
+  s.version     = AdzerkDecisionSdk::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Adzerk, Inc."]
+  s.email       = ["engineering@adzerk.com"]
+  s.homepage    = "http://adzerk.com"
+  s.summary     = "Adzerk Decision API"
+  s.description = "Ruby library for the Adzerk Decision API"
+  s.license     = 'Apache-2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/Consent.md

@@ -0,0 +1,17 @@
+# AdzerkDecisionSdk::Consent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gdpr** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::Consent.new(gdpr: null)
+```
+
+

data/docs/ConsentRequest.md

@@ -0,0 +1,19 @@
+# AdzerkDecisionSdk::ConsentRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_key** | **String** |  | [optional] 
+**consent** | [**Object**](.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::ConsentRequest.new(user_key: null,
+                                 consent: null)
+```
+
+

data/docs/Content.md

@@ -0,0 +1,25 @@
+# AdzerkDecisionSdk::Content
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**template** | **String** |  | [optional] 
+**custom_template** | **String** |  | [optional] 
+**data** | [**DecisionData**](DecisionData.md) |  | [optional] 
+**body** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::Content.new(type: null,
+                                 template: null,
+                                 custom_template: null,
+                                 data: null,
+                                 body: null)
+```
+
+

data/docs/Decision.md

@@ -0,0 +1,35 @@
+# AdzerkDecisionSdk::Decision
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ad_id** | **Integer** |  | [optional] 
+**creative_id** | **Integer** |  | [optional] 
+**flight_id** | **Integer** |  | [optional] 
+**campaign_id** | **Integer** |  | [optional] 
+**priority_id** | **Integer** |  | [optional] 
+**click_url** | **String** |  | [optional] 
+**contents** | [**Array<Content>**](Content.md) |  | [optional] 
+**impression_url** | **String** |  | [optional] 
+**events** | [**Array<Event>**](Event.md) |  | [optional] 
+**pricing** | [**PricingData**](PricingData.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::Decision.new(ad_id: null,
+                                 creative_id: null,
+                                 flight_id: null,
+                                 campaign_id: null,
+                                 priority_id: null,
+                                 click_url: null,
+                                 contents: null,
+                                 impression_url: null,
+                                 events: null,
+                                 pricing: null)
+```
+
+

data/docs/DecisionApi.md

@@ -0,0 +1,57 @@
+# AdzerkDecisionSdk::DecisionApi
+
+All URIs are relative to *https://e-23.adzerk.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_decisions**](DecisionApi.md#get_decisions) | **POST** /api/v2 | 
+
+
+
+## get_decisions
+
+> DecisionResponse get_decisions(opts)
+
+
+
+Request Decision(s)
+
+### Example
+
+```ruby
+# load the gem
+require 'adzerk_decision_sdk'
+
+api_instance = AdzerkDecisionSdk::DecisionApi.new
+opts = {
+  decision_request: {"placements": [{ "divName": "header", "networkId": 23, "siteId": 667480, "adTypes": [5] }] } # DecisionRequest | 
+}
+
+begin
+  result = api_instance.get_decisions(opts)
+  p result
+rescue AdzerkDecisionSdk::ApiError => e
+  puts "Exception when calling DecisionApi->get_decisions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **decision_request** | [**DecisionRequest**](DecisionRequest.md)|  | [optional] 
+
+### Return type
+
+[**DecisionResponse**](DecisionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/DecisionData.md

@@ -0,0 +1,25 @@
+# AdzerkDecisionSdk::DecisionData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image_url** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+**width** | **Integer** |  | [optional] 
+**height** | **Integer** |  | [optional] 
+**custom_data** | [**Object**](.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::DecisionData.new(image_url: null,
+                                 title: null,
+                                 width: null,
+                                 height: null,
+                                 custom_data: null)
+```
+
+

data/docs/DecisionRequest.md

@@ -0,0 +1,43 @@
+# AdzerkDecisionSdk::DecisionRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**placements** | [**Array<Placement>**](Placement.md) | One or more Placement objects | 
+**user** | [**User**](User.md) |  | [optional] 
+**keywords** | **Array<String>** | Keywords for keyword Targeting. Such as `\"keywords\": [\"foo\", \"bar\", \"baz\"]`. | [optional] 
+**url** | **String** | The current page URL | [optional] 
+**referrer** | **String** | The referrer URL | [optional] 
+**ip** | **String** | The IP address. Required for [Geo-Targeting](https://dev.adzerk.com/docs/geo-location) | [optional] 
+**blocked_creatives** | **Array<Integer>** | Numeric creative ids to disregard for ad selection | [optional] 
+**is_mobile** | **Boolean** | If true, only ads containing a single image will be returned | [optional] 
+**include_pricing_data** | **Boolean** | If true, return pricing data for the decision in the response | [optional] 
+**notrack** | **Boolean** | If true, only return ads that are set to honor Do Not Track | [optional] 
+**enable_bot_filtering** | **Boolean** | If making a client-side request, set to true. Defaults to false to ensure a server isn't seen as a bot. See [here](https://dev.adzerk.com/docs/tracking-overview#section-bot-filtering) for more info | [optional] 
+**enable_user_dbip** | **Boolean** | 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 | [optional] 
+**consent** | [**Object**](.md) | Object that sets the data consent preferences. Other consent settings are available in the GDPR settings documentation. | [optional] 
+**device_id** | **String** | RTB requests only - sets an Identifier for Advertisers (IFA or IDFA) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::DecisionRequest.new(placements: null,
+                                 user: null,
+                                 keywords: null,
+                                 url: null,
+                                 referrer: null,
+                                 ip: null,
+                                 blocked_creatives: null,
+                                 is_mobile: null,
+                                 include_pricing_data: null,
+                                 notrack: null,
+                                 enable_bot_filtering: null,
+                                 enable_user_dbip: null,
+                                 consent: null,
+                                 device_id: null)
+```
+
+

data/docs/DecisionResponse.md

@@ -0,0 +1,21 @@
+# AdzerkDecisionSdk::DecisionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**User**](User.md) |  | [optional] 
+**decisions** | [**Object**](.md) |  | [optional] 
+**explain** | [**Object**](.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::DecisionResponse.new(user: null,
+                                 decisions: null,
+                                 explain: null)
+```
+
+

data/docs/Event.md

@@ -0,0 +1,19 @@
+# AdzerkDecisionSdk::Event
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::Event.new(id: null,
+                                 url: null)
+```
+
+

data/docs/GdprConsent.md

@@ -0,0 +1,19 @@
+# AdzerkDecisionSdk::GdprConsent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_key** | **String** |  | [optional] 
+**consent** | [**Consent**](Consent.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::GdprConsent.new(user_key: null,
+                                 consent: null)
+```
+
+

data/docs/Placement.md

@@ -0,0 +1,47 @@
+# AdzerkDecisionSdk::Placement
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**div_name** | **String** | A unique name for the placement defined by you | [optional] 
+**network_id** | **Integer** | The numeric network id | [optional] 
+**site_id** | **Integer** | The numeric site id | [optional] 
+**ad_types** | **Array<Integer>** | One or more integer ad types. More info [here](https://dev.adzerk.com/docs/ad-sizes) | [optional] 
+**zone_ids** | **Array<Integer>** | Zone IDs to use | [optional] 
+**campaign_id** | **Integer** | A numeric campaign id; if specified, only consider ads in that campaign | [optional] 
+**flight_id** | **Integer** | A numeric ad (flight-creative map) id; if specified, only serve that ad if possible | [optional] 
+**ad_id** | **Integer** | A numeric ad (flight-creative map) id; if specified, only serve that ad if possible | [optional] 
+**click_url** | **String** | The ad's click-through URL | [optional] 
+**properties** | [**Object**](.md) | A map of key/value pairs used for [Custom Targeting](https://dev.adzerk.com/docs/custom-targeting) | [optional] 
+**event_ids** | **Array<Integer>** | An array of numeric event types. Requests tracking URLs for custom events. See here for [Event Tracking IDs](https://dev.adzerk.com/v1.0/docs/custom-event-tracking) | [optional] 
+**overrides** | [**Object**](.md) | An object that overrides values for an advertiser, campaign, flight or ad. Used especially for header bidding | [optional] 
+**content_keys** | **Hash<String, Integer>** | A map of key/value pairs used with [ContentDB](https://dev.adzerk.com/docs/contentdb-1). The format is `\"contentKeys\": {\"schema\": \"contentKey\"}` | [optional] 
+**count** | **Integer** | (BETA) The number of ads to return per placement. Integer between 1 and 20 | [optional] 
+**proportionality** | **Boolean** | (BETA) If true, fills ads in a multi-winner placement in proportion to the flight's goals | [optional] 
+**ecpm_partition** | **String** | (BETA) The name of the eCPM Partition that should be used to source eCPM data for auctions | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::Placement.new(div_name: null,
+                                 network_id: null,
+                                 site_id: null,
+                                 ad_types: null,
+                                 zone_ids: null,
+                                 campaign_id: null,
+                                 flight_id: null,
+                                 ad_id: null,
+                                 click_url: null,
+                                 properties: null,
+                                 event_ids: null,
+                                 overrides: null,
+                                 content_keys: null,
+                                 count: null,
+                                 proportionality: null,
+                                 ecpm_partition: null)
+```
+
+

data/docs/PricingData.md

@@ -0,0 +1,25 @@
+# AdzerkDecisionSdk::PricingData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price** | **Float** |  | [optional] 
+**clear_price** | **Float** |  | [optional] 
+**revenue** | **Float** |  | [optional] 
+**rate_type** | **Integer** |  | [optional] 
+**e_cpm** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::PricingData.new(price: null,
+                                 clear_price: null,
+                                 revenue: null,
+                                 rate_type: null,
+                                 e_cpm: null)
+```
+
+

data/docs/Request.md

@@ -0,0 +1,43 @@
+# AdzerkDecisionSdk::Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**placements** | [**Array<Placement>**](Placement.md) | One or more Placement objects | 
+**user** | [**User**](User.md) |  | [optional] 
+**keywords** | **Array<String>** | Keywords for keyword Targeting. Such as `\"keywords\": [\"foo\", \"bar\", \"baz\"]`. | [optional] 
+**url** | **String** | The current page URL | [optional] 
+**referrer** | **String** | The referrer URL | [optional] 
+**ip** | **String** | The IP address. Required for [Geo-Targeting](https://dev.adzerk.com/docs/geo-location) | [optional] 
+**blocked_creatives** | **Array<Integer>** | Numeric creative ids to disregard for ad selection | [optional] 
+**is_mobile** | **Boolean** | If true, only ads containing a single image will be returned | [optional] 
+**include_pricing_data** | **Boolean** | If true, return pricing data for the decision in the response | [optional] 
+**notrack** | **Boolean** | If true, only return ads that are set to honor Do Not Track | [optional] 
+**enable_bot_filtering** | **Boolean** | If making a client-side request, set to true. Defaults to false to ensure a server isn't seen as a bot. See [here](https://dev.adzerk.com/docs/tracking-overview#section-bot-filtering) for more info | [optional] 
+**enable_user_dbip** | **Boolean** | 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 | [optional] 
+**consent** | [**RequestConsent**](RequestConsent.md) |  | [optional] 
+**device_id** | **String** | RTB requests only - sets an Identifier for Advertisers (IFA or IDFA) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::Request.new(placements: null,
+                                 user: null,
+                                 keywords: null,
+                                 url: null,
+                                 referrer: null,
+                                 ip: null,
+                                 blocked_creatives: null,
+                                 is_mobile: null,
+                                 include_pricing_data: null,
+                                 notrack: null,
+                                 enable_bot_filtering: null,
+                                 enable_user_dbip: null,
+                                 consent: null,
+                                 device_id: null)
+```
+
+

data/docs/RequestConsent.md

@@ -0,0 +1,17 @@
+# AdzerkDecisionSdk::RequestConsent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gdpr** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'AdzerkDecisionSdk'
+
+instance = AdzerkDecisionSdk::RequestConsent.new(gdpr: null)
+```
+
+