Media Postback Macro
Postback macro
“Postback Macro” is used for sending dynamic data collected by adbrix to the media partners.
You can create a Postback URL using the postback macro list on this page. The adbrix postback server will check your postback URL whenever the event occurs and send postback to the partner server.
Some “Postback Macro” cannot be used on postback types (Attribution / Event), Attributions and event types(first_install, last_install, last_deeplink). Please see the postback type and postback macro for configuring the postback URL.
Attribution Postback Macro
Attribution postback is the postback data sent to the media's postback server when the user executes "App Open Event".
*App Open Event
- first_install: New Install
- last_install: Last Install (If the new install is only attribution, first_install = last_install)
- last_deeplink: Open the app with deeplink.
Click Data
This is the macro list of tracking link click data. These click data macro will be sent to your server when the attribution has happened.
All these macro can be used on all attribution event types like first_install, last_install, and last_deeplink.
| Macro | Description | Sample | |
| Click | {a_key} | Click ID provided by Adbrix | 1530859076437:902a3631-676a-4d57-a428-f7d8962775ad |
| {a_cookie} | Click cookie data provided by Adbrix | 131bc0bc-ceba-4be9-9aa3-b163d9e5afec | |
| {a_ip} | Click ip address provided by Adbrix | 14.33.77.170 | |
| {a_fp} | Click device fingerprint provided by Adbrix | Android 7.0:LG-F800L:14.33.77.170 | |
| {a_country} | Click current country code provided by Adbrix | kr | |
| {a_city} | Click current city provided by Adbrix | suwon-si | |
| {a_region} | Click current province provided by Adbrix | gyeonggi-do | |
| {a_appkey} | Click appKey provided by Adbrix | 6aE6E7OO5EOsw35P8vCHtQ | |
| {a_partner} | Click partner key provided by Adbrix | WWEzlPofL0CKBJQQLweyHw | |
| {adv_agency} | Click agency data provided by Adbrix | a_agency | |
| {adv_adgroup} | Click advertising group data provided by Adbrix | a_my_adgroup | |
| {adv_ad} | Click advertisement data provided by Adbrix | a_my_ad | |
| {adv_campaign} | Click campaign data provided by Adbrix | a_my_campaign | |
| {a_adtouch_datetime} | Adtouch datetime (Adbrix server time) | 2019-06-25 02:31:43.603 | |
| {a_adtouch_timestamp} | Adtouch datetime (Adbrix server time) | 1561429903 | |
| {a_adtouch_timestamp_d} | Adtouch datetime (Adbrix server time) | 1561429903.60351 | |
| {a_tracker_name} | Tracking link Name(other partners' attribution: empty / Custom Partner: every value) |
test tracking link
|
|
| {i_tracker_id} | Tracking link ID(other partners' attribution: empty / Custom Partner: every value) | jApABmJFs0eBLALu8iV7cA | |
| {a_partner_name} | Partner nameother partners' attribution: empty / Custom Partner: every value) |
ADBRIX REMASTER TEAM |
|
| {a_partner} |
Partner ID(other partners' attribution: empty / Custom Partner: every value) |
UH9jFmSaFUuKTMpvwDu5aA | |
| Partner | {m_creative} | Creative ID data provide by partner | m_createive_ |
| {m_publisher} | Media ID provide by partner | pub_id_120 | |
| {m_sub_publisher} | Sub media ID provide by partner | sub_pub_id_980 | |
| {m_adgroup} | Advertising group ID provide by partner | Test_English_adgroup | |
| {m_ad} | Advertisement ID data provide by partner | Test_English_ad | |
| {m_keyword} | Keyword ID provide by partner | Test_English_keyword | |
| {m_placement} | Advertising placement ID provide by partner | Test_English_placement | |
| {m_cost_model} | Type of advertising settlement provide by partner | 0 | |
| {m_cost} | Advertisement budget provide by partner | 1000 | |
| {m_cost_currency} | Advertisement budget currency type provided by the partner | krw | |
| {m_play_percent} | Percentage of advertisement play provide by partner | 20 | |
| {m_play_second} | Play time of advertisement provide by partner | 10 | |
| {m_view_percent} | Percentage of advertisement view provide by partner | 10 | |
| {m_view_second} | Vier time of advertisement provide by partner | 4 | |
| {cb_1} | Partner click data | click_data_1 | |
| {cb_2} | Partner click data | click_data_2 | |
| {cb_3} | Partner click data | click_data_3 | |
| {cb_4} | Partner click data | click_data_4 | |
| {cb_5} | Partner click data | click_data_5 | |
| {m_adid} | Device ID provide by partner (GAID, IDFA) | 0fa27c1e-9378-4d1c-8f01-118e094240e5 | |
| GA | {utm_source} | GA Tracking Data | utm_source_data |
| {utm_medium} | GA Tracking Data | utm_medium_data | |
| {utm_campaign} | GA Tracking Data | utm_campaign_data | |
| {utm_term} | GA Tracking Data | utm_data | |
| {utm_content} | GA Tracking Data | utm_content_data |
Attribution data
This is the list of attribution data macro.
All these macro can be used on all attribution event type like first_install, last_install, last_deeplink
| Macro | Description | Example | |
| Device | {req.common.identity.adid} | Device ID (Google GAID /Apple IDFA ) | 0fa27c1e-9378-4d1c-8f01-118e094240e5(IDFA: user's consent is mandatory or you receive empty value) |
| {req.common.identity.gaid} | Google GAID | ||
| {req.common.identity.idfa} | Apple IDFA | ||
| {req.common.identity.idfv} | Apple vendor ID | ||
| {req.common.identity.ad_id_opt_out} | Adblock info | FALSE | |
| {req.common.device_info.os} | Device OS version | 6 | |
| {req.common.device_info.model} | Device Model name | modelmodel | |
| {req.common.device_info.vendor} | Device manufacturer | samsung | |
| {req.common.device_info.resolution} | Device resolution (landscape x height) | 800x600 | |
| {req.common.device_info.is_portrait} | Device Orientation | FALSE | |
| {req.common.device_info.platform} | Device Platform (iOS / Android) | 1 | |
| {req.common.device_info.network} | Device Network type | network | |
| {req.common.device_info.is_wifi_only} | Device cellular data support | FALSE | |
| {req.common.device_info.carrier} | Device Carrier | skt | |
| {req.common.device_info.language} | Device Language | kr | |
| {req.common.device_info.country} | Device Country | ko | |
| {req.common.build_id} | Device build_id | 1 | |
| App | {req.common.package_name} | Android package name / Apple bundle ID | com.adbrix.v2 |
| {req.common.appkey} | Adbrix Remaster Appkey | 6aE6E7OO5EOsw35P8vCHtQ | |
| {req.common.sdk_version} | Adbrix Remaster SDK version | 1.1.1 | |
| {req.common.installer} | Installer info | ||
| {req.common.app_version} | App version | 1.0.0 | |
| Attribution | {attr_type} | Attribution Event Type | See the below attribution type table |
| {attr_model_flag} | Attribution model type(numeric) | See the below attribution type table | |
| {attr_model_str} | Attribution model type(string) | See the below attribution type table | |
| {i_request_type} |
Attribution AD touch type |
See the below AD touch type table |
|
| {event_name} | Attribution Event Name | abx:sign_up | |
| {is_attr_owner} | Attribution acquired | 1 (acquired: 1) | |
| {is_organic} | Organic attribution | 1 (Oranic: 1) | |
| {is_new_user} |
New-install / Re-install |
1 / 0 | |
| {req.evt.event_datetime} | Attribution event datetime | 2019-06-25 02:25:57.747 | |
| {req.evt.event_timestamp} | Attribution event datetime | 1561429557 | |
| {req.evt.event_timestamp_d} | Attribution event datetime | 1561429557.747 | |
| {deeplink_custom_path} | Attribution Deeplink info | scheme://host?key=value | |
| {req.evt.param.abx:market_install_btn_clicked} | Install button click time provided by Google | 1530859019 | |
| {req.evt.param.abx:app_install_start} | Install start time provided by Google | 1530859079 | |
| {req.evt.param.abx:app_install_completed} | Install complete time provided by Google | 1530859079 | |
| {req.evt.param.abx:app_first_open} | First App open time provided by Google | 1530859079 | |
| {seconds_gap} | Click to Install Time | 3 |
Event Postback Macro
Event postback is the in-app event data, collected by adbrix SDK, sent to your media server.
Event postback macro offers attribution data with the in-app event and in-app event data.
Attribution Data
This is the macro list for attribution data with the in-app event.
These macros can be offered based on *attribution event type.
*Attribution event type
- first_install : First install attribution
- last_install : Last install attribution (If first install is last one first_install = last_install)
- last_deeplink : Last app open attribution
- last : (Regardless attribution event type) Last attribution
Macro can be used in {attribution_type.data_name} format based on the attribution event types.
All these macro can be used on all attribution event type. (first_install, last_install, last_deeplink, last)
Base macro's attribution_type can be substituted by all event attribution event type.
Example) {attibution_type.cb_1} Substitute base macro for all attribution event type.
- {first_install.cb_1} : Click data from first install attribution event
- {last_install.cb_1} : Click data from last install attribution event
- {last_deeplink.cb_1} : Click data from last open attribution event
- {last.cb_1} : (Regardless attribution event type) Click data from last attribution event
| Base macro | Description | Sample | |
| Click | {attribution_type.a_key} | Click data provide by Adbrix | 1530859076437:902a3631-676a-4d57-a428-f7d8962775ad |
| {attribution_type.a_cookie} | Click cookie data provide by Adbrix | 131bc0bc-ceba-4be9-9aa3-b163d9e5afec | |
| {attribution_type.a_ip} | Click ip data provide by Adbrix | 14.33.77.170 | |
| {attribution_type.a_fp} | Click fingerprint data provide by Adbrix | Android 7.0:LG-F800L:14.33.77.170 | |
| {attribution_type.a_country} | Click country code provide by Adbrix | kr | |
| {attribution_type.a_city} | Click city data provide by Adbrix | suwon-si | |
| {attribution_type.a_region} | Click province data provide by Adbrix | gyeonggi-do | |
| {attribution_type.a_appkey} | Click appkey data provide by Adbrix | 6aE6E7OO5EOsw35P8vCHtQ | |
| {attribution_type.a_partner} | Click partner_key provide by Adbrix | WWEzlPofL0CKBJQQLweyHw | |
| {attribution_type.a_agency} | Click agency data provide by Adbrix | a_agency_ | |
| {attribution_type.a_my_adgroup} | Click Ad group data provide by Adbrix | a_my_adgroup_ | |
| {attribution_type.a_my_ad} | Click advertise data provide by Adbrix | a_my_ad_ | |
| {attribution_type.a_my_campaign} | Click campaign data provide by Adbrix | a_my_campaign_ | |
| {attribution_type.a_adtouch_datetime} | Adtouch datetime (Base on Adbrix server time) | 2019-06-25 02:31:43.603 | |
| {attribution_type.a_adtouch_timestamp} | Adtouch datetime (Base on Adbrix server time) | 1561429903 | |
| {attribution_type.a_adtouch_timestamp_d} | Adtouch datetime (Base on Adbrix server time) | 1561429903.60351 | |
| {attribution_type.a_tracker_name} | Tracking link Name(other partners' attribution: empty / Custom Partner: every value) | test tracking link | |
| {attribution_type.i_tracker_id} | Tracking link ID(other partners' attribution: empty / Custom Partner: every value) | jApABmJFs0eBLALu8iV7cA | |
| {attribution_type.a_partner_name} | Partner nameother partners' attribution: empty / Custom Partner: every value) |
ADBRIX REMASTER TEAM |
|
| {attribution_type.a_partner} |
Partner ID(other partners' attribution: empty / Custom Partner: every value) |
UH9jFmSaFUuKTMpvwDu5aA | |
| Partner | {attribution_type.m_creative} | Ad creative data provide by partner | m_createive_ |
| {attribution_type.m_publisher} | Media id provide by partner | pub_id_120 | |
| {attribution_type.m_sub_publisher} | Sub media id provide by partner | sub_pub_id_980 | |
| {attribution_type.m_adgroup} | Ad group id provide by partner | Test_English_adgroup | |
| {attribution_type.m_ad} | Ad id provide by partner | Test_English_ad | |
| {attribution_type.m_keyword} | Keyword id provide by partner | Test_English_keyword | |
| {attribution_type.m_placement} | Ad placement ID provide by partner | Test_English_location | |
| {attribution_type.m_cost_model} | Cost model type provide by Adbrix | 0 | |
| {attribution_type.m_cost} | Ad budget provide by partner | 1000 | |
| {attribution_type.m_cost_currency} | Ad budget currency type provide by partner | krw | |
| {attribution_type.m_play_percent} | Ad play percentage provide by partner | 20 | |
| {attribution_type.m_play_second} | Ad play time provide by partner | 10 | |
| {attribution_type.m_view_percent} | Ad view percentage provide by partner | 10 | |
| {attribution_type.m_view_second} | View time provide by partner | 4 | |
| {attribution_type.cb_1} | Partner click data | click_data_1 | |
| {attribution_type.cb_2} | Partner click data | click_data_2 | |
| {attribution_type.cb_3} | Partner click data | click_data_3 | |
| {attribution_type.cb_4} | Partner click data | click_data_4 | |
| {attribution_type.cb_5} | Partner click data | click_data_5 | |
| {attribution_type.m_adid} | Device id collect by partner (GAID, IDFA) | 0fa27c1e-9378-4d1c-8f01-118e094240e5 | |
| GA | {attribution_type.utm_source} | GA tracking data | utm_source_data |
| {attribution_type.utm_medium} | GA tracking data | utm_medium_data | |
| {attribution_type.utm_campaign} | GA tracking data | utm_campaign_data | |
| {attribution_type.utm_term} | GA tracking data | utm_term_data | |
| {attribution_type.utm_content} | GA tracking data | utm_content_data | |
| Attribution | {attribution_type.is_attr_owner} | Attribution acquired | 1(acquired: 1) |
| {attribution_type.attr_type} | Attribution Event Type | See the below attribution type table | |
| {attribution_type.attr_model_flag} | Attribution model type(numeric) | See the below attribution model table | |
| {attribution_type.attr_model_str} | Attribution model name(string) | See the below attribution model table | |
| {attribution_type.i_request_type} | Attirubtion ad toch type | See the below attribution AD touch type table | |
| {attribution_type.attribute_datetime} | Attribution datatime | 2018-07-0607:01:41.436 | |
| {attribution_type.attribute_timestamp} | Attribution timestamp | 1509670980 | |
| {attribution_type.attribute_timestamp_d} | Attribution timestamp with millisecond | 1509670980.235 | |
| {attribution_type.seconds_gap} | Click to install time | 3 | |
| {attribution_type.deeplink_custom_path} | Deeplink url info | scheme://host?key=value |
Event Data
Send event data, collected by adbrix SDK, to the media server.
There are two event types: adbrix SDK “pre-defined event type” and “custom event” using adbrix SDK.
- Adbrix SDK pre-defined event
- Event which collected directly by adbrix SDK (Example: app_start , app_open etc)
- evt.group : abx
- Adbrix SDK pre-defined event (Example: Tutorial_complete, purchase etc)
- evt.group : abx
- Event which collected directly by adbrix SDK (Example: app_start , app_open etc)
- Custom event
- custom event using Adbrix SDK. (not pre-defined)
- evt.group : custom
- custom event using Adbrix SDK. (not pre-defined)
- The postback macro of a single product is deprecated. Instead of them, we provide all the data belonging to commerce events as JSON at once, so use {req.evt.param_json} macro. If you want the details and samples about JSON, please send the email to support-tracker@adbrixsupport.zendesk.com.
| Macro | Description | Example | |
| Device | {req.common.identity.adid} | Device ID (Google GAID /Apple IDFA ) |
0fa27c1e-9378-4d1c-8f01-118e094240e5(IDFA: user's consent is mandatory or you receive empty value) |
| {req.common.identity.gaid} | Google GAID | ||
| {req.common.identity.idfa} | APPLE IDFA | ||
| {req.common.identity.idfv} | Apple vendor ID | ||
| {req.common.identity.ad_id_opt_out} | Adblock info | FALSE | |
| {req.common.device_info.os} | Device OS version | 6 | |
| {req.common.device_info.model} | Device Model name | modelmodel | |
| {req.common.device_info.vendor} | Device manufacturer | samsung | |
| {req.common.device_info.resolution} | Device resolution (landscape x height) | 800x600 | |
| {req.common.device_info.is_portrait} | Device Orientation | FALSE | |
| {req.common.device_info.platform} | Device Platform (iOS / Android) | 1 | |
| {req.common.device_info.network} | Device Network type | network | |
| {req.common.device_info.is_wifi_only} | Device cellular data support | FALSE | |
| {req.common.device_info.carrier} | Device Carrier | skt | |
| {req.common.device_info.language} | Device Language | kr | |
| {req.common.device_info.country} | Device Country | ko | |
| {req.common.build_id} | Device build_id | 1 | |
| App | {req.common.package_name} | Android package name / Apple bundle ID | com.adbrix.v2 |
| {req.common.appkey} | Adbrix Remaster Appkey | 6aE6E7OO5EOsw35P8vCHtQ | |
| {req.common.sdk_version} | Adbrix Remaster SDK version | 1.1.1 | |
| {req.common.installer} | Installer info | ||
| {req.common.app_version} | App version | 1.0.0 | |
| event | {req.evt.event_name} | Event name | abx:firstopen |
| {req.evt.group} | Event group | abx | |
| {req.evt.event_datetime} | Event datetime | 2018-07-0607:01:49.615 | |
| {req.evt.event_timestamp} | Event timestamp | 1509670980 | |
| {req.evt.event_timestamp_d} | Event timestamp with millisecond | 1509670980.235 | |
|
(deprecated) |
{ |
||
|
{req.evt.param.abx:order_id} |
Commerce: order id |
a123456789 | |
|
{req.evt.param.abx:order_sales} |
Commerce: total price |
299000.0 | |
|
(deprecated) |
30290121 |
||
|
(deprecated) |
2019 Summer season limited product |
||
|
(deprecated) |
50000.00 |
||
|
(deprecated) |
10 |
||
|
(deprecated) |
40000.00 |
||
|
(deprecated) |
10000.00 |
||
|
(deprecated) |
KRW |
||
|
(deprecated) |
Season sale |
||
| {req.evt.param_json} | Event parameter (JSON type) | If you need sample JSON, please request support-tracker@adbrixsupport.zendesk.com |
Appendix
Adbrix pre-defined event
Adbrix can offer pre-defined event data that is commonly used for app marketing.
| {evt.group} | {evt.event_name} | Description | |
| Common | abx | abx:daily_first_open | Daily first app open |
| abx | abx:sign_up | App Sign up | |
| abx | abx:login | App Login | |
| abx | abx:app_update | App update | |
| abx | abx:use_credit | Use in-app point | |
| abx | abx:purchase | In-app purchase | |
| Game | abx | abx:tutorial_complete | Tutorial complete |
| abx | abx:level_achieved | Level up | |
| abx | abx:character_created | Create character | |
| abx | abx:stage_cleared | Stage clear | |
| Commerce | abx | abx:view_home | App's main view |
| abx | abx:product_view | Product view | |
| abx | abx:add_to_cart | Add to cart | |
| abx | abx:add_to_wishList | Add to wishlist | |
| abx | abx:list_view | Product list view | |
| abx | abx:cart_view | Cart view | |
| abx | abx:review_order | Confirm order | |
| abx | abx:refund | Refund (order cancel) | |
| abx | abx:search | Product search | |
| abx | abx:share | Share | |
| abx | abx:payment_info_added | Add payment info |
Attribution Type
Every attribution must have one attribution type.
{attr_type} macro will return a number value depending on the attribution type.
| {attr_type} | Attribution Type | Description |
| 0 | new install | new install via a tracking link |
| 1 | re-install | reinstall via a tracking link |
| 2 | deep-link open | deep-link open via a tracking link |
Attribution Model Type
| {attr_model_flag} | {attr_model_str} | Description |
| 1 | clickid | attribution using adbrix click id(including google referrer) |
| 2 | adid | attribution using adid on adbrix click |
| 4 | cookie | attribution using cookie |
| 8 | fingerprint | attribution using adbrix click fingerprint |
| 16 | ip |
attribution using adbrix click IP |
| 32 | fb_ads | attribution via Facebook ADs |
| 64 | google_ads | attribution via Google ADs |
| 128 | search_ads | attribution via apple search |
| 256 | twitter_ads | attribution via Twitter ads |
AD Touch Type
A tracking link that attributes conversion has one ad touch type.
{i_request_type} will return a numeric value depending on the ad touch type.
| {i_request_type} | AD Touch Type | Description |
| 1 | impression | attribution via impression(exposure) |
| 2 | click | attribution via click |
| 3 | video | attribution via video(view) |
| 4 | playable | attribution via play type ads |
| 5 | invite | attribution via invitation |
| 6 | coupon | attribution via coupon |
| 7 | attribution via Facebook | |
| 8 | attribution via google |
If you have any further questions, please let us know through support-tracker@adbrixsupport.zendesk.com.