Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated for pre-1.7 public release. Will rollback to previous version after 1.7 release.

...

  1. 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.
  2. The " configPattern" JSON key indicates how the slot names are defined in step #1. Possible values are listed below. Default values is "_AU_".

    configPattern valueMeaning
    "_AU_"Ad Unit value is used as slot name
    "_DIV_"Div value is used as slot name


  3. If an ad slot level configuration is unavailable, the system uses the default-level configuration.
  4. The following table lists the supported video keys:

    AttributeDescriptionData type
    battrBlocked creative attributes. (Values supported by oRTB 2.5 spec should be sent.)Array of Integers
    mindurationMinimum video ad duration in seconds.Integer
    maxdurationMaximum video ad duration in seconds.Integer
    skipDetermines whether the player allows the video to be skipped; 0 = no, 1 = yes.Integer
    skipminVideos of total duration greater than this number of seconds are skippable.Integer
    skipafterNumber of seconds a video must play before allowing the user to skip the video.Integer
    clientconfig

    Use the clientconfig object to return operational information to OpenWrap SDK by the OpenWrap S2S response:

    AttributeUnitDescriptionSDK default value
    refreshintervalsecondsOpenWrap SDK auto-refreshes the banner (display/video) ads after this interval.
    OpenWrap SDK defaults to the ad unit level refresh value over the profile level.
    When enabled, min refresh interval is 15 seconds.
    The value configured in the OpenWrap profile.
    timeouts:wrapperTagURImillisecondsOpenWrap SDK sends a TIMEOUT error to the app if the wrapper ad tag URI doesn't load within this time value. The SDK also sends VAST error code 301.1 second
    timeouts:mediaFileURImillisecondsOpenWrap SDK sends a NETWORK error if the media file doesn't load within this time value. SDK also sends VAST error code 402.10 seconds

    playOnMute

    Note
    titleDeprecated as of OpenWrap SDK 1.5…
    Use video.config.playbackmethod in SDK 1.5 instead. See, Using the clientconfig object with video ads > Remote configurations for video.


    0 / 1

    1 = SDK mutes audio during video creative playback.

    0 = SDK plays the video creative with a default state of audio.

    1

    To learn more about the clientconfig object see, Using the clientconfig object with video ads in OpenWrap SDK below.

    JSON object
    enabledIndicates 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
       1 = Ethernet
       2 = WIFI
       3 = Cellular Network – Unknown Generation
       4 = Cellular Network – 2G
       5 = Cellular Network – 3G
       6 = Cellular Network – 4G
       7 = Cellular Network – 5G

    Info
    titleBest practice to optimize user experience…
    Avoid using video ads with a 2G connectiontype.


    Array of Integers
    playbackmethodArray 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
    contextRequired 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: instreamString
    mimesContent MIME types supported. (Values supported by oRTB 2.5 spec should be sent.)Array of Strings
    protocolsArray of supported video protocols. (Values supported by oRTB 2.5 spec should be sent.)Array of Integers
    wWidth of the video player in device independent pixels (DIPS).Integer
    hHeight of the video player in device independent pixels (DIPS).Integer
    startdelayIndicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.Integer
    placementPlacement type for the impression.Integer
    linearityIndicates 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
    sequenceIf multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.Integer
    maxextendedMaximum 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
    minbitrateMinimum bit rate in Kbps.Integer
    maxbitrateMaximum bit rate in Kbps.Integer
    boxingallowedIndicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes.Integer
    deliverySupported 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
    posAd position on screen. (Values supported by oRTB 2.5 spec should be sent.)Integer
    companionadArray 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
    apiList 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
    companiontypeSupported VAST companion ad types. (Values supported by oRTB 2.5 spec should be sent.)Array of Integers


  5.  Supported banner key:

    AttributeDescriptionData type
    clientconfigEnter 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, false = no.
    Boolean


  6. Enable/disable banner/video/native bidding:
    1. The enabled attribute defaults to true at ad slot and default levels.
    2. To disable video bidding for a profile use:
      set config.default.video.enabled = false
      To disable banner bidding for a profile use:
      set config.default.banner.enabled = false
      This overrides the ad slot level enabled setting.
    3. 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
  7. 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  and  video.config.maxduration) , OpenWrap uses those to populate banner/video/banner requests to partners, instead of other attribute values from the default configuration.

...

Expand the questions below to learn more about the role of the clientconfig object in OpenWrap SDK.

Excerpt Include
ex:1.6.7 2 Video FAQ-clientconfig object common content
ex:1.6.7 2 Video FAQ-clientconfig object common content
nopaneltrue

...