In-App JS-Widget Parameters
Navigate to Paid Recommendations

Following the developer guide instructions is mandatory to ensure app compliance.
Please make sure to follow the entire guide before submitting your app to Outbrain QA.

App specific JS-Widget parameters

It is mandatory to pass the following app specific parameters when using Outbrain JS-Widget in mobile applications:

data-ob-installation-type, data-ob-user-id, data-ob-app-ver, data-ob-installation-key

Example:

<div class="OUTBRAIN" data-src="DROP_PERMALINK_HERE"
data-widget-id="DROP_WIDGET_ID_HERE" 
data-ob-installation-type="app_js_widget"
data-ob-user-id="UNIQUE_USER_IDENTIFIER"
data-ob-app-ver="DROP_APPLICATION_VERSION_HERE"
data-ob-installation-key="DROP_PARTNER_KEY_HERE"></div>
<script type="text/javascript" async="async" 
src="https://widgets.outbrain.com/outbrain.js"></script>

 

Installation Type

Add the installation type (static value) to the div:

data-ob-installation-type="app_js_widget"

Application version

Add the application version to the div:

data-ob-app-ver="DROP_APPLICATION_VERSION_HERE"

Partner Key

Add the partner key that you received from your account manager:

data-ob-installation-key="DROP_PARTNER_KEY_HERE"

Unique User Identifier

In native apps and cookie-less environments, it is mandatory to send a unique and consistent identifier for each user.
For mobile apps, this is the Google or Apple Advertising ID. For desktop apps, this may be an ID that you need to generate.

If your app offers a universal opt-out for ad-tracking: for opted-out users, please pass the value “null” (case sensitive) – see examples below. This should be tested before submitting your app to Outbrain QA.

In addition to this identifier, Outbrain has a cookie sync solution. Talk with your account manager to decide if your app is eligible.

Add the data-ob-user-id attribute to the div:

data-ob-user-id="UNIQUE_USER_IDENTIFIER"

In case the user is opted-out:

data-ob-user-id="null"

Optional parameter for HTTPS support

In case your app needs to support HTTPS calls to Outbrain’s back end, add to the div:

data-is-secured="true"


Navigate to Paid Recommendations

It is recommended to navigate to the user’s default browser for all paid recommendations, rather than using a native webview inside the app.

Please make sure to open the paid recommendation via Outbrain redirect URL (paid.outbrain.com) without any URL manipulation.