Advertiser Callback

OpenAD will notify advertisers for live ad publishing, and upgrade user tags based on callback from advertiser application calls.

This will be used to enhance the governance consensus within OpenAD Network.

This document describes how advertisers use the callback API to notify and return data to OpenAD Protocol.

---

API Callback URL

https://bf2055756e.api.openad.network/v3/api/callback

Callback Method

GET

---

#For Telegram Mini App TMA, Advertiser how to get callback parameters

If your promotion link is like https://t.me/openadprotocolbot/tma?startapp=OpenAD_Protocol, the callback parameters will be spliced after your promotion link.

If your promotion link is like https://t.me/openadprotocolbot/tma, then your promotion link will be spliced with ?startapp=OpenAD_Protocol and callback parameters.

Your TMA launch page will get the following URL

https://openad.network/?tgWebAppStartParam=OpenAD_Protocol
_26zoneId_3D159
_26publisherId_3D49
_26eventId_3D158
_26traceId_3D10511960c290a145c3fb555c8dddcbf48f96cc
_26cb_3D1b2a1fced9f036b8881a0ffda17920d2
_26hash_3D29ebc1be403b57aba2d2689410e15b01
_26signature_3Db2c2525ef5f8c71378af2fd587b3cdd0
_26userId_3D6087580917
#tgWebAppData=......

After processing, will get the following parameters data

_26zoneId_3D159
_26publisherId_3D49
_26eventId_3D158
_26traceId_3D10511960c290a145c3fb555c8dddcbf48f96cc
_26cb_3D1b2a1fced9f036b8881a0ffda17920d2
_26hash_3D29ebc1be403b57aba2d2689410e15b01
_26signature_3Db2c2525ef5f8c71378af2fd587b3cdd0
_26userId_3D6087580917

parameters = decodeURIComponent(parameters.replace(/_/g, '%')), will get the following parameters data

&zoneId=159
&publisherId=49
&eventId=158
&traceId=10511960c290a145c3fb555c8dddcbf48f96cc
&cb=1b2a1fced9f036b8881a0ffda17920d2
&hash=29ebc1be403b57aba2d2689410e15b01
&signature=b2c2525ef5f8c71378af2fd587b3cdd0
&userId=6087580917

---

#For webApp, Advertiser how to get callback parameters

If your promotion link is like https://openad.network/?startapp=OpenAD_Protocol, the callback parameters will be spliced after your promotion link.

If your promotion link is like https://openad.network/, then your promotion link will be spliced with ?startapp=OpenAD_Protocol and callback parameters.

Your webApp launch page will get the following URL

https://openad.network/
?startapp=OpenAD_Protocol
&zoneId=159
&publisherId=49
&eventId=158
&traceId=10511960c290a145c3fb555c8dddcbf48f96cc
&cb=1b2a1fced9f036b8881a0ffda17920d2
&hash=29ebc1be403b57aba2d2689410e15b01
&signature=b2c2525ef5f8c71378af2fd587b3cdd0
&userId=6087580917

---

#Send a GET request to OpenAD Protocol, the URL is as follows

https://bf2055756e.api.openad.network/v3/api/callback
?zoneId=159
&publisherId=49
&eventId=158
&traceId=10511960c290a145c3fb555c8dddcbf48f96cc
&cb=1b2a1fced9f036b8881a0ffda17920d2
&hash=29ebc1be403b57aba2d2689410e15b01
&signature=b2c2525ef5f8c71378af2fd587b3cdd0
&userId=6087580917

---