Integrating With Apsalar

Last Updated: Aug 18, 2015 04:24PM PDT

About this Guide

This document will define the client-side* attribution integration process, including necessary information for configuring Attribution Tracking Tags and postbacks.  


Becoming an Integrated Ad Network With Apsalar

By becoming a fully integrated ad network partner with Apsalar, Apsalar's advertisers will be able to generate pre-configured attribution tracking tags for install and re-engagement** campaigns with your ad network's custom macros.  For conversion tracking, Apsalar has features that can report any installs attributed to these campaigns back to your ad network via postbacks. Configuring these postbacks for your network will be simple for the advertiser to implement with our postback template system.  Lastly, our partner publisher portal will allow you view high-level data and health of the campaigns you are running with your advertiser.

If your network is looking to integrate with Apsalar for the first time, the below can help you prepare for what to expect before you reach out to us.  If your network is already integrated with Apsalar, but you would like to verify or update your integration with us, please email support

For sample attribution tracking tag and postback template implementations, see here.

For more information on the partner publisher portal and its capabilities, see here.

 

Preparing for Integration

Depending on your network's needs, supported features, and supported platforms, you will need the following for the Apsalar network integration process:
  • Your network’s macros for values can passed in the attribution tracking click URL 
  • Your network’s install and post-install postback templates
  • Test devices (iOS and Android) and their device IDs or advertising IDs

The Integration Process

Once you're ready to begin the integration process, please proceed with the following steps:

1. Contact Apsalar Support

Email Apsalar support at support@apsalar.com.  Our team will provide a questionnaire you will be asked to fill out, which will provide our team with the necessary information to complete your integration.

2. The Questionnaire

Apsalar will use the information from the questionnaire to integrate the your macros and postbacks into Apsalar's Attribution Tracking Tag generation tool.  While some macros are optional, we strongly encourage including all those available as some clients prefer networks to have these optional values available and will delay a campaign's start until they are in place.

Using the provided questionnaire, provide Apsalar with:

  • Your Network's Macro formats for device information (if available) and campaign data
  • Your Network's required passthrough parameters
  • Your desired postbacks. Three types are currently supported:
    • Install Postback - Notification of attributed installs
    • Revenue Event Postback - Notification of revenue events for attributed traffic
    • Custom Event Postback - Notification of a user's custom event for attributed traffic

To see the available values which Apsalar can provide in each postback, please see this table. It's important to note that any value can be passed back via the postback if designated as a passthrough parameter.

After submitting your questionnaire responses, please reply to Apsalar support notifying our team of your questionnaires submission.  We will then review your responses and get back to you if we have any questions.  Once we're all set, our team will perform the integration.

3. Testing the Integration

After our team completes the integration on our side, we will send test instructions for our test apps and test attribution tracking tags for the requested platforms.

You can then traffic these test URIs on their network and using the test application(s) and device(s), perform a successful installation of the test app(s).

Apsalar will provide specific testing instructions for your network, but below you will find sample test instructions for iOS and Android platforms:

Android Test Instructions

  1. Traffic the provided test attribution tracking tag on the Ad Network's ad server, after filling in the required parameters. Here's an example of an attribution tracking tag:
    http://ad.apsalar.com/api/v1/ad?ca=SampleNetworkCampaign&an=SampleNetwork&a=ApsalarIDManager&i=com.apsalar.prod.accountmanager&p=Android&s=Apsalar+ID+Manager+%28Android%29&pl=SampleGroup&andi=[ANDROID_ID]&ip=[IP_ADD]&s=[PUB_ID]&cl=[CLICK_ID]&sample_passthrough=[SP]&h=b3c7dbaf694e58abf02eff221692a8e8e28a75ae
  2. On the designated testing device, click the ad and download the test app from Google Play.
    - FYI, the Android app is located at https://play.google.com/store/apps/details?id=com.apsalar.prod.accountmanager
  3. Start the Apsalar ID Manager application.
  4. Validate a postback has been sent to the Ad Network's designated conversion endpoint. Here is a sample postback URL with Apsalar's macros:
    http://sample.network.com/install?sp={sample_passthrough}&click_id={cl}&raw_android_id={ANDI}

iOS Test Instructions

  1. Traffic the provided attribution tracking tag on the Ad Network's ad server, after filling in the required parameters. Here's an example of an attribution tracking tag:
    http://ad.apsalar.com/api/v1/ad?ca=SampleNetworkCampaign&an=SampleNetwork&a=ApsalarIDManager&i=com.apsalar.balloonjump&p=iOS&s=[PUB_ID]&pl=SampleGroup&udid=[RAW_UDID]&idfa=[IDFA]&odin=[ODIN1]&ip=[IP_ADD]&cl=[CLICK_ID]&sample_passthrough=[SP]&h=12df63d2c3bab967941e0b0ba245abca3a8b09b0
  2. On the designated testing device, click the ad and download the test app from iTunes store.
  3. Start the Balloon Jump app.
  4. Validate a postback has been sent to the Ad Network's designated conversion endpoint. Here is a sample postback URL with Apsalar macros:
    http://sample.network.com/install?sp={sample_passthrough}&click_id={cl}&sha1_mac={MAC1}&raw_advertising_id={IDFA}

    Please Note: Should a second test be required, please use a fresh test device. 

4. Verify Test Results

Once you have completed your test on all supported platforms, we will confirm that both parties have received the proper notifications for the click, installation, and any applicable events with all the appropriate parameters. Once confirmed, the integration is complete and your ad network is now a certified partner.

 
*Apsalar generally integrates with it's ad network partners through a client-side attribution model. Server-to-server integration is possible, though the former is the preferred method.  If your network is considering a server-to-server integration, reach our to our support team for more information on Apsalar's requirements.

**Apsalar requires device/advertising IDs to be available for tracking re-engagement clicks.
support@apsalar.com
http://assets3.desk.com/
apsalarinc
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
Invalid characters found
/customer/en/portal/articles/autocomplete