Use * syntax for faster search

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Column
width50%


Panel
borderColor#c8c8c8
borderWidth1
borderStylesolid

Table of Contents

Table of Contents
maxLevel2
indent20px
stylenone



Section

Overview

Customers using Adjust can have data sent to Beeswax for two use cases. Conversion (or event) attribution, and user segmentation.

Conversion Attribution

Please see Adjust documentation for specific guidance on tag handling.

Note

If you are a media company who is working with an advertiser uses Adjust:

The Adjust click URL generally looks something like:

Code Block
https://app.adjust.com/<tracker_token>

?campaign=CampaignName&adgroup=AdGroupName&creative=CreativeName&idfa_upper_sha1={{IOS_ID_SHA1}}&gps_adid_upper_sha1={{ANDROID_ID_SHA1}}&install_callback=<EscapedPostbackURLforInstall>&event_callback_<EventToken1>=<EscapedPostbackURLforInAppEvent1>&event_callback_<EventToken2>=<EscapedPostbackURLforInAppEvent2>

tracker_token is the special token of the specific network and is obtained from Adjust
Campaign is an optional parameter.  Normally, a static value is passed, but the Beeswax macro {{CAMPAIGN_ID_ALT}} can be used if the Alternative ID field is complete with the desired campaign name in the Edit Campaign screen.
Adgroup is an optional parameter.  It is normally a static value determined by the client.
Creative is an optional parameter.  Normally, a static value is passed, but the Beeswax macro {{CREATIVE_ID_ALT}} can be used if the Alternative ID field is complete with the desired campaign name in the Edit Campaign screen.
Install_callback is required.  It is the escaped version of the standard Beeswax postback. It will look something like:

https%3A%2F%2Fcnv.event.prod.bidr.io%2Flog%2Fpbk%3Ftag_id%3D1%26buzz_key%3Dyourbuzzkey%26auction_id%3D{{AUCTION_ID}}

It is important that the brackets around AUCTION_ID remain unescaped. Tag_id is the corresponding event ID in the Beeswax platform you have set up for installs. If you wish to track additional events, you would use the format:

Code Block
...&event_callback_EventToken1=<EscapedPostbackURLforInAppEvent1>&event_callback_EventToken2=<EscapedPostbackURLforInAppEvent2>&...
  • You can add as many event callbacks as you wish, but note you could theoretically bump up against a URL character limit.
  • The postback URL will look like the above except the tag_id should be replaced with the corresponding event (e.g. in-app purchase, new session, etc.)
  • EventToken1 and EventToken2 are unique tokens of custom events that clients implement in the Adjust SDK. It is not related to tracker_token.
  • You can connect multiple postback calls per install or event by using a + symbol between escaped callback URLs.  Note that the + should not be escaped.

It is important to include device ID macros for the most accurate conversion tracking. Be sure to include parameters: &idfa_upper_sha1={{IOS_ID_SHA1}}&gps_adid_upper_sha1={{ANDROID_ID_SHA1}}


If you are the advertiser who has the contract using Adjust:

The Adjust click URL should look something like:

https://app.adjust.com/<tracker_token>

?ref_id={{AUCTION_ID}} &campaign=CampaignName&adgroup=AdGroupName&creative=CreativeName& idfa_upper_sha1={{IOS_ID_SHA1}}&gps_adid_upper_sha1={{ANDROID_ID_SHA1}}

  • tracker_token is the special token of the specific network and is obtained from Adjust
  • ref_id is the placeholder to tell adjust to pass the auction ID through to Beeswax
  • Campaign is an optional parameter. Normally, a static value is passed, but the Beeswax macro {{CAMPAIGN_ID_ALT}} can be used if the Alternative ID field is complete with the desired campaign name in the Edit Campaign screen.
  • Adgroup is an optional parameter. It is normally a static value determined by the client.
  • Creative is an optional parameter. Normally, a static value is passed, but the Beeswax macro {{CREATIVE_ID_ALT}} can be used if the Alternative ID field is complete with the desired campaign name in the Edit Campaign screen.

It is important to include device ID macros for the most accurate conversion tracking. Be sure to include parameters: &idfa_upper_sha1={{IOS_ID_SHA1}}&gps_adid_upper_sha1={{ANDROID_ID_SHA1}}

In Adjust you should set Beeswax event pixels up as ‘real-time callbacks’. These are implemented on the Adjust backend, therefore removing the need for you to insert encoded postbacks in your click URLs and allowing for tracking of multiple events.

To set this up you must:

  • Create the ‘events’ in Beeswax you want to track
  • Go to the app they want to create callbacks for in Adjust
  • For each corresponding event in the UI (see below) add the appropriate Beeswax event callback URL in this format:
    • For non revenue based events: equal,{network_name},beeswax,https://cnv.event.prod.bidr.io/log/pbk?tag_id=YOUR_EVENT_ID&buzz_key=YOUR_BUZZKEY&auction_id={dcp_ref_id}
    • For revenue tracking events, please use the VALUE parameter: equal,{network_name},beeswax,https://cnv.event.prod.bidr.io/log/pbk?tag_id=YOUR_EVENT_ID&buzz_key=YOUR_BUZZKEY&auction_id={dcp_ref_id}&value={revenue_usd}
    • Be sure to replace ‘YOUR_BUZZKEY’ with your buzz key and YOUR_EVENT_ID with the ID of the event
  • Please contact your Beeswax representative who can run an E2E test to validate this is tracking and firing correctly



Audience Syncing

Customers of Beeswax and Adjust can sync users for targeting purposes. 

Option 1 **RECOMMENDED**

If you have the Adjust ‘Audience Builder’ product, Beeswax can automatically pick up audiences from the Adjust Audience builder and load them into Beeswax. 

To enable Beeswax to ingest data from Audience Builder, please reach out to your Beeswax representative who can help configure this for your account.

Option 2

Note

This option will only sync audiences from after the date of setting it live

You can push data into Beeswax via the Adjust ‘module’. This sends server side sync calls per event.

To enable this, please reach out to your Beeswax representative who will need to enable alternative segment ID for Segment postbacks for your account.

The steps you will need to perform once this has been enabled are:

  • In Beeswax, set up one segment per event type (e.g. install/session/purchase etc) and app combination
    • Ensure the Days (or ‘ttl_days’ in the API) is set to 90 days to ensure maximum retention time for these users
    • Set the Alternative ID of the segment to be ‘appbundle-eventtype’ where the app bundle is the one that is being advertised
    • For example ‘com.beeswax.mygame-install’ 
    • A list of the event types are be in the activity kind list here: https://partners.adjust.com/placeholders/
    • If you have custom events, you can use these in the event linking will be the ‘eventtype’
  • Set the Beeswax module to ‘on’ in Adjust and enter your buzzkey and the corresponding account ID (this is '2' by default) in the Adjust UI