Ad Units: Outstream General Settings

1.0 | Ad Unit Settings

• Title: The name of your Ad Unit.
• Code: The reference code for the ad unit. If nothing is entered, it defaults to the title.
• Description (optional): Used to describe the Ad Unit.

2.0 | CTA Settings

• CTA text: Add text for a CTA (Call to Action) that displays on your ad while it’s playing.
• Midplay CTA: Enable CTA text midplay by selecting the “Show” option. When Google’s IMA service enforces their own ‘learn more’ button, your CTA will be positioned to cover it.
• CTA position: Place the CTA at the top right or top left of the player.
• Exitscreen CTA: Enable CTA on the exit screen by selecting the “Show” option in the drop-down menu. Optional: enable CTA exit screen shading.
• CTA background color: Sets the background color of the CTA element. Appears when Midplay CTA or Exitscreen CTA is enabled.
• CTA highlight color: Sets the highlight color of the CTA element. Appears when Midplay CTA or Exitscreen CTA is enabled.
• CTA exit screen shade: Adds a tinted shade across the exit screen to make the CTA stand out more clearly against whatever image or placeholder is showing behind it.

3.0 | Outstream Settings

• Ad refresh: The player will try to request a new ad whenever the current ad has finished playing or has been skipped. The player will always collapse when no ad is returned. Ad refresh is not supported in the native SDK players yet.
  • Continuous refresh: When enabled, the player will not collapse after a failed fill and will keep retrying to fill the ad slot in the background. Appears when Ad refresh is enabled.
• Sticky options: Enabling this keeps the inArticle player in view by either sticking it to the top or bottom of the page, floating to a corner, or floating to a specific element on the page. This increases viewability and completion rates.
  • Width when floating: The width of the player when floating, in pixels. This can be a number or JavaScript code returning a number. Example: $(window).width() / 3
  • Minimum device width to enable floating: This option allows you to only float the player when the device width is greater than this minimum pixel width.
  • Always float: The player will not appear within the content and will always float to the location specified here.
  • Stay sticky: Once the player has started floating, it will no longer return to its original position. Closing the player removes it entirely.
  • Show close button: Show a close button when ‘Stay sticky’ or ‘Always float’ are enabled.
  • Disable float animation: When disabled, the player jumps directly to the set position instead of animating towards it.
  • DOM element to float to: A CSS selector for the element the player should float towards. If the element is not found, the player will not float. Appears when the sticky mode is set to ‘Stick to element’.
  • Float to DOM element alignment: Sets where the player aligns relative to the target element (top left, bottom left, top right, or bottom right). Appears when the sticky mode is set to ‘Stick to element’.
• Responsive Player Sizing: Allows you to override the width and height and make the player responsive to the block of content the video will open up in.
  • Aspect Ratio: By default, a responsive player will take the width of the player and calculate the height based on the aspect ratio of the video being displayed. Using this setting, you can override this to always scale the player to a certain aspect ratio. When using this option, we recommend 16:9 as it is the most common aspect ratio for video ads.
• Width: Use a percentage for a responsive playout (e.g. 100%). You can set this to a pixel width using the drop-down arrow.
• Maximum width: Set a maximum width in pixels.
• InView Margin: The percentage of the player’s height that must be visible for it to be considered ‘InView’.
• Placeholder background color: Sets the background color for the placeholder displayed when no ad is playing or after an ad has finished. This applies only if you choose not to collapse the player.
• Placeholder text color: Sets the text color for the placeholder displayed when no ad is playing.
• Placeholder text: Enter freeform text to appear in the center of the placeholder. You can use HTML to customize the styling.
• Allow Skipping: Allow viewers to skip the ad after “x” seconds.
  • Skip countdown text: Set a skip countdown text and time.

4.0 | Display Passback Settings

Configure a display ad to show in place of the placeholder or end screen when no video ad is playing. It is recommended to configure a passback with a 100% fill rate, as otherwise a blank screen may appear.

• Passback type: Select the type of display passback. Options are:
  • HTML: Enter custom HTML passback code.

• • GPT: Configure a Google Publisher Tag passback. Sub-settings:
    • GPT path: The ad unit path for the GPT passback.
    • GPT sizing: The ad sizes to request.
    • GPT refresh interval: How often (in seconds) the GPT passback refreshes.

• • Prebid: Select a Prebid auction to use as the passback source.

5.0 | Display Settings

• Show play/pause button: Enables the play/pause button on the control bar.
• Show mute/unmute button: Enables the mute/unmute button.
• Show progress bar: By default, the progress bar is enabled. You can use this setting to disable the progress bar. If you do, previously enabled play/pause and/or mute/unmute buttons will remain enabled.
  • Progress bar color: Change the color of the progress bar.
• Text commercial time remaining: Enter the text that announces the remaining time of the ad.
• Text above player: Enter text to display above the player.
• Text for player close button: Enter the text for the close button.

6.0 | In & Out View

• Start Collapsed: Start the player collapsed (closed) and only expand it if media plays. Leave unchecked if you would like the player to always start open.
• Collapse on end: Collapse (close) the player when the ad is finished. Leave unchecked to have the player remain open when the ad finishes playing. The end screen will show an image or the placeholder design depending on your placeholder settings.
• In View Action: Set the player’s behaviour when it comes into the user’s view. Options: None, Play, Unmute, Play & unmute.
• Out View Action: Set the player’s behaviour when it leaves the user’s view. Options: None, Pause, Mute, Pause & mute.

7.0 | Mouse

• Mouse In Action: Determines what action the player takes when the user hovers over it.
• Mouse Out Action: Determines what action the player takes when the user moves their cursor away.

8.0 | Placement Options

• Distance from Top: Adjusts how far from the top of the screen the player can display.
• Distance from Bottom: Adjusts how far from the bottom of the screen the player can display.
• Placement Option: Specify where on the page the player will display. Options:
  • At script position (default): The player displays exactly where the script tag is placed in the page source.
  • After matching DOM element: Places the player after the first element that matches a CSS selector you specify.
  • Append to matching DOM element: Appends the player inside the element that matches a CSS selector you specify.
  • Halfway matching DOM elements: Places the player halfway through a set of elements matching a CSS selector.
  • After matching DOM element below the fold: Places the player after the first matching element that is below the visible area of the page.
  • After matching DOM element below the fold, or the last element found: Same as above, but falls back to the last matching element if none are found below the fold.

  Read more on using DOM selectors for dynamic targeting.

• Wait for CMP response: Enable to have the player wait to position itself on the page until a consent string is obtained from the CMP (Consent Management Platform), or the configured timeout is reached.
  • CMP response timeout: The time in milliseconds to wait for a consent string before the player proceeds with placement regardless. Default: 10000ms.
• Add (css) clear:both to player wrapper: Adds the CSS style clear:both to the player wrapper. This can be useful in situations where the player can’t detect the correct width to use.

9.0 | Miscellaneous

• Isolate player styling: Place the player in an isolated environment using Shadow DOM, a browser feature that keeps the player’s styles separate from the rest of the page. Enable this if page styles are unintentionally affecting the player’s appearance.
• Preload line items: Allows you to start calling all VAST URLs in the line items at the first user interaction, to enable faster playback once the user arrives at the player position. Without this option enabled, the first VAST call will be made when the player is “InView”. We recommend always enabling this option to avoid latency issues.
• Custom JavaScript Code: Custom JavaScript code that will be executed when the player is placed. You can use the references $$api (the player API) and $$wrapper (the player wrapper element) in your code.
• Passback Code: Custom JavaScript code that will be executed when the player has finished playing an ad or no ad was found. Use this to pass back to a display or video campaign via code. For a structured display passback (GPT or Prebid), use the Display Passback Settings in section 4.0 instead.