Menu

SE & Partner Data Integration

SolarEngine (SE) provides one-stop mobile app growth solution services to global publishers. This documentation is intended for product, development, and debugging personnel from both SE and cooperated partners to complete data interchange.

1. Receive Touchpoints Data

SE obtains advertising touchpoints data through tracking links. Tracking links are usually divided into impression links (Impression URLs) and click links (Click URLs), which are used to track ad impressions and clicks respectively.

The format of tracking links is as follows:

(1) The prefix format of the tracking link is: https://tkio-redirect.solar-engine.com/receive/turl/xxxxxxx?

(2) The format of macro "parameter" is "{parameter}", lowercase written with curly brackets on both sides.

     When an advertisement is displayed or clicked, the channel will replace the macro parameters in tracking links with real advertising information and send the data to SE according to the agreed format.

Parameter Description

Parameter NameExample Description
account_id 9dfe8503-5d3f-4440-bb3f-9e45b6179a4f Ad account id
adgroup_id 1725113652546577 Ad group id
adgroup_name kup_and_tier_6 Ad group name
adplan_id 17251136512312451 Ad plan id
adplan_name kup_and_tier Ad plan name
adcreative_id 17251136512342351 Ad creative id
adcreative_name kup_and_tier_ad Ad creative name
adcreative_type Big picture Creative type (such as large pictures, small pictures, videos, etc.)
site_id 23423233244 Sub-channel id
site_name Kuai Sub-channel name
ad_type Banner Ad type
placement_id 342323324412 Ad placement id
conversion_id 323324412131 Conversion id
click_id 2342323124 Ad click id
impression_id 2342312312 Ad impression id
request_id 2342323324 Ad request id
callback_id EJiw267wvfQCGKf2g74ZIPD89-vIATAMOAFCIjIwMTkxMTI3MTQxMTEzMDEwMDI2MDc3MjE1MTUwNTczNTBIAQ== Channel callback id
callback_urlhttp%3A%2F%2Ftracking.e.qq.com%2Fconv%3Fcb%3DMTIzYWJjNDU2ZGVm%26conv_id%3D12345678 Channel callback address
os 1: Android
2: iOS		 operating system
model Mate 40 Device model
ipv4 1.1.1.1 User public network IP
V4 version (Required)
ipv6 2409%3A8a55%3A4cc0%3A4050%3A2507%3A4922%3Abbe0%3A524b User public network IP V6 version
ua Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
AppleWebKit/537.36 (KHTML, like Gecko)
Chrome/95.0.4638.54
Safari/537.36		 The user agent information
(Required)
idfa 3DEA635F-B24F-434B-833F-4ED028FEAEEF iOS IDFA original value
idfa_md5 8e488a40a17aed2f6752f51382a4eafc iOS IDFA in lowercase after being encrypted through MD5
idfv 3DEA635F-B24F-434B-833F-4ED028FEAEEF iOS IDFV original value
idfv_md5 8e488a40a17aed2f6752f51382a4eafc iOS IDFV in lowercase after being encrypted through MD5
oaid 3DEA635F-B24F-434B-833F-4ED028FEAEEF Android OAID original value
oaid_md5 8e488a40a17aed2f6752f51382a4eafc Android OAID in lowercase after being encrypted through MD5
imei1 8342732742383 Android main card IMEI original value
imei1_md5 8e488a40a17aed2f6752f51382a4eafc Android main card IMEI in lowercase after being encrypted through MD5
imei2 8342732742383 Android secondary card IMEI original value
imei2_md5 8e488a40a17aed2f6752f51382a4eafc Android secondary card IMEI in lowercase after being encrypted through MD5
gaid B21C5EC5-9921-42FD-AAC5-07A0EB6CF1A0 Google Advertising ID original value
gaid_md5 8e488a40a17aed2f6752f51382a4eafc Google Advertising ID in lowercase after being encrypted through MD5
mac B21C5EC5-9921-42FD-AAC5-07A0EB6CF1A0 MAC original value
mac_md5 8e488a40a17aed2f6752f51382a4eafc MAC in lowercase after being encrypted through MD5
android_id 1a34fc556a43c453 Android ID original value
android_id_md5 8e488a40a17aed2f6752f51382a4eafc Android ID in lowercase after being encrypted through MD5
is_s2s 1=The server reports the touchpoints
0=The client reports the touchpoints		 Whether it is server-to-end data transmission
custom_params_1 23423523424 Custom
parameters. Fixed key name
custom_params_2 23423523425 Custom parameters. Fixed key name
custom_params_3 23423523426 Custom parameters. Fixed key name
custom_params_4 234235234247 Custom parameters. Fixed key name
custom_params_5 23423523428 Custom  parameters. Fixed key name
custom_params_6 23423523429 Custom parameters. Fixed key name
custom_params_7 23423523420 Custom parameters. Fixed key name
custom_params_8 23423523421 Custom  parameters. Fixed key name
custom_params_9 23423523422 Custom  parameters. Fixed key name
custom_params_10 23423523424 Custom  parameters. Fixed key name

2. Data Callback

       SE supports data callbacks to channels for optimizing channel advertising models and algorithms, helping advertisers improve ad performance and ROI. The following list contains the parameters and explanations for SE-supported callbacks.

       Data callbacks from SE are primarily divided into: install & event callbacks, ad revenue callbacks, and anti-fraud installation callbacks. Different types of callbacks support the following callback parameters mainly:

Install & Event Callback

Parameter NameExample Description
attribution_touch_type Click/Impression Attribution type
attribution_method Device ID, Fingerprint, Meta_referrer Attribution model:
Device ID is to use the device ID for attribution. Fingerprint is to use IP and user agent for attribution. Meta_referrer is to use the referrer method for attribution.
attribution_lbw 604800 Attribution window
attribution_ttit 80940 Touchpoint to install time
ry_touchpoint_ts 1671161460000 Touchpoint time
install_time 1671242400000 App activation time
attribution_time 2022-12-28 16:11:08 Attribution time
turl_campaign_id 12314125 Ad plan id
turl_campaign_name Big Makeover_And Ad plan name
turl_id 123124151 Short chain id
channel_id 514 Channel id
channel_name Kuai Attributed channel name
attribution_type UA UA
event_name install, startup, register, login, order, purchase If the event name is connected to other events, it must be developed separately.
order_amount 30 Event revenue
currency_type CNY Event currency
account_id 123124125 Ad account ID
adgroup_id 123141251 Ad group ID
adgroup_name kup_and_tier_6 Ad group name
adplan_id 312312455 Ad plan ID
adplan_name kup_and_tier Ad plan name
adcreative_id 13125125 Ad creative ID
adcreative_name kup_and_tier_ad Ad creative name
adcreative_type Big picture Ad creative type
site_id 13125125123 Sub-channel ID
site_name Kuai Sub-channel name
ad_type  Banner Ad types
placement_id 1312125125 Ad placement ID
conversion_id 12312314115 Advertising slot id
click_id 1312312412515152 Conversion ID
impression_id 2131231241241415 Ad click ID
request_id 1231231241241251 Ad request id
callback_id 1312312155343434 Callback ID
custom_params_1 - Custom parameters 1-10
custom_params_2 - Custom parameters 1-10
custom_params_3 - Custom parameters 1-10
custom_params_4 - Custom parameters 1-10
custom_params_5 - Custom parameters 1-10
custom_params_6 - Custom parameters 1-10
custom_params_7 - Custom parameters 1-10
custom_params_8 - Custom parameters 1-10
custom_params_9 - Custom parameters 1-10
custom_params_10 - Custom parameters 1-10
callback_data_source 1: The current channel
2: Other channels		 Mark callback data source
turl_string account_id=__ACCOUNTID__&adgroup_id=__DID__&adplan_id=__AID__&adgroup_name=__DNAME__&adcreative_id=__CID__&site_id=__CSITE__&callback_url=__CALLBACK__&os=__OS__&model=__MODEL__&ipv4=__IP__&ua=__UA__&ts=__TS__&dfa_md5=__IDFA2__&oaid_md 5=__OAID2__i&is_s2s=1&attribution_type=ua&touchpoint_type=click Original ad impression & click links
gaid 9C3FA051-DB2A-4F4F-9154-BC15EF565760 -
gaid_md5 8e488a40a17aed2f6752f51382a4eafc -
imei1 8342732131333 -
imei1_md5 8342732742123 -
imei2 8342732123412 -
imei2_md5 8342732312314 -
oaid 3DEA635F-B24F-434B-833F-4ED028FEAEEF -
oaid_md5 8e488a40a17aed2f6752f51382a4eafc -
mac 23456787898767898 -
mac_md5 2345678789876741 -
android_id 1a34fc556a43c453 -
android_id_md5 8e488a40a17aed2f6752f51382a4eafc -
ipv4 1.1.1.1 -
ipv6 2409%3A8a55%3A4cc0%3A4050%3A2507%3A4922%3Abbe0%3A524b -
ua Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
AppleWebKit/537.36 (KHTML, like Gecko)
Chrome/95.0.4638.54
Safari/537.36		 -
manufacturer HUAWEI Device brand
model Mate 40 Device model
os 1 Device platform
os_version 14.1 Device system version

Ad Revenue Callback

Parameter NameExampleDescription
attribution_touch_typeClick/ImpressionAttribution type
attribution_methodDevice ID, Fingerprint, Meta_referrerAttribution model:
Device ID is to use the device ID for attribution. Fingerprint is to use IP and user agent for attribution. Meta_referrer is to use the referrer method for attribution.
attribution_lbw604800Attribution window
attribution_ttit80940Touchpoint to install time
ry_touchpoint_ts1671161460000Touchpoint time
install_time1671242400000App activation time
attribution_time2022-12-28 16:11:08Attribution time
turl_campaign_id12314125Ad plan id
turl_campaign_nameBig Makeover_AndAd plan name
turl_id123124151Short chain id
channel_id514Channel id
channel_nameKuaiAttributed channel name
attribution_typeUAUA
event_nameinstall, startup, register, login, order, purchaseIf the event name is connected to other events, it must be developed separately.
order_amount30Event revenue
currency_typeCNYEvent currency
account_id123124125Ad account ID
adgroup_id123141251Ad group ID
adgroup_namekup_and_tier_6Ad group name
adplan_id312312455Ad plan ID
adplan_namekup_and_tierAd plan name
adcreative_id13125125Ad creative ID
adcreative_namekup_and_tier_adAd creative name
adcreative_typeBig pictureAd creative type
site_id13125125123Sub-channel ID
site_nameKuaiSub-channel name
ad_type BannerAd types
placement_id1312125125Ad placement ID
conversion_id12312314115Advertising slot id
click_id1312312412515152Conversion ID
impression_id2131231241241415Ad click ID
request_id1231231241241251Ad request id
callback_id1312312155343434Callback ID
custom_params_1-Custom parameters 1-10
custom_params_2-Custom parameters 1-10
custom_params_3-Custom parameters 1-10
custom_params_4-Custom parameters 1-10
custom_params_5-Custom parameters 1-10
custom_params_6-Custom parameters 1-10
custom_params_7-Custom parameters 1-10
custom_params_8-Custom parameters 1-10
custom_params_9-Custom parameters 1-10
custom_params_10-Custom parameters 1-10
callback_data_source1: The current channel
2: Other channels		Mark callback data source
turl_stringaccount_id=__ACCOUNTID__&adgroup_id=__DID__&adplan_id=__AID__&adgroup_name=__DNAME__&adcreative_id=__CID__&site_id=__CSITE__&callback_url=__CALLBACK__&os=__OS__&model=__MODEL__&ipv4=__IP__&ua=__UA__&ts=__TS__&dfa_md5=__IDFA2__&oaid_md 5=__OAID2__i&is_s2s=1&attribution_type=ua&touchpoint_type=clickOriginal ad impression & click links
gaid9C3FA051-DB2A-4F4F-9154-BC15EF565760-
gaid_md58e488a40a17aed2f6752f51382a4eafc-
imei18342732131333-
imei1_md58342732742123-
imei28342732123412-
imei2_md58342732312314-
oaid3DEA635F-B24F-434B-833F-4ED028FEAEEF-
oaid_md58e488a40a17aed2f6752f51382a4eafc-
mac23456787898767898-
mac_md52345678789876741-
android_id1a34fc556a43c453-
android_id_md58e488a40a17aed2f6752f51382a4eafc-
ipv41.1.1.1-
ipv62409%3A8a55%3A4cc0%3A4050%3A2507%3A4922%3Abbe0%3A524b-
uaMozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
AppleWebKit/537.36 (KHTML, like Gecko)
Chrome/95.0.4638.54
Safari/537.36		-
manufacturerHUAWEIDevice brand
modelMate 40Device model
os1Device platform
os_version14.1Device system version

Anti-Fraud Install Callback

Parameter NameExampleDescription
attribution_touch_typeClick/ImpressionAttribution type
attribution_methodDevice ID, Fingerprint, Meta_referrerAttribution model:
Device ID is to use the device ID for attribution. Fingerprint is to use IP and user agent for attribution. Meta_referrer is to use the referrer method for attribution.
attribution_lbw604800Attribution window
attribution_ttit80940Touchpoint to install time
ry_touchpoint_ts1671161460000Touchpoint time
install_time1671242400000App activation time
attribution_time2022-12-28 16:11:08Attribution time
turl_campaign_id12314125Ad plan id
turl_campaign_nameBig Makeover_AndAd plan name
turl_id123124151Short chain id
channel_id514Channel id
channel_nameKuaiAttributed channel name
attribution_typeUAUA
event_nameinstall, startup, register, login, order, purchaseIf the event name is connected to other events, it must be developed separately.
order_amount30Event revenue
currency_typeCNYEvent currency
account_id123124125Ad account ID
adgroup_id123141251Ad group ID
adgroup_namekup_and_tier_6Ad group name
adplan_id312312455Ad plan ID
adplan_namekup_and_tierAd plan name
adcreative_id13125125Ad creative ID
adcreative_namekup_and_tier_adAd creative name
adcreative_typeBig pictureAd creative type
site_id13125125123Sub-channel ID
site_nameKuaiSub-channel name
ad_type BannerAd types
placement_id1312125125Ad placement ID
conversion_id12312314115Advertising slot id
click_id1312312412515152Conversion ID
impression_id2131231241241415Ad click ID
request_id1231231241241251Ad request id
callback_id1312312155343434Callback ID
custom_params_1-Custom parameters 1-10
custom_params_2-Custom parameters 1-10
custom_params_3-Custom parameters 1-10
custom_params_4-Custom parameters 1-10
custom_params_5-Custom parameters 1-10
custom_params_6-Custom parameters 1-10
custom_params_7-Custom parameters 1-10
custom_params_8-Custom parameters 1-10
custom_params_9-Custom parameters 1-10
custom_params_10-Custom parameters 1-10
callback_data_source1: The current channel
2: Other channels		Mark callback data source
turl_stringaccount_id=__ACCOUNTID__&adgroup_id=__DID__&adplan_id=__AID__&adgroup_name=__DNAME__&adcreative_id=__CID__&site_id=__CSITE__&callback_url=__CALLBACK__&os=__OS__&model=__MODEL__&ipv4=__IP__&ua=__UA__&ts=__TS__&dfa_md5=__IDFA2__&oaid_md 5=__OAID2__i&is_s2s=1&attribution_type=ua&touchpoint_type=clickOriginal ad impression & click links
gaid9C3FA051-DB2A-4F4F-9154-BC15EF565760-
gaid_md58e488a40a17aed2f6752f51382a4eafc-
imei18342732131333-
imei1_md58342732742123-
imei28342732123412-
imei2_md58342732312314-
oaid3DEA635F-B24F-434B-833F-4ED028FEAEEF-
oaid_md58e488a40a17aed2f6752f51382a4eafc-
mac23456787898767898-
mac_md52345678789876741-
android_id1a34fc556a43c453-
android_id_md58e488a40a17aed2f6752f51382a4eafc-
ipv41.1.1.1-
ipv62409%3A8a55%3A4cc0%3A4050%3A2507%3A4922%3Abbe0%3A524b-
uaMozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
AppleWebKit/537.36 (KHTML, like Gecko)
Chrome/95.0.4638.54
Safari/537.36		-
manufacturerHUAWEIDevice brand
modelMate 40Device model
os1Device platform
os_version14.1Device system version
Rejected_installYesYes/No (Default yes)
Rejected_reasonThe reason for blocking the abnormal install


Previous
Migrate Historical Data
Next
SKAN Data Reporting
Last modified: 2024-03-15Powered by