The description of different types of Macros
Overview
Macros enable advertisers to collect more information from click or impressionstrackers of their campaign. For example device ID, publisher ID, country code, etc. Macros are a string of text that can be included in any code thatʼs processed by the Adamiani platform (third-party HTML tags,VAST tags, click-through URLs, impression pixels, etc.) and are dynamicallyreplaced with their corresponding values. user cohorts
Macros and their descriptions
When a Macro is implemented, it will be replaced by a value that isgenerated each time a bid takesplace for an impression or click.
Adamiani supports Macros in the following categories
Mandatory Macro
Campaign specific
Macros Publisher
Specific Macros
User-specific Macros
Geo specific Macros
SKAdNetwork
Other Macros
Mandatory Macro
| Name | Description | Example |
|---|---|---|
| {CONVERSION_ID} | Mandatory Macro required to track unique bid ID. This Macro is used to track your App/ website events. | 2167783501-152389 708-822-1-3-130- jdezs- a2c0ee2d104b48a9b a102cd3abe1665c-3 4-143684-50257831. |
Sample Api End Point
Sample click URL: https://adamiani.net/5345r?bid_id={CONVERSION_ID}
Sample impressionURL: https://adamiani.net/impression/52682?bid_id={CONVERSION_ID}
Campaign Specific Macros
| Name | Description | Example |
|---|---|---|
| {CAMPAIGN_NAME} | Campaign name that is provided by advertisers during campaign setup. | - |
| {CREATIVE_NAME} | Creative name that is provided by advertisers during creative setup | - |
| {CAMPAIGN_ID} | Internally generated by adamiani | Numeric digits like 12389 |
| {CREATIVE_ID} | Internally generated by adamiani | Numeric digits like 12389 |
| {CREATIVE_TYPE} | Internally generated by adamiani | video, img, html, native |
| {ORDER_ID} | Internally generated by adamiani | Numeric digits like 12389 |
| {ADVERTISER_ID} | Internally generated by adamiani | Numeric digits like 12389 |
Sample click URL:
https://adamiani.net/5345r?bid_id={CONVERSION_ID}&campaign={CAMPAIGN_ID}_{CAMPAIGN_NAME}&creative={CREATIVE_ID}_{CREATIVE_NAME}
Publisher Specific Macros
| Name | Description | Example |
|---|---|---|
| {EXCHANGE_NAME} | Name of the exchange that was responsible to show the ad. | Mopub |
| {EXCHANGE_ID} | adamiani internal exchange ID. It can be used to form {EXCHANGE_ID} _{APP_ID} , the value of which is used in whitelisting or blacklisting of publisher apps | 23 |
| {PUBLISHER_ID} | Exchange specific alphanumeric ID for publishers | c475b45495a57e2e3a 242 542a98e249b. |
| {APP_NAME} | Publisherʼs app name that is present in the bid request. (including special characters) | "Color by Number #Coloring Book" |
| {APP_ID} | Exchange specific unique ID corresponding to the publisher app | 3b3614b0d8814fceaa d20 |
| {APP_DOMAIN} | The domain of the publisher site/app | vrtcl.com |
| {APP_BUNDLE} | Publisher app bundle | iOS App Bundle: 234672221 Android App Bundle: com.whatsapp |
| {APP_NAME_ALPHAN U M} | Publisherʼs app name after removing all the non- alphanumeric characters | Color by number Coloring Book |
Sample click URL:
https://adamiani.net/5345r?bid_id={CONVERSION_ID}&exc={EXCHANGE_ID}_{APP_ID}&pub={PUBLISHER_ID}
User Specific Macros
| Name | Description | Example |
|---|---|---|
| {DEVICE_OS_NAME} | Operating System of the user's device. | Android or iOS |
| {DEVICE_OS_VERSION} | Operating System Version of the user's device. | 10, 14.5 |
| {DEVICE_TYPE} | User device category | phone, tablet |
| {MANUFACTURER_NAM E} | Device Manufacturerʼs Name | Samsung |
| {MODEL_NAME} | Device Model Name | Galaxy M01 |
| {CARRIER_NAME} | Carrier Name of the user's network | Vodafone |
| {USER_IP} | User's IP Address for the impression or click | 45.51.3.76 |
| {USER_AGENT} | User Agent of the user's device. Url encoded. | Mozilla%2F5.0%20(iPh one%3B%20CPU%20i Phone%20OS%2014_ 2%20like%20Mac%20 OS%20X%20AppleWeb Kit%2F605.1.15%20(K HTML%2C%20like%20 Gecko)%20Mobile%2 F15E148 |
| {DEVICE_ID} | Device 15 digit IMEI number | 123456789009876 |
| {DEVICE_RAW_ID} | Os Spesicif Advertising ID of the device in RAW format if available in the bid request | 7e9547bd-3459-4ad 1-870d-0c40a51f57b c |
| {DEVICE_SHA1_ID} | OS specific Advertising ID of the Device in SHA1 format if available in the bid request | 7b23aeac50a2cc97b7 e5c0afdaf1a6045080 ba0f |
| {DEVICE_PLATFORM_ID} | Unique OS-specific Advertising ID of the Device (For e.g, iOS it will | 7e4567bd-3249-4dg 1- 876d-0c67j78o57df |
Sample click URL:
https://adamiani.net/5345r?bid_id={CONVERSION_ID}&carrier={CARRIER_NAME}&device={DEVICE_PLATFORM_ID}
Geo Specific Macros
| Name | Description | Example |
|---|---|---|
| {COUNTRY_CODE} | User's Country Code as defined by ISO-3166-1 alpha 3 standard | USA (for the United States of America) |
| {STATE_NAME} | California | 10, 14.5 |
| {STATE_CODE} | State Code as defined by ISO-3166-2 standard of all countries coded in ISO 3166-1 | US-CA (California state of the United States of America) |
| {CITY_NAME} | Userʼs City name | San Francisco |
| {ZIP_CODE} | Userʼs Zipcode | 94105 (San Francisco Zipcode) |
| {GPS_LAT}, {GPS_LON} | Latitude and Longitude coordinates of the user's device and Maxmind | GPS_Lat can be 52.521802 and GPS_lon can be 23.898763 |
| {GPS_LAT_BID}, {GPS_LON_BID} | Latitude and Longitude coordinates of the user's device from bid request. | Format same as {GPS_LAT}, {GPS_LON} |
Sample click URL:
https://adamiani.net/5345r?bid_id={CONVERSION_ID}&country={COUNTRY_CODE}&state={STATE_NAME}&city=[CITY_NAME]
SKAdNetwork Macros
| Name | Description | Example |
|---|---|---|
| {SKAN_CAMPAIGN_ID} | SKAN campaign ID assigned by adamiani | Kochava, Adjust MMP integrations |
| {SKAN_NETWORK_ID} | 4468km3ulz.skadnetwo rk for adamiani enterprise | Adjust |
| {SKAN_ADJUST_NETW OR K_TOKEN} | xylyea2j143k for adamiani enterprise | Adjust |
Other Macros
| Name | Description | Example |
|---|---|---|
| {TIMESTAMP} | Unix TimeStamp of the click or impression served | 1,593,561,601 |
| {DNT} | Boolean value for "Do not track" field in the bid request | True or False |
| {CACHEBUSTER} | Random number in the URL that is used to limit caching | Cachebuster can be 3468392872 |
| {APP_API_KEY} | Replaced by app/site object's API key. | |
| {HTML_CLICK_URL} | Macro to be added in your HTML code in the place of your click URL. This macro will be replaced by the adamiani {CLICK_URL} macro followed by the click URL available in the Tracker Asset. | |
| {HTML_COMPANION_C LI CK_URL} | Macro to be added in your HTML code used as video end card in the place of your click URL. This macro will be replaced by the adamiani companion click URL followed by the click URL available in the Tracker Asset. | |
| {CLICK_URL} | This macro is prefixed before the advertiser click URL. It is replaced by adamiani click URL. Soon to be deprecated, please use {HTML_CLICK_URL} | - |
| {CLICK_URL_ESC} | This Macro is added in the advertiser click URL. It is replaced by encoded | - |
Sample click URL:
https://adamiani.net/5345r?bid_id={CONVERSION_ID}&time={TIMESTAMP}
Note:
- You can combine Macros with an underscore, for example {EXCHANGE_ID}_{APP_ID}, this is used in the campaign for whitelisting/blacklisting of app ids.
- The two Macros {CLICK_URL} and {CLICK_URL_ESC} areused only in HTML creative type to track clicks. It isrecommended to use {CLICK_URL}.
HTML sample
<script src="https://tags.abc.com/myapp/creative/768x1024-
dynamic-js-call.js"
data-pixelId="OMMB15"
data-ios_idfa="{DEVICE_PLATFORM_ID}"
data-cid="{CAMPAIGN_ID}"
data-app="{APP_NAME_ALPHANUM}"
data-channel="inapp"
data-DNT="{DNT}"
data-ip="{USER_IP}"
data-userAgent="361"
data-ts="{TIMESTAMP}"
data-clickUrl="{CLICK_URL}">
</script>
<img decoding="async" src="https://pixel-ad.abc.com/pixel/event/OMMB15?
&android_gaid={DEVICE_PLATFORM_ID}&cid={CAMPAIGN}
&app={APP_NAME_ALPHANUM}&channel=inapp&cv=786x1024-
myapp&dnt={DNT}&ts={TIMESTAMP}" heigh="1" width="1">
<img decoding="async" src="https://bs.serving-sys.com/serving/adServer.bs?
cn=display&c=19&mc&pli=27474997&P1uID=0&ord=[timest]&rtu=1"
width="1" height="1" alt="">
Video
Implement the Macros you might need to track in the Client VAST
wrapper.
Image Native Ads
Native is an ad format where the ad experience follow the natural form and function of the location in which it is placed. They seamlessly integrate into a publisher’s app and native ads optimize the user experience as they blend into the app, driving high levels of engagement.
Video Creative Specs
File Format: .MP4, h264
Playback Speed: >24FPS
File-size: All video > 10mb will be compressed as needed. We don’t accept Video >150mb
