Implementation process

All the In-App implementation requires consultation with your Account Manager and QA process before going live.

Code Snippet

Regular HTML

<div class="OUTBRAIN" 
data-ob-bundleUrl="DROP_STORE_URL_HERE"
data-ob-language="DROP_LANGUAGE_CODE_HERE"
data-widget-id="DROP_WIDGET_ID_HERE" 
data-ob-user-id="DROP_ADVERTISING_ID_HERE"
data-ob-installation-key="DROP_PARTNER_KEY_HERE"></div>
<script type="text/javascript" async="async" 
src="https://widgets.outbrain.com/outbrain.js"></script>

Google Ad Manager format with macros

Please consult with your Sales Engineer or Partner Manager before using

<div class="OUTBRAIN" 
data-ob-bundleUrl="DROP_STORE_URL_HERE"
data-ob-language="DROP_LANGUAGE_CODE_HERE"
data-widget-id="DROP_WIDGET_ID_HERE" 
data-ob-user-id="%%ADVERTISING_IDENTIFIER_PLAIN%%"
data-ob-installation-key="DROP_PARTNER_KEY_HERE"
data-consent-string="${GDPR_CONSENT_164}"
data-consent-version="2"
></div>
<script type="text/javascript" async="async" 
src="https://widgets.outbrain.com/outbrain.js"></script>

Parameters

Parameters in detail

Bundle URL

The store URL of the App in App distribution platform. Currently Google play store, Apple App store, Facebook App, Huawei App Gallery formats are supported.

Advertising ID

It is mandatory to pass the Advertising ID for Outbrain installations in mobile apps, according to Google and Apple guidelines and developer agreements. In compliance with Google and Apple guidelines, if the user is opted out of ad tracking, please pass the value null (case sensitive) as a value

Consent / US Privacy String

Our JS Widget is fully compliant to TCF v2.0 and CCPA. It will automatically fetch consent/US privacy string from CMPs, so there’s no need to pass consent string manually. However, if the WebView does not support TCF API or US API, it’s possible to pass consent/US privacy string directly to widgets by using the data-consent-string or data-ccpa-string attribute.

Navigate to Paid Recommendations

Use SFSafariViewController(iOS)/ChromeCustomTab(Android) or Safari/Chrome browsers for all paid recommendations. Please make sure to open the Outbrain redirect URL (paid.outbrain.com) directly without any URL manipulation.

Smartfeed Support

Smartfeed is not supported in-App WebView JS Widget installation.

Widget Callback Events

Custom callback scripts can be supported by Widget External Event Handler For example, the Ad fill status of the widget can be checked by scanning the value of recsNumber at widgetDataReturned event. *Widgets must be shown to users even the Ad slots are not fully filled.

Mandatory setup for Android App: Charles Proxy Support

In order to verify that your app is working according to our guidelines, we use a software called Charles Proxy to monitor the networking coming in and out of the app.

For Android 7.0 or newer, you need to add configuration to your app in order to have it trust the SSL certificates generated by Charles SSL Proxying. In order to configure your app to trust Charles, you need to add a Network Security Configuration File to your app.

This file can override the system default, enabling your app to trust user installed CA certificates (e.g. the Charles Root Certificate). You can specify that this only applies in debug builds of your application, so that production builds use the default trust profile.

Add a file res/xml/network_security_config.xml to your app:

<network-security-config> 
  <debug-overrides> 
    <trust-anchors> 
      <!-- Trust user added CAs while debuggable only -->
      <certificates src="user" /> 
    </trust-anchors> 
  </debug-overrides> 
</network-security-config>

Then add a reference to this file in your app’s manifest, as follows:

<?xml version="1.0" encoding="utf-8"?>
<manifest ... >
    <application android:networkSecurityConfig="@xml/network_security_config" ... >
        ...
    </application>
</manifest>