-
Notifications
You must be signed in to change notification settings - Fork 17
/
line_item_manager.yml
166 lines (166 loc) · 6.4 KB
/
line_item_manager.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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
# line_item_manager configuration
# version: '0.2.12'
###############################################################################
# Templating uses jinja2 rendering (see https://palletsprojects.com/p/jinja/)
# The following key word types are supported:
# Bidder:
# bidder_code = bidder-code
# bidder_name = bidder-name
# hb_<keystr> = hb_<keystr>_<bidder-code> (20 char limit)
# CPM:
# cpm = line item rate as cost-per-thousand impressions
# Media:
# media_type = video or banner based on creative configuration below
# Misc:
# time = current UTC time represented as "%m/%d/%Y %H:%M:%S"
# Order:
# cpm_max = order maximum cpm
# cpm_min = order minimum cpm
#
# See https://docs.prebid.org/dev-docs/bidder-data.csv for referencing bidder
# names and codes.
###############################################################################
# Publisher (optional)
# This can be specified on the command line like this:
# --network-code <code>
# --network-name <name>
#
# publisher:
# network_code: 1234
# network_name: "Video Publisher"
###############################################################################
# Bidder Targeting Key Override Map (optional, used with custom solutions):
# If provided override the default bidder keys and use these custom key
# values specified per bidder_code.
#
# bidder_key_map:
# <bidder_code_1>:
# hb_pb: <custom_key>
# hb_cache_id: <custom_key>
# <bidder_code_2>:
# hb_pb: <custom_key>
# hb_cache_id: <custom_key>
###############################################################################
# Advertiser (required)
# Allowed Templating Key Words: Bidder
###############################################################################
advertiser: # at least one of the following is required {id, name}, id is checked first
name: "Prebid"
# id: 1234567890
# type: "AD_NETWORK" # optional: defaults to "ADVERTISER"
###############################################################################
# Creatives (required)
# Allowed Templating Key Words: Bidder, Media, Misc
#
# For additional explanations on settings see the following:
# banner: https://docs.prebid.org/adops/step-by-step.html
# video: https://docs.prebid.org/adops/setting-up-prebid-video-in-dfp.html
###############################################################################
creative: # at least one of the following types is required {video, banner}
name: "Prebid {{ bidder_name }}-{{ media_type }}"
banner:
# safe_frame: False # optional: defaults to True
# size_override: False # optional: defaults to True with a 1x1 creative
sizes: # list
- height: 480
width: 640
snippet: |
<script src = "https://..."></script>
<script>
...
</script>
video:
# size_override: True with a 1x1 creative # optional: defaults to False
sizes: # list
- height: 480
width: 640
- height: 240
width: 320
vast_xml_url: "https://prebid.adnxs.com/pbc/v1/cache?uuid=%%PATTERN:{{ hb_uuid }}%%"
# max_duration: 15000 # optional: defaults to 30000, see settings.yml
# duration: 15000 # optional: defaults to value of max_duration above
###############################################################################
# Orders (required)
# Allowed Templating Key Words: Bidder, Media, Order, Misc
###############################################################################
order:
name: "Prebid-{{ bidder_name }}-{{ media_type }}-{{ time }} {{ cpm_min }}-{{ cpm_max }}"
# appliedTeamIds: # list (optional)
# - 12345678
# - 23456789
###############################################################################
# Line Items (required)
# Allowed Templating Key Words: Bidder, Media, CPM, Misc
#
# Supported Types: price_priority, standard, sponsorship
# datetimes use: "%m/%d/%y %H:%M" (ex. 11/17/20 21:28)
# - default timezone is UTC
# timezones: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
###############################################################################
line_item:
name: "Prebid-{{ bidder_name }}-{{ media_type }}-{{ time }} @ {{ cpm }}"
item_type: "price_priority"
# Optional
# priority: 12
# goal: # required if sponsorship item_type
# units: 5
# unitType: "VIEWABLE_IMPRESSIONS"
# goalType: "LIFETIME"
# start_datetime: "11/17/20 21:28"
# end_datetime: "12/17/20 21:28"
# timezone: "UTC"
###############################################################################
# Targeting (optional)
# Allowed Templating Key Words: None
#
# By default the Network Root Ad Unit is targeted if Placements or Ad Units
# are not specified.
#
# Note: A Key-Value of 'bidder_targeting_key' with all CPM values is created
# by default.
###############################################################################
targeting:
# bidder: # object (optional)
# reportableType: "ON" # optional, defaults to "OFF", choices: "ON", "OFF", "CUSTOM_DIMENSION"
custom: # list (optional)
- name: "country"
# operator: "IS_NOT" # optional: defaults to "IS"
values:
- "US"
- "CAN"
# reportableType: "ON" # optional, defaults to "OFF", choices: "ON", "OFF", "CUSTOM_DIMENSION"
- name: "site"
# operator: "IS_NOT" # optional: defaults to "IS"
values:
- "somesite"
# reportableType: "ON" # optional, defaults to "OFF", choices: "ON", "OFF", "CUSTOM_DIMENSION"
# placement_names: # list of names (optional)
# - "placement name 1"
# - "placement name 2"
# ad_unit_names: # list of names (optional)
# - "ad unit name 1"
# - "ad unit name 2"
###############################################################################
# Rate (required)
# Allowed Templating Key Words: None
#
# Granularity type definitions can be found here:
# https://docs.prebid.org/prebid-mobile/adops-price-granularity.html
#
# NOTE:
# 1. granularity in Prebid.js config must align with this granularity
# 2. all currency values are rounded to two decimal places (closest hundreth)
###############################################################################
rate:
currency: "USD" # required
granularity:
type: "med" # required, choices: "low", "med", "high", "auto", "dense", "custom"
# custom: # optional, requires type "custom" above
# - min: 0.10
# max: 30.00
# interval: 0.10
# - min: 30.50
# max: 50.00
# interval: 0.50
# optional properties
# vcpm: 100000 # viewable impressions will be enabled