adzerk_decision_sdk 1.0.0.pre.beta.6 → 1.0.0.pre.beta.10

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -7
  3. data/README.md +58 -4
  4. data/adzerk_decision_sdk.gemspec +3 -4
  5. data/docs/ConsentRequest.md +10 -9
  6. data/docs/Content.md +16 -15
  7. data/docs/Decision.md +30 -27
  8. data/docs/DecisionApi.md +30 -13
  9. data/docs/DecisionRequest.md +44 -41
  10. data/docs/DecisionResponse.md +12 -11
  11. data/docs/Event.md +10 -9
  12. data/docs/MatchedPoint.md +10 -9
  13. data/docs/Placement.md +50 -45
  14. data/docs/PricingData.md +16 -15
  15. data/docs/User.md +8 -7
  16. data/docs/UserdbApi.md +259 -98
  17. data/lib/adzerk_decision_sdk/api/decision_api.rb +5 -4
  18. data/lib/adzerk_decision_sdk/api/userdb_api.rb +37 -28
  19. data/lib/adzerk_decision_sdk/api_client.rb +50 -48
  20. data/lib/adzerk_decision_sdk/api_error.rb +1 -1
  21. data/lib/adzerk_decision_sdk/client.rb +2 -1
  22. data/lib/adzerk_decision_sdk/configuration.rb +39 -10
  23. data/lib/adzerk_decision_sdk/decision_client.rb +6 -6
  24. data/lib/adzerk_decision_sdk/models/consent_request.rb +19 -7
  25. data/lib/adzerk_decision_sdk/models/content.rb +19 -7
  26. data/lib/adzerk_decision_sdk/models/decision.rb +29 -8
  27. data/lib/adzerk_decision_sdk/models/decision_request.rb +32 -10
  28. data/lib/adzerk_decision_sdk/models/decision_response.rb +19 -7
  29. data/lib/adzerk_decision_sdk/models/event.rb +19 -7
  30. data/lib/adzerk_decision_sdk/models/matched_point.rb +19 -7
  31. data/lib/adzerk_decision_sdk/models/placement.rb +44 -12
  32. data/lib/adzerk_decision_sdk/models/pricing_data.rb +19 -7
  33. data/lib/adzerk_decision_sdk/models/user.rb +19 -7
  34. data/lib/adzerk_decision_sdk/user_db_client.rb +2 -2
  35. data/lib/adzerk_decision_sdk/version.rb +1 -1
  36. data/openapitools.json +7 -0
  37. data/spec/spec_helper.rb +91 -0
  38. metadata +12 -30
  39. data/pkg/adzerk_decision_sdk-1.0.0.pre.beta.3.gem +0 -0
data/docs/Placement.md CHANGED
@@ -2,54 +2,59 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **div_name** | **String** | A unique name for the placement defined by you | [optional]
8
- **network_id** | **Integer** | The numeric network id | [optional]
9
- **site_id** | **Integer** | The numeric site id | [optional]
10
- **ad_types** | **Array<Integer>** | One or more integer ad types. More info [here](https://dev.adzerk.com/docs/ad-sizes) | [optional]
11
- **zone_ids** | **Array<Integer>** | Zone IDs to use | [optional]
12
- **campaign_id** | **Integer** | A numeric campaign id; if specified, only consider ads in that campaign | [optional]
13
- **flight_id** | **Integer** | A numeric ad (flight-creative map) id; if specified, only serve that ad if possible | [optional]
14
- **ad_id** | **Integer** | A numeric ad (flight-creative map) id; if specified, only serve that ad if possible | [optional]
15
- **click_url** | **String** | The ad's click-through URL | [optional]
16
- **properties** | [**Object**](.md) | A map of key/value pairs used for [Custom Targeting](https://dev.adzerk.com/docs/custom-targeting) | [optional]
17
- **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]
18
- **overrides** | [**Object**](.md) | An object that overrides values for an advertiser, campaign, flight or ad. Used especially for header bidding | [optional]
19
- **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]
20
- **count** | **Integer** | (BETA) The number of ads to return per placement. Integer between 1 and 20 | [optional]
21
- **proportionality** | **Boolean** | (BETA) If true, fills ads in a multi-winner placement in proportion to the flight's goals | [optional]
22
- **ecpm_partition** | **String** | (BETA) The name of the eCPM Partition that should be used to source eCPM data for auctions | [optional]
23
- **ecpm_partitions** | **Array<String>** | (BETA) The names of the eCPM Partitions that should be used to source eCPM data for auctions | [optional]
24
- **event_multiplier** | **Integer** | | [optional]
25
- **skip_selection** | **Boolean** | | [optional]
26
- **ad_query** | [**Object**](.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **div_name** | **String** | A unique name for the placement defined by you | [optional] |
8
+ | **network_id** | **Integer** | The numeric network id | [optional] |
9
+ | **site_id** | **Integer** | The numeric site id | [optional] |
10
+ | **ad_types** | **Array<Integer>** | One or more integer ad types. More info [here](https://dev.adzerk.com/docs/ad-sizes) | [optional] |
11
+ | **zone_ids** | **Array<Integer>** | Zone IDs to use | [optional] |
12
+ | **campaign_id** | **Integer** | A numeric campaign id; if specified, only consider ads in that campaign | [optional] |
13
+ | **flight_id** | **Integer** | A numeric ad (flight-creative map) id; if specified, only serve that ad if possible | [optional] |
14
+ | **ad_id** | **Integer** | A numeric ad (flight-creative map) id; if specified, only serve that ad if possible | [optional] |
15
+ | **click_url** | **String** | The ad's click-through URL | [optional] |
16
+ | **properties** | **Object** | A map of key/value pairs used for [Custom Targeting](https://dev.adzerk.com/docs/custom-targeting) | [optional] |
17
+ | **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] |
18
+ | **overrides** | **Object** | An object that overrides values for an advertiser, campaign, flight or ad. Used especially for header bidding | [optional] |
19
+ | **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] |
20
+ | **count** | **Integer** | (BETA) The number of ads to return per placement. Integer between 1 and 20 | [optional] |
21
+ | **proportionality** | **Boolean** | (BETA) If true, fills ads in a multi-winner placement in proportion to the flight's goals | [optional] |
22
+ | **ecpm_partition** | **String** | (BETA) The name of the eCPM Partition that should be used to source eCPM data for auctions | [optional] |
23
+ | **ecpm_partitions** | **Array<String>** | (BETA) The names of the eCPM Partitions that should be used to source eCPM data for auctions | [optional] |
24
+ | **event_multiplier** | **Integer** | | [optional] |
25
+ | **skip_selection** | **Boolean** | | [optional] |
26
+ | **ad_query** | **Object** | | [optional] |
27
+ | **floor_price** | **Float** | | [optional] |
28
+ | **floor_cpc** | **Float** | | [optional] |
27
29
 
28
- ## Code Sample
30
+ ## Example
29
31
 
30
32
  ```ruby
31
- require 'AdzerkDecisionSdk'
33
+ require 'adzerk_decision_sdk'
32
34
 
33
- instance = AdzerkDecisionSdk::Placement.new(div_name: null,
34
- network_id: null,
35
- site_id: null,
36
- ad_types: null,
37
- zone_ids: null,
38
- campaign_id: null,
39
- flight_id: null,
40
- ad_id: null,
41
- click_url: null,
42
- properties: null,
43
- event_ids: null,
44
- overrides: null,
45
- content_keys: null,
46
- count: null,
47
- proportionality: null,
48
- ecpm_partition: null,
49
- ecpm_partitions: null,
50
- event_multiplier: null,
51
- skip_selection: null,
52
- ad_query: null)
35
+ instance = AdzerkDecisionSdk::Placement.new(
36
+ div_name: null,
37
+ network_id: null,
38
+ site_id: null,
39
+ ad_types: null,
40
+ zone_ids: null,
41
+ campaign_id: null,
42
+ flight_id: null,
43
+ ad_id: null,
44
+ click_url: null,
45
+ properties: null,
46
+ event_ids: null,
47
+ overrides: null,
48
+ content_keys: null,
49
+ count: null,
50
+ proportionality: null,
51
+ ecpm_partition: null,
52
+ ecpm_partitions: null,
53
+ event_multiplier: null,
54
+ skip_selection: null,
55
+ ad_query: null,
56
+ floor_price: null,
57
+ floor_cpc: null
58
+ )
53
59
  ```
54
60
 
55
-
data/docs/PricingData.md CHANGED
@@ -2,24 +2,25 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **price** | **Float** | | [optional]
8
- **clear_price** | **Float** | | [optional]
9
- **revenue** | **Float** | | [optional]
10
- **rate_type** | **Integer** | | [optional]
11
- **e_cpm** | **Float** | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **price** | **Float** | | [optional] |
8
+ | **clear_price** | **Float** | | [optional] |
9
+ | **revenue** | **Float** | | [optional] |
10
+ | **rate_type** | **Integer** | | [optional] |
11
+ | **e_cpm** | **Float** | | [optional] |
12
12
 
13
- ## Code Sample
13
+ ## Example
14
14
 
15
15
  ```ruby
16
- require 'AdzerkDecisionSdk'
16
+ require 'adzerk_decision_sdk'
17
17
 
18
- instance = AdzerkDecisionSdk::PricingData.new(price: null,
19
- clear_price: null,
20
- revenue: null,
21
- rate_type: null,
22
- e_cpm: null)
18
+ instance = AdzerkDecisionSdk::PricingData.new(
19
+ price: null,
20
+ clear_price: null,
21
+ revenue: null,
22
+ rate_type: null,
23
+ e_cpm: null
24
+ )
23
25
  ```
24
26
 
25
-
data/docs/User.md CHANGED
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **key** | **String** | The UserKey used for UserDB Targeting | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **key** | **String** | The UserKey used for UserDB Targeting | [optional] |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
- require 'AdzerkDecisionSdk'
12
+ require 'adzerk_decision_sdk'
13
13
 
14
- instance = AdzerkDecisionSdk::User.new(key: null)
14
+ instance = AdzerkDecisionSdk::User.new(
15
+ key: null
16
+ )
15
17
  ```
16
18
 
17
-