The partner conversion link carries information about conversions from you to your publisher through a combination of parameters, values, and macros. Using TUNE macros, you can send data like mobile device identifiers, partner sub IDs, and conversion sale amounts to your publisher.
In this article, we go over how to set up your partner conversion link to pass information into your partner’s parameters. At the bottom, we also include reference tables of all the macros you can use in the partner conversion link.
This article is part of our Platform Basics series.
Inserting Macros in Partner Conversion Links
If your publisher wants a value stored by TUNE, insert the macro for that data in the corresponding parameter. Work with your publisher to ensure that any data you insert using macros matches up with their expectations for each parameter of the offer URL.
Some values stored by TUNE come from external sources. When using macros for these values, the values must also be requested via parameters in the conversion link or partner tracking link. Common values to be requested and stored are conversion sale amounts, advertiser sub IDs, partner click IDs, and partner sub IDs.
Example: Partner Validation
Your partner wants an extra level of conversion validation in their own tracking system. Their solution is to pass session IDs from their tracking system into TUNE, and have you return the same values in the partner conversion link.
Because the partner’s session ID comes from a source external to TUNE, it needs to be stored in TUNE. To do this, you append the partner click ID parameter (aff_click_id) to the partner tracking link. You also give it a placeholder value (like “AFFSESSIONID”) so your partner knows where to provide their session ID:
http://demo.go2cloud.org/aff_c?offer_id=1001&aff_id=2002&aff_click_id=AFFSESSIONID
Now to return the data, you set up your partner conversion link. Let’s say you receive the following partner conversion link from your partner, where they want you to return their session ID in the "sid" parameter:
http://track.publisher.com/conversion?sid=SESSIONID
In this link, you replace the placeholder value “SESSIONID” with the TUNE macro corresponding to the stored session ID ({aff_click_id}):
http://track.publisher.com/conversion?sid={aff_click_id}
At this point, you can insert the partner conversion link into TUNE. Then when a conversion happens, TUNE notifies the partner’s tracking system, replacing the {aff_click_id} macro with the partner’s stored session ID from the tracking link.
Table of Macros
The following TUNE macros can be used in partner conversion links:
| Macro | Description |
|---|---|
| {adv_sub} | Advertiser sub ID 1 specified in the conversion link |
| {adv_sub2} | Advertiser sub ID 2 specified in the conversion link |
| {adv_sub3} | Advertiser sub ID 3 specified in the conversion link |
| {adv_sub4} | Advertiser sub ID 4 specified in the conversion link |
| {adv_sub5} | Advertiser sub ID 5 specified in the conversion link |
| {advertiser_id} | The ID of the advertiser for the offer |
| {advertiser_ref} | Reference ID of the advertiser for the offer |
| {aff_click_id} | Partner click ID specified in the tracking link |
| {aff_sub} | Partner sub ID 1 specified in the tracking link |
| {aff_sub2} | Partner sub ID 2 specified in the tracking link |
| {aff_sub3} | Partner sub ID 3 specified in the tracking link |
| {aff_sub4} | Partner sub ID 4 specified in the tracking link |
| {aff_sub5} | Partner sub ID 5 specified in the tracking link |
| {aff_unique1} | Partner unique value 1 specified in the tracking link |
| {aff_unique2} | Partner unique value 2 specified in the tracking link |
| {aff_unique3} | Partner unique value 3 specified in the tracking link |
| {aff_unique4} | Partner unique value 4 specified in the tracking link |
| {aff_unique5} | Partner unique value 5 specified in the tracking link |
| {affiliate_id} | The ID of the partner promoting the offer |
| {affiliate_name} | Name of partner promoting the offer |
| {affiliate_ref} | Reference ID of partner promoting the offer |
| {country_code} | User’s two-letter country code provided by Digital Element based on IP address. For example, “US” for the United States. |
| {currency} | Three-letter ISO currency abbreviation |
| {customer_id} | ID value assigned to the customer on the first conversion (with customer lists) |
| {date} | The current date is formatted as YYYY-MM-DD |
| {datetime} | Current date and time formatted as YYYY-MM-DD HH:MM:SS |
| {file_name} | The filename of the creative used for the offer (this is the file name, not the creative’s name in the platform) |
| {goal_id} | The ID of the offer goal (if blank, then default goal is used) |
| {goal_ref} | Reference ID of the offer goal |
| {ip} | The IP address that sent the conversion notification |
| {mobile_carrier} | Name of user’s mobile carrier |
| {offer_file_id} | The ID of the creative file used for the offer |
| {offer_id} | Offer’s ID in TUNE |
| {offer_name} | Offer’s name in TUNE |
| {offer_ref} | Offer’s reference ID in TUNE |
| {offer_url_id} | The ID of the offer URL used in the session |
| {payout} | Offer payout to partner |
| {ran} | Randomly generated number |
| {referer} | Referring URL of an HTTP request that sent the conversion notification |
| {revenue} | Revenue from advertiser |
| {sale_amount} | Amount of a generated sale (on conversion). Macro is only populated when the “Sale Amount” network-wide partner setting is enabled. |
| {session_ip} | The IP address that started the click session |
| {session_timestamp} | Session time for a conversion formatted in UTC |
| {session_timestamp_rakuten} | Session time for a conversion formatted to work with Rakuten time format yyyymmdd_hhmm |
| {source} | Partner’s traffic source specified in the tracking link |
| {time} | Current time formatted as HH:MM:SS |
| {transaction_id} | TUNE transaction ID |
| {user_agent} | URL-encoded user agent string determined at the time of click. Macro is only populated when the “Track User-agent on Click” network-wide tracking setting is enabled. |
Mobile Tracking Macros
When you want to store additional information about the attribution of mobile app installs or events, you can do so using our mobile tracking parameters. The TUNE mobile tracking macros correspond to those parameters and are often used to communicate unique identifiers to another tracking system for attribution validation.
In your partner conversion links, you can support mobile device attribution using the following mobile tracking macros:
| Macro | Description |
|---|---|
| {device_brand} | Brand name of user’s device from user agent string (example: Apple) |
| {device_model} | The model name of the user’s device from the user agent string (example: iPhone) |
| {device_os} | OS name of user’s device from user agent string (example: iOS) |
| {device_os_version} | OS version of user’s device from user agent string (example: 4.3.2) |
| {google_aid} | Google Android advertising identifier used to attribute clicks to installs for apps in the Google Play store |
| {google_aid_sha1} | SHA1 hash of the Google Android advertising ID |
| {ios_ifa} | Apple iOS advertising identifier (iOS 6+) |
| {ios_ifa_sha1} | SHA1 hash of iOS device’s IFA ID |
| {ios_ifv} | Apple iOS vendor identifier (iOS 6+) |
| {unid} | A catch-all for unknown mobile device identifiers |
| {user_id} | Application-specific user ID (generated by the app developer) |
| {windows_aid} | Windows device advertising identifier |
| {windows_aid_sha1} | SHA1 hash of the Windows advertising ID |