...
- Upload new ad unit configurations.
- Download existing configurations.
- Delete existing configurations.
...
Upload an ad unit
...
configuration
Note | |
---|---|
title | Remember…
|
- Go to Inventory > OpenWrap.
- Select the Profile Management tab.
- Select your profile from the Select Profile dropdown list.
Choose Actions > Map Ad Units next to the most recent version.
- For Ad Unit Configuration (Optional), choose Actions > Upload Config and upload your JSON file.
- The following message will appear when upload is complete:
...
- Go to Inventory > OpenWrap.
- Select the Profile Management tab.
- Select your profile from the Select a Profile dropdown list.
Choose Actions > Map Ad Units next to the most recent version.
- For Ad Unit Configuration (Optional), choose Actions > Download Config and the JSON config file would be downloaded.
Delete an ad unit configuration
...
Note |
---|
The Download Delete Config option is only available when an ad unit configuration is already uploaded. If it is not uploaded, you won't see this option. |
...
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "configPattern": "_AU_", "config": { "default": { "video": { "enabled": true, "config": { "skipafter": 5, "maxduration": 60, "skip": 1, "skipmin": 5, "minduration": 5, "playbackmethod": [ 1, 2 ], "clientconfig": { "timeouts": { "wrapperTagURI": 8000, "mediaFileURI": 9000 } } } }, "banner": { "enabled": true, "config": { "clientconfig": { "refreshinterval": 30 } } } }, "Slot1": { "banner": { "enabled": true, "config": { "clientconfig": { "refreshinterval": 60 } } }, "video": { "enabled": true, "config": { "minduration": 10, "maxduration": 60, "skip": 1, "skipmin": 10, "skipafter": 10, "playbackmethod": [ 5, 6 ], "clientconfig": { "timeoutsreward": { "wrapperTagURIrewards": 11000,[ "mediaFileURI": 12000 { } "type": "coins", } } }"value": 10 } } } |
Media types in configuration JSON
You can specify configuration parameters for the following media types at an ad slot level or a default level: video, banner and native. Here are some important notes about the configuration JSON:
...
The " configPattern" JSON key indicates how the slot names are defined in step #1. Possible values are listed below. Default values is "_AU_".
...
The following table lists the supported video keys:
...
Use the clientconfig
object to return operational information to OpenWrap SDK by the OpenWrap S2S response:
...
playOnMute
Note | ||
---|---|---|
| ||
Use video.config.playbackmethod in SDK 1.5 instead. See, Using the clientconfig object with video ads > Remote configurations for video. |
...
1 = SDK mutes audio during video creative playback.
0 = SDK plays the video creative with a default state of audio.
...
},
{
"type": "lives",
"value": 2
}
]
},
"timeouts": {
"wrapperTagURI": 11000,
"mediaFileURI": 12000
}
}
}
}
}
}
} |
Media types in configuration JSON
You can specify configuration parameters for the following media types at an ad slot level or a default level: video, banner and native. Here are some important notes about the configuration JSON:
- The "config" JSON key contains the default and slot level config values. Default level config is represented by "default" key where as each ad slot are represented by its slot name as key.
The " configPattern" JSON key indicates how the slot names are defined in step #1. Possible values are listed below. Default values is "_AU_".
configPattern value Meaning "_AU_" Ad Unit value is used as slot name "_DIV_" Div value is used as slot name - If an ad slot level configuration is unavailable, the system uses the default-level configuration.
The following table lists the supported video keys:
Attribute | Description | Data type | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
battr | Blocked creative attributes. (Values supported by oRTB 2.5 spec should be sent.) | Array of Integers | |||||||||||||||||||||||||||||
minduration | Minimum video ad duration in seconds. | Integer | |||||||||||||||||||||||||||||
maxduration | Maximum video ad duration in seconds. | Integer | |||||||||||||||||||||||||||||
skip | Determines whether the player allows the video to be skipped; 0 = no, 1 = yes. | Integer | |||||||||||||||||||||||||||||
skipmin | Videos of total duration greater than this number of seconds are skippable. | Integer | |||||||||||||||||||||||||||||
skipafter | Number of seconds a video must play before allowing the user to skip the video. | Integer | |||||||||||||||||||||||||||||
clientconfig | Use the
To learn more about the | JSON object | |||||||||||||||||||||||||||||
enabled | Indicates whether video bidding is enabled for this ad slot, where true = yes, false = no. | Boolean | |||||||||||||||||||||||||||||
connectiontype | List of network connection types appropriate for the video being served: 0 = Unknown
| Array of Integers | |||||||||||||||||||||||||||||
playbackmethod | Array of playback methods that may be in use (send values supported by oRTB 2.5 spec). See, Using the clientconfig object with video ads > Remote configurations for video. | Array of Integers | |||||||||||||||||||||||||||||
context | Required for Video ads using OpenWrap client-side integrations. Indicates if the ads are instream or outstream. Currently, the only acceptable value for this field is: instream | String | |||||||||||||||||||||||||||||
mimes | Content MIME types supported. (Values supported by oRTB 2.5 spec should be sent.) | Array of Strings | |||||||||||||||||||||||||||||
protocols | Array of supported video protocols. (Values supported by oRTB 2.5 spec should be sent.) | Array of Integers | |||||||||||||||||||||||||||||
w | Width of the video player in device independent pixels (DIPS). | Integer | |||||||||||||||||||||||||||||
h | Height of the video player in device independent pixels (DIPS). | Integer | |||||||||||||||||||||||||||||
startdelay | Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. | Integer | |||||||||||||||||||||||||||||
placement | Placement type for the impression. | Integer | |||||||||||||||||||||||||||||
linearity | Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed. (Values supported by oRTB 2.5 spec should be sent.) | Integer | |||||||||||||||||||||||||||||
sequence | If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives. | Integer | |||||||||||||||||||||||||||||
maxextended | Maximum extended ad duration if extension is allowed. If blank or 0, extension is not allowed. If -1, extension is allowed, and there is no time limit imposed. If greater than 0, then the value represents the number of seconds of extended play supported beyond the maxduration value. | Integer | |||||||||||||||||||||||||||||
minbitrate | Minimum bit rate in Kbps. | Integer | |||||||||||||||||||||||||||||
maxbitrate | Maximum bit rate in Kbps. | Integer | |||||||||||||||||||||||||||||
boxingallowed | Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes. | Integer | |||||||||||||||||||||||||||||
delivery | Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported. (Values supported by oRTB 2.5 spec should be sent.) | Array of Integers | |||||||||||||||||||||||||||||
pos | Ad position on screen. (Values supported by oRTB 2.5 spec should be sent.) | Integer | |||||||||||||||||||||||||||||
companionad | Array of Banner objects (Section 3.2.6) if companion ads are available. (See oRTB 2.5 spec for Banner object in request) | Array of Banner objects | |||||||||||||||||||||||||||||
api | List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. (Values supported by oRTB 2.5 spec should be sent.) | Array of Integers | |||||||||||||||||||||||||||||
companiontype | Supported VAST companion ad types. (Values supported by oRTB 2.5 spec should be sent.) | Array of Integers |
Supported banner key:
Attribute Description Data type clientconfig
Enter attributes here that you want returned in the OpenWrap S2S response. JSON object enabled
Indicates if banner bidding is enabled for this ad slot, where true = yes
, andfalse = no
.Boolean - Enable/disable banner/video/native bidding:
- The
enabled
attribute defaults totrue
at ad slot and default levels. - To disable video bidding for a profile use:
To disable banner bidding for a profile use:set config.default.video.enabled = false
This overrides the ad slot levelset config.default.banner.enabled = false
enabled
setting. - To disable video bidding for a particular ad slot use:
set config.<slotname>.video.enabled = false
To disable video bidding for a particular ad slot use:
set config.<slotname>.banner.enabled = false
- The
- As mentioned in step 2, OpenWrap uses default configuration when there is no ad slot level configuration found for a given ad slot. If configuration attributes exist at the ad slot level (for example,
video.config.minduration
andvideo.config.maxduration)
, OpenWrap uses those to populate banner/video/banner requests to partners, instead of other attribute values from the default configuration.
...