You can append one or more of the following macros to your External Tracking URL in order to provide additional information to your third party impression trackers. For each impression sent to the tracker, the information you specify will automatically populate in the URL.
Macros |
|---|
Macro | Description | Example |
| request_query(<name of query parameter>) | Returns the value of a query parameter received by AudioSSP. | %%request_query(content_categories)%% |
| request_header(<name of header>) | Returns the value of a header parameter received by AudioSSP | %%request_header(X-Device-IP)%% |
| first_party(<name of value>) | Returns the first party information available for use | %%first_party(device_type)%% |
normalized_request_query(<name of query parameter>)
| Returns the normalized value of a query parameter received by AudioSSP
| %%normalized_request_query(content_categories)%%
|
| timestamp | Returns the current timestamp (number of seconds elapsed since Jan 1st 1970 UTC). This can be used to ensure unique URLs in situations where you’d otherwise be sending identical information, for example when multiple impressions come from the same place. | %%timestamp%% |
| random | Returns a random string of 40 characters. This can be used to ensure unique URLs in situations where you’d otherwise be sending identical information, for example when multiple impressions come from the same place. | %%random%% |
You can use the first_party macro with one or more of the below First Party Data Keys to dynamically populate your external tracking URL with specific information about each delivered impression. Third party trackers validate your impressions to your ad partner. You can also use a tracker to demonstrate the quality of your impressions, useful when negotiating direct ad deals.
First Party Data Keys |
|---|
Name | Description |
| ip | Listener IP Address |
| user_agent | Listener User Agent |
| referer | Listener Referrer |
| sid | Session ID (currently UUID v4) |
| geo_country | Geographical Country inferred from IP |
| geo_region | Geographical Region inferred from IP |
| geo_region_code | Geographical Region Code inferred from IP. States, provinces and territories use their established two letter abbreviation. All other regions use this mapping. |
| geo_city | Geographical City inferred from IP |
| geo_postalcode | Postal Code inferred from IP |
| geo_timezone | Listener Timezone, inferred from IP |
| geo_latitude | Geographical latitude, inferred from IP |
| geo_longitude | Geographical longitude, inferred from IP |
| geo_dma | Geographical DMA, inferred from IP |
| show_id | Podcast show ID |
| show_name | Podcast show name |
| episode_id | Podcast episode ID |
| content_country | Content country |
| content_language | Content language |
| content_categories | List of IAB categories describing the content |
| content_genre | Content genre |
| blocked_categories | List of blocked IAB categories |
| allowed_categories | List of allowed IAB categories |
| blocked_advertisers | List of blocked advertisers |
| publisher_name | Publisher name |
| publisher_id | Publisher ID |
| publisher_type | Publisher Type, example: Podcast, Radio etc. |
| publisher_domain | Publisher domain, example: live365.com |
| rss | RSS feed |
| bundle_id | Bundle ID |
| store_url | Store URL (for player apps) |
| listener_id | Listener ID, usually specified by a streaming server |
| app_name | Player app name, inferred from User Agent |
| bot_name | Bot name, inferred from User Agent |
| is_bot | Boolean indicating whether the player app is a bot or not, inferred from User Agent |
| browser | Listener browser details, inferred from User Agent |
| device | Listener device detail, inferred from User Agent |
| device_type | Listener device type, inferred from User Agent |
| library_name | Application library used by the listener, inferred from User Agent |
| position_name | Ad break position “name”, example: pre1 |
| position_type | Ad break position type, one of: preroll, midroll, postroll, inferred from position_name |
| seller_id | Seller id corresponding to the publisher and included in our sellers.json page |
| sid | Unique session ID in the form of an UUID v4 field |
| id5_token | ID5 token associated to the IP address |
| soundstack_user_id | Hash of IP and User Agent |
| is_datacenter | Boolean flag indicating whether IP was detected as part of a datacenter network. This suggests the impression comes from a |
Examples
https://example.domain.com/tracking/pixel?publisherId=%%first_party(publisher_id)%%&rn=%%random%%&ip=%%first_party(ip)%%
In this example, the URL would contain the publisher ID, a string of random characters, and the IP address of the listener for every impression.
https://example.domain.com/tracking/pixel?is_bot=%%first_party(is_bot)%%&rn=%%random%%&episode_id=%%first_party(episode_id)%%
In this example, the URL would contain a true/false result if the impression comes from a bot, a string of random characters, and the episode ID for every impression.