Difference between revisions of "OpenRTB/Feed Integration SSP"
(→Feed Bid Response) |
(→OpenRTB Bid Response) |
||
(12 intermediate revisions by the same user not shown) | |||
Line 9: | Line 9: | ||
* [https://wiki.kadam.net/en/index.php?title=RTB_setting#OpenRTB_Integration OpenRTB Integration] | * [https://wiki.kadam.net/en/index.php?title=RTB_setting#OpenRTB_Integration OpenRTB Integration] | ||
+ | |||
+ | * [https://wiki.kadam.net/en/index.php?title=OpenRTB/Feed_Integration_SSP#XML_Integration XML Integration] | ||
Line 22: | Line 24: | ||
* [https://wiki.kadam.net/en/index.php?title=RTB_setting#OpenRTB_Bid_Response OpenRTB Bid Response] | * [https://wiki.kadam.net/en/index.php?title=RTB_setting#OpenRTB_Bid_Response OpenRTB Bid Response] | ||
+ | |||
+ | * [https://wiki.kadam.net/en/index.php?title=OpenRTB/Feed_Integration_SSP#XML_Bid_Request XML Bid Request] | ||
+ | |||
+ | * [https://wiki.kadam.net/en/index.php?title=OpenRTB/Feed_Integration_SSP#XML_Bid_Response XML Bid Response] | ||
Line 39: | Line 45: | ||
'''Key points''' | '''Key points''' | ||
− | * Kadam supports Feed, [https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf OpenRTB 2.5], [https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-Native-Ads-Specification-1-1_2016.pdf Native 1.1], [https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf Native 1.2] protocols; | + | * Kadam supports Feed, [https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf OpenRTB 2.5], [https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-Native-Ads-Specification-1-1_2016.pdf Native 1.1], [https://www.iab.com/wp-content/uploads/2018/03/OpenRTB-Native-Ads-Specification-Final-1.2.pdf Native 1.2], XML protocols; |
* In order to connect a new SSP, you must make sure that you support the transmission of the necessary parameters and are ready to send requests and receive responses from us; | * In order to connect a new SSP, you must make sure that you support the transmission of the necessary parameters and are ready to send requests and receive responses from us; | ||
Line 137: | Line 143: | ||
| | | | ||
|- | |- | ||
− | |subage / subage_dt / subage0 / subage_ts | + | |subage / subage_dt / subage0 / subage_ts / subage_ts_ms |
|User subscription age | |User subscription age | ||
− | |If the "subage" parameter is not filled in, filled in incorrectly, or not passed, it is considered "undefined", this reduces the buyout. For the first day of subscription expected: subage=1, subage0=0, subage_dt - actual date of subscription, subage_ts - actual date of subscription (unixtime) | + | |If the "subage" parameter is not filled in, filled in incorrectly, or not passed, it is considered "undefined", this reduces the buyout. For the first day of subscription expected: subage=1, subage0=0, subage_dt - actual date of subscription, subage_ts - actual date of subscription (seconds in unixtime), subage_ts_ms - actual date of subscription (milliseconds in unixtime) |
− | |Yes | + | |Yes (for Push) |
|- | |- | ||
|pid | |pid | ||
Line 323: | Line 329: | ||
| | | | ||
|- | |- | ||
− | |crid(adid) | + | |crid (adid) |
|Creativity ID | |Creativity ID | ||
| | | | ||
Line 371: | Line 377: | ||
|Link to material image | |Link to material image | ||
| | | | ||
− | | | + | |yes |
|- | |- | ||
|icon_url | |icon_url | ||
Line 429: | Line 435: | ||
:{ | :{ | ||
::"id": "5555555", | ::"id": "5555555", | ||
+ | ::"impid": "5", | ||
+ | ::"crid": "555555", | ||
::"click_url": <nowiki>"https://example.com/h/np7hsxgf7znhtwwp372gm4eqzxbippulrjkgossribafyeqhafvgf56srptfmebrzi4563e2k6z442paphs5yoxrncznnt6l4hg7xjrf6bedf2sxw5uyculsxrj4drfsqkv3bne6v542iu6byszifk5qwspk66oukd23j24wkxpusyhqpjgpqoslhnt6mtkv3fjhtgkqhbeys4vgjvpzsutj3ri7prci6jk7dluasj7ymuj3jvvdhdsm5236vgsqwi56a262kvhmwzpr4wknkpwznuzuimkd62z5yvsczc2xiksxn5kscujilyfdeknrha7ddy3ar7lfhyrzwxwdvpsosthvpasvofnsohyggqvxquzsjjwgeajll5idilbnauyrwzrxlmwfcc3gozzve2i6mpjdushbgda2z33d5v5i7efiocwdavzkhrpjq6udllwuxmxqyz3k4y5judmw7sclxp727i7k4l2jr4cteiowgftdpvzvqy2ogeybkkqkbizge72wneoxs2s3pfnr6zl5picdgtjsmygxaucui2jkp37qr725biwqnannnymi6rntuuobhos6idagtcc2rm32btjlvzj3klxlt7fdv2d2xlohjbftmxrrpmpxq6te6osyt3runrjugyciu75fkgfv5q5g6t2lmfihqvc67aekvr36cpckgury?u=https%3A%2F%2Fexample.com%2Fgo%2F78602c30-54b0-4db5-bd07-3b2e3a804955%3Fcost%3D3.5%26clickid%3Dcnv4bd32b2809b6bbcfdac2ece8909839f7%26campaign_id%3D555120%26creative_id%3D4796823%26site_id%3D1375589855029800%26category_id%3D126%26country%3DRU%55browser%3DCHROME%26language%3Dru%26platform%3DANDROID%26subage%3D7%26feed%3D550279"</nowiki>, | ::"click_url": <nowiki>"https://example.com/h/np7hsxgf7znhtwwp372gm4eqzxbippulrjkgossribafyeqhafvgf56srptfmebrzi4563e2k6z442paphs5yoxrncznnt6l4hg7xjrf6bedf2sxw5uyculsxrj4drfsqkv3bne6v542iu6byszifk5qwspk66oukd23j24wkxpusyhqpjgpqoslhnt6mtkv3fjhtgkqhbeys4vgjvpzsutj3ri7prci6jk7dluasj7ymuj3jvvdhdsm5236vgsqwi56a262kvhmwzpr4wknkpwznuzuimkd62z5yvsczc2xiksxn5kscujilyfdeknrha7ddy3ar7lfhyrzwxwdvpsosthvpasvofnsohyggqvxquzsjjwgeajll5idilbnauyrwzrxlmwfcc3gozzve2i6mpjdushbgda2z33d5v5i7efiocwdavzkhrpjq6udllwuxmxqyz3k4y5judmw7sclxp727i7k4l2jr4cteiowgftdpvzvqy2ogeybkkqkbizge72wneoxs2s3pfnr6zl5picdgtjsmygxaucui2jkp37qr725biwqnannnymi6rntuuobhos6idagtcc2rm32btjlvzj3klxlt7fdv2d2xlohjbftmxrrpmpxq6te6osyt3runrjugyciu75fkgfv5q5g6t2lmfihqvc67aekvr36cpckgury?u=https%3A%2F%2Fexample.com%2Fgo%2F78602c30-54b0-4db5-bd07-3b2e3a804955%3Fcost%3D3.5%26clickid%3Dcnv4bd32b2809b6bbcfdac2ece8909839f7%26campaign_id%3D555120%26creative_id%3D4796823%26site_id%3D1375589855029800%26category_id%3D126%26country%3DRU%55browser%3DCHROME%26language%3Dru%26platform%3DANDROID%26subage%3D7%26feed%3D550279"</nowiki>, | ||
::"campaign_id": 555555, | ::"campaign_id": 555555, | ||
Line 447: | Line 455: | ||
:{ | :{ | ||
::"id": "5555555", | ::"id": "5555555", | ||
+ | ::"impid": "5", | ||
+ | ::"crid": "555555", | ||
::"click_url": <nowiki>"https://example.com/h/np7hsxgf7znhtwwp372gm4eqzxbippulrjkgossribafyeqhafvgf56srptfmebrzi4563e2k6z442paphs5yoxrncznnt6l4hg7xjrf6bedf2sxw5uyculsxrj4drfsqkv3bne6v542iu6byszifk5qwspk66oukd23j24wkxpusyhqpjgpqoslhnt6mtkv3fjhtgkqhbeys4vgjvpzsutj3ri7prci6jk7dluasj7ymuj3jvvdhdsm5236vgsqwi56a262kvhmwzpr4wknkpwznuzuimkd62z5yvsczc2xiksxn5kscujilyfdeknrha7ddy3ar7lfhyrzwxwdvpsosthvpasvofnsohyggqvxquzsjjwgeajll5idilbnauyrwzrxlmwfcc3gozzve2i6mpjdushbgda2z33d5v5i7efiocwdavzkhrpjq6udllwuxmxqyz3k4y5judmw7sclxp727i7k4l2jr4cteiowgftdpvzvqy2ogeybkkqkbizge72wneoxs2s3pfnr6zl5picdgtjsmygxaucui2jkp37qr725biwqnannnymi6rntuuobhos6idagtcc2rm32btjlvzj3klxlt7fdv2d2xlohjbftmxrrpmpxq6te6osyt3runrjugyciu75fkgfv5q5g6t2lmfihqvc67aekvr36cpckgury?u=https%3A%2F%2Fexample.com%2Fgo%2F78602c30-54b0-4db5-bd07-3b2e3a804955%3Fcost%3D3.5%26clickid%3Dcnv4bd32b2809b6bbcfdac2ece8909839f7%26campaign_id%3D555120%26creative_id%3D4796823%26site_id%3D1375589855029800%26category_id%3D126%26country%3DRU%55browser%3DCHROME%26language%3Dru%26platform%3DANDROID%26subage%3D7%26feed%3D550279"</nowiki>, | ::"click_url": <nowiki>"https://example.com/h/np7hsxgf7znhtwwp372gm4eqzxbippulrjkgossribafyeqhafvgf56srptfmebrzi4563e2k6z442paphs5yoxrncznnt6l4hg7xjrf6bedf2sxw5uyculsxrj4drfsqkv3bne6v542iu6byszifk5qwspk66oukd23j24wkxpusyhqpjgpqoslhnt6mtkv3fjhtgkqhbeys4vgjvpzsutj3ri7prci6jk7dluasj7ymuj3jvvdhdsm5236vgsqwi56a262kvhmwzpr4wknkpwznuzuimkd62z5yvsczc2xiksxn5kscujilyfdeknrha7ddy3ar7lfhyrzwxwdvpsosthvpasvofnsohyggqvxquzsjjwgeajll5idilbnauyrwzrxlmwfcc3gozzve2i6mpjdushbgda2z33d5v5i7efiocwdavzkhrpjq6udllwuxmxqyz3k4y5judmw7sclxp727i7k4l2jr4cteiowgftdpvzvqy2ogeybkkqkbizge72wneoxs2s3pfnr6zl5picdgtjsmygxaucui2jkp37qr725biwqnannnymi6rntuuobhos6idagtcc2rm32btjlvzj3klxlt7fdv2d2xlohjbftmxrrpmpxq6te6osyt3runrjugyciu75fkgfv5q5g6t2lmfihqvc67aekvr36cpckgury?u=https%3A%2F%2Fexample.com%2Fgo%2F78602c30-54b0-4db5-bd07-3b2e3a804955%3Fcost%3D3.5%26clickid%3Dcnv4bd32b2809b6bbcfdac2ece8909839f7%26campaign_id%3D555120%26creative_id%3D4796823%26site_id%3D1375589855029800%26category_id%3D126%26country%3DRU%55browser%3DCHROME%26language%3Dru%26platform%3DANDROID%26subage%3D7%26feed%3D550279"</nowiki>, | ||
::"campaign_id": 555555, | ::"campaign_id": 555555, | ||
Line 1,919: | Line 1,929: | ||
|nurl | |nurl | ||
|Win notice URL called by the exchange if the bid wins | |Win notice URL called by the exchange if the bid wins | ||
− | | | + | |Called when the bid wins |
| | | | ||
|- | |- | ||
Line 1,974: | Line 1,984: | ||
:::::"impid": "555555555", | :::::"impid": "555555555", | ||
:::::"price": 1.9711000061035155, | :::::"price": 1.9711000061035155, | ||
− | :::::" | + | :::::"nurl": <nowiki>"https://example.com/nurl/863/nn2eqnzrlevvuarsmivfimkopfta27s5d5xcu7krpumtkzs2pufqkybnp4agg2stmyaxwxqkmr5vh34bnn2nfo6pyu2gmx3tneakouqkhmuz77eiuhdopvpirbjvbzom5xiuso7bstc22v2aubxlqvyqioy3fvcwjiihq2jsk2h34sm4i4kfg4fanzbfynslmfihqvcszb3osm2xy5fgxqdz5dyt76liqddfb43azzyziu7ivpctbg2oltlicqebknqhbxiorzhkqznvph5bkwlxqezx5msko3t2s3g7hkf2q3dn45ff5ydzk7vdsevbgoxg3g3alkqflreh5o543knqwspfdgcvthzn2fw2k5hlsyctfudrnmkldahvzghicg2uprcqhhrwwmiddqh5cuwlq3g2nnewzwu3asvdkjof2uryjgu4o7udoryfa6cuqi4jpkync7aitfdy3do22byynezfmt2lmgqephcqlwnwwmuojvficuxi6tt7ut4zgbl4ksdjm5fwonqapafaj5smujtpq62e4i5vrujrqx3wdiktxgsxrscktsdotl2m4nkhuucrvbgzenwojnfmcvgu6gg36t6bgzl76t7b2p7prnfj6nvyuux4th7m5bnlvxd3m2a=?1=1&data[]=16268540604187916861458595&v[]=5550347983&cur=${AUCTION_CURRENCY}&bid=${AUCTION_PRICE}"</nowiki>, |
:::::"lurl": <nowiki>"https://example.com/lurl/863/nn2eqnzrlevvuarsmivfimkopfta27s5d5xcu7krpumtkzs2pufqkybnp4agg2stmyaxwxqkmr5vh34bnn2nfo6pyu2gmx3tneakouqkhmuz77eiuhdopvpirbjvbzom5xiuso7bstc22v2aubxlqvyqioy3fvcwjiihq2jsk2h34sm4i4kfg4fanzbfynslmfihqvcszb3osm2xy5fgxqdz5dyt76liqddfb43azzyziu7ivpctbg2oltlicqebknqhbxiorzhkqznvph5bkwlxqezx5msko3t2s3g7hkf2q3dn45ff5ydzk7vdsevbgoxg3g3alkqflreh5o543knqwspfdgcvthzn2fw2k5hlsyctfudrnmkldahvzghicg2uprcqhhrwwmiddqh5cuwlq3g2nnewzwu3asvdkjof2uryjgu4o7udoryfa6cuqi4jpkync7aitfdy3do22byynezfmt2lmgqephcqlwnwwmuojvficuxi6tt7ut4zgbl4ksdjm5fwonqapafaj5smujtpq62e4i5vrujrqx3wdiktxgsxrscktsdotl2m4nkhuucrvbgzenwojnfmcvgu6gg36t6bgzl76t7b2p7prnfj6nvyuux4th7m5bnlvxd3m2a=?1=1&data[]=16268540604187916861458595&v[]=5550347983&cur=${AUCTION_CURRENCY}&bid=${AUCTION_PRICE}&loss=${AUCTION_LOSS}"</nowiki>, | :::::"lurl": <nowiki>"https://example.com/lurl/863/nn2eqnzrlevvuarsmivfimkopfta27s5d5xcu7krpumtkzs2pufqkybnp4agg2stmyaxwxqkmr5vh34bnn2nfo6pyu2gmx3tneakouqkhmuz77eiuhdopvpirbjvbzom5xiuso7bstc22v2aubxlqvyqioy3fvcwjiihq2jsk2h34sm4i4kfg4fanzbfynslmfihqvcszb3osm2xy5fgxqdz5dyt76liqddfb43azzyziu7ivpctbg2oltlicqebknqhbxiorzhkqznvph5bkwlxqezx5msko3t2s3g7hkf2q3dn45ff5ydzk7vdsevbgoxg3g3alkqflreh5o543knqwspfdgcvthzn2fw2k5hlsyctfudrnmkldahvzghicg2uprcqhhrwwmiddqh5cuwlq3g2nnewzwu3asvdkjof2uryjgu4o7udoryfa6cuqi4jpkync7aitfdy3do22byynezfmt2lmgqephcqlwnwwmuojvficuxi6tt7ut4zgbl4ksdjm5fwonqapafaj5smujtpq62e4i5vrujrqx3wdiktxgsxrscktsdotl2m4nkhuucrvbgzenwojnfmcvgu6gg36t6bgzl76t7b2p7prnfj6nvyuux4th7m5bnlvxd3m2a=?1=1&data[]=16268540604187916861458595&v[]=5550347983&cur=${AUCTION_CURRENCY}&bid=${AUCTION_PRICE}&loss=${AUCTION_LOSS}"</nowiki>, | ||
:::::"adomain": [ | :::::"adomain": [ | ||
Line 1,983: | Line 1,993: | ||
::::::"IAB9-7" | ::::::"IAB9-7" | ||
:::::], | :::::], | ||
− | :::::"adm": <nowiki>" | + | :::::"adm":<nowiki>"https://click_url_must_be_here.com"</nowiki> |
::::} | ::::} | ||
:::], | :::], | ||
Line 2,243: | Line 2,253: | ||
:] | :] | ||
} | } | ||
+ | |} | ||
+ | |||
+ | == XML Integration == | ||
+ | |||
+ | '''XML Integration ''' | ||
+ | |||
+ | This documentation explains how advertisers can integrate their platforms with Kadam using the XML. | ||
+ | |||
+ | |||
+ | '''Bid Request/Response''' | ||
+ | |||
+ | * [https://wiki.kadam.net/en/index.php?title=OpenRTB/Feed_Integration_SSP#XML_Bid_Request XML Bid Request] | ||
+ | |||
+ | * [https://wiki.kadam.net/en/index.php?title=OpenRTB/Feed_Integration_SSP#XML_Bid_Response XML Bid Response] | ||
+ | |||
+ | |||
+ | '''Supported ad types:''' | ||
+ | |||
+ | * Native; | ||
+ | |||
+ | * Push; | ||
+ | |||
+ | * On site push (inpage); | ||
+ | |||
+ | * iOS calendar push; | ||
+ | |||
+ | * Clickunder. | ||
+ | |||
+ | == XML Bid Request == | ||
+ | |||
+ | |||
+ | '''XML Bid Request''' | ||
+ | |||
+ | Description of supported parameters | ||
+ | |||
+ | '''These objects should be sent in GET request parameters:''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | |- | ||
+ | | style="width: 10%"|'''Attribute''' | ||
+ | | style="width: 20%"|'''Description''' | ||
+ | | style="width: 50%"|'''Using''' | ||
+ | | style="width: 20%"|'''Always passed''' | ||
+ | |- | ||
+ | |sid | ||
+ | |endpoint ID | ||
+ | |Stream uniqueness in Kadam. Issued by Kadam | ||
+ | |Yes | ||
+ | |- | ||
+ | |skey | ||
+ | |API key | ||
+ | |Issued by Kadam | ||
+ | | | ||
+ | |- | ||
+ | |ua | ||
+ | |user agent | ||
+ | |To identify the user's operating system, device and browser on the Kadam side | ||
+ | |Yes | ||
+ | |- | ||
+ | |ip | ||
+ | |User’s IP address | ||
+ | |To determine the geolocation of a user's device on the Kadam sidem | ||
+ | |Required ip or ipv6 | ||
+ | |- | ||
+ | |uid | ||
+ | |User ID in the SSP | ||
+ | |For user uniqueness | ||
+ | |Yes | ||
+ | |- | ||
+ | |limit | ||
+ | |Limiting the number of creatives in a response | ||
+ | |If there is no limit in the request and on the block, the default=1 | ||
+ | | | ||
+ | |- | ||
+ | |language | ||
+ | |Main browser language, ISO 3166-1 alpha-2 coding | ||
+ | |To define the browser language. Examples: &language=ru-RU or &language=ru. If the parameter "language" is not filled in, filled in incorrectly or not passed, it is considered "undefined", it reduces the buyout | ||
+ | | | ||
+ | |- | ||
+ | |subage / subage_dt / subage0 / subage_ts / subage_ts_ms | ||
+ | |User subscription age | ||
+ | |If the "subage" parameter is not filled in, filled in incorrectly, or not passed, it is considered "undefined", this reduces the buyout. For the first day of subscription expected: subage=1, subage0=0, subage_dt - actual date of subscription, subage_ts - actual date of subscription (seconds in unixtime), subage_ts_ms - actual date of subscription (milliseconds in unixtime) | ||
+ | |Yes (for Push) | ||
+ | |- | ||
+ | |pid | ||
+ | |Publisher ID | ||
+ | |This parameter expects the ID of the publisher (site, webmaster) on the SSP | ||
+ | |Yes | ||
+ | |- | ||
+ | |cat | ||
+ | |IAB-category domain | ||
+ | |IAB24 on meinstream and IAB25-3 on adalt by default | ||
+ | |No | ||
+ | |- | ||
+ | |page | ||
+ | |Page domain | ||
+ | |Expected page domain | ||
+ | |Desirable | ||
+ | |- | ||
+ | |format | ||
+ | |Traffic format | ||
+ | |cu, pops - for clickunder; | ||
+ | native, teaser - for teaser; | ||
+ | |||
+ | push by default | ||
+ | |No | ||
+ | |} | ||
+ | |||
+ | '''Examples of Bid Request''' | ||
+ | |||
+ | '''PUSH''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | |||
+ | |/feed | ||
+ | |||
+ | ?sid=5 | ||
+ | |||
+ | &skey=5azqxvgap5yNsm5X5rg5PMsgDD | ||
+ | |||
+ | &ua=Mozilla%2F5.0+%28Linux%3B+Android+9%3B+SAMSUNG+SM-A105FN%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+SamsungBrowser%2F12.1+Chrome%2F79.0.3945.136+Mobile+Safari%2F537.36 | ||
+ | |||
+ | &ip=127.1.0.0 | ||
+ | |||
+ | &uid=Xef5LfyUte-tzwpV5-fMV | ||
+ | |||
+ | &limit=1 | ||
+ | |||
+ | &language=en | ||
+ | |||
+ | &pid=1 | ||
+ | |||
+ | &subage=2 | ||
+ | |||
+ | &cat=126 | ||
+ | |||
+ | &page=example.com | ||
+ | |||
+ | |} | ||
+ | |||
+ | '''CLICKUNDER''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | |||
+ | |/feed | ||
+ | |||
+ | ?sid=555 | ||
+ | |||
+ | &format=cu | ||
+ | |||
+ | &ua=Mozilla%2F5.0+%28Linux%3B+Android+10%3B+SM-J600F%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F91.0.4472.88+Mobile+Safari%2F537.36 | ||
+ | |||
+ | &ip=127.1.0.0 | ||
+ | |||
+ | &uid=555555555 | ||
+ | |||
+ | &limit=5 | ||
+ | |||
+ | &language=fa-IR | ||
+ | |||
+ | &pid=5555555 | ||
+ | |||
+ | &page=example.com | ||
+ | |} | ||
+ | |||
+ | '''ON SITE PUSH (INPAGE)''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | |||
+ | |/feed | ||
+ | |||
+ | ?sid=5 | ||
+ | |||
+ | &skey=5azqxvgap5yNsm5X5rg5PMsgDD | ||
+ | |||
+ | &ua=Mozilla%2F5.0+%28Linux%3B+Android+9%3B+SAMSUNG+SM-A105FN%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+SamsungBrowser%2F12.1+Chrome%2F79.0.3945.136+Mobile+Safari%2F537.36 | ||
+ | |||
+ | &ip=127.1.0.0 | ||
+ | |||
+ | &uid=Xef5LfyUte-tzwpV5-fMV | ||
+ | |||
+ | &limit=1 | ||
+ | |||
+ | &language=en | ||
+ | |||
+ | &pid=1 | ||
+ | |||
+ | &cat=126 | ||
+ | |||
+ | &page=example.com | ||
+ | |} | ||
+ | |||
+ | '''IOS CALENDAR PUSH''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | |||
+ | |/feed | ||
+ | |||
+ | ?sid=555 | ||
+ | |||
+ | &skey=ca555555f555ec5a5a5ff55cc5b5fb5c | ||
+ | |||
+ | &ua=iOS%2F14.4+%5558D52%29+dataaccessd%2F1.0 | ||
+ | |||
+ | &ip=127.1.0.0 | ||
+ | |||
+ | &uid=0.00695555.5515680055292 | ||
+ | |||
+ | &language=en | ||
+ | |||
+ | &subage_dt=2021-07-10 | ||
+ | |||
+ | &pid=5555555555 | ||
+ | |||
+ | &limit=1 | ||
+ | |} | ||
+ | |||
+ | '''NATIVE''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | |||
+ | |/feed | ||
+ | |||
+ | ?sid=555 | ||
+ | |||
+ | &skey=b5cb555d5efcd555ade5555a5eaa5f55 | ||
+ | |||
+ | &ua=Mozilla%2F5.0+%28Linux%3B+Android+11%3B+SM-T500%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F91.0.4472.120+Safari%2F537.36 | ||
+ | |||
+ | &ip=127.1.0.0 | ||
+ | |||
+ | &uid=5b5aa555-bd55-555b-a5d5-55f55f5c55df | ||
+ | |||
+ | &language=de | ||
+ | |||
+ | &pid=55 | ||
+ | |||
+ | &page=example.com | ||
+ | |||
+ | &format=native | ||
+ | |} | ||
+ | |||
+ | == XML Bid Response == | ||
+ | |||
+ | '''XML Bid Response''' | ||
+ | |||
+ | Description of supported parameters (the Bid Response format can be changed to suit your requirements, please contact our manager) | ||
+ | |||
+ | '''result.listing''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | |- | ||
+ | | style="width: 10%"|'''Attribute''' | ||
+ | | style="width: 20%"|'''Description''' | ||
+ | | style="width: 50%"|'''Using''' | ||
+ | | style="width: 20%"|'''Always passed''' | ||
+ | |- | ||
+ | |url | ||
+ | |Ad link | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |bid | ||
+ | |Bid | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |pixel | ||
+ | |Nurl | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |image | ||
+ | |Image link | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |title | ||
+ | |Ad title | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |descr | ||
+ | |Header ad | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |site | ||
+ | |Site link | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |icon | ||
+ | |Icon link | ||
+ | | | ||
+ | | | ||
+ | |} | ||
+ | |||
+ | '''Examples of Bid Response:''' | ||
+ | |||
+ | '''PUSH''' | ||
+ | |||
+ | '''1. Icon contains nurl and icon, separate request pixel (nurl) is not required''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | | | ||
+ | <result> | ||
+ | ::<listing | ||
+ | ::::title="Looking for test?" | ||
+ | ::::url=<nowiki>"http://example.com/click"</nowiki> | ||
+ | ::::descr="Find test here!" | ||
+ | ::::bid="0.003" | ||
+ | ::::image=<nowiki>"http://example.com/5454.png"</nowiki> | ||
+ | ::::icon=<nowiki>"http://example.com/32434.png"</nowiki> | ||
+ | ::/> | ||
+ | <result> | ||
+ | |} | ||
+ | |||
+ | |||
+ | '''2. With “pixel”''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | | | ||
+ | <result> | ||
+ | ::<listing | ||
+ | ::::title="Looking for test?" | ||
+ | ::::url=<nowiki>"http://example.com/click"</nowiki> | ||
+ | ::::descr="Find test here!" | ||
+ | ::::bid="0.003" | ||
+ | ::::pixel=<nowiki>"http://example.com/nurl"</nowiki> | ||
+ | ::::image=<nowiki>"http://example.com/5454.png"</nowiki> | ||
+ | ::/> | ||
+ | <result> | ||
+ | |} | ||
+ | |||
+ | '''CLICKUNDER''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | | | ||
+ | <result> | ||
+ | ::<listing | ||
+ | ::::url=<nowiki>"http://example.com/click"</nowiki> | ||
+ | ::::bid="0.003" | ||
+ | ::/> | ||
+ | <result> | ||
+ | |} | ||
+ | |||
+ | '''ON SITE PUSH (INPAGE)''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | | | ||
+ | <result> | ||
+ | ::<listing | ||
+ | ::::title="Looking for test?" | ||
+ | ::::url=<nowiki>"http://example.com/click"</nowiki> | ||
+ | ::::descr="Find test here!" | ||
+ | ::::bid="0.003" | ||
+ | ::::pixel=<nowiki>"http://example.com/nurl"</nowiki> | ||
+ | ::::image=<nowiki>"http://example.com/5454.png"</nowiki> | ||
+ | ::::icon=<nowiki>"http://example.com/32434.png"</nowiki> | ||
+ | ::/> | ||
+ | <result> | ||
+ | |} | ||
+ | |||
+ | '''IOS CALENDAR PUSH''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | | | ||
+ | <result> | ||
+ | ::<listing | ||
+ | ::::title="Looking for test?" | ||
+ | ::::url=<nowiki>"http://example.com/click"</nowiki> | ||
+ | ::::descr="Find test here!" | ||
+ | ::::bid="0.003" | ||
+ | ::::pixel=<nowiki>"http://example.com/nurl"</nowiki> | ||
+ | ::::image=<nowiki>"http://example.com/5454.png"</nowiki> | ||
+ | ::::icon=<nowiki>"http://example.com/32434.png"</nowiki> | ||
+ | ::/> | ||
+ | <result> | ||
+ | |} | ||
+ | |||
+ | '''NATIVE''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | | | ||
+ | <result> | ||
+ | ::<listing | ||
+ | ::::title="Looking for test?" | ||
+ | ::::image=<nowiki>"http://example.com/5454.png"</nowiki> | ||
+ | ::::site=<nowiki>"http://example.com/click"</nowiki> | ||
+ | ::::url=<nowiki>"http://example.com/click"</nowiki> | ||
+ | ::::bid="0.003" | ||
+ | ::::pixel=<nowiki>"http://example.com/nurl"</nowiki> | ||
+ | ::/> | ||
+ | <result> | ||
|} | |} |
Latest revision as of 13:09, 19 October 2023
Contents
Overview
Integration
Find out about integration with Feed and OpenRTB here:
Bid Request/Response
Bid Request/Response Specifications and Examples are here:
Integration process
1. Documentation review.
2. The SSP registers a webmaster account in the Kadam system. Kadam.
3. Kadam creates and outputs an endpoint/feed for the appropriate ad format and integration type (for each one separately).
4. Tests are conducted to make sure that the integration works and that there is a discrepancy between the Kadam system and SSP. Tests are conducted on “live” ad.
5. If the discrepancies between the system data are within normal limits and there are no technical problems, the integration starts in full working mode.
Key points
- Kadam supports Feed, OpenRTB 2.5, Native 1.1, Native 1.2, XML protocols;
- In order to connect a new SSP, you must make sure that you support the transmission of the necessary parameters and are ready to send requests and receive responses from us;
- Clicks without nurl aren't counted and go to traffic back;
- The document specifies the parameters supported by Kadam, if any parameters are not described, it means that their support is not realized.
Cookie Matching
What Cookie Matching is for:
- avoids showing ads to the user repeatedly;
- can be used in predicting their interests;
- retargeting.
With Cookie Matching, you can match the user ID (according to your version) that viewed your website with the corresponding user ID according to Kadam's version.
Read more about the possible integration options here. To set up Cookie Matching, contact your Kadam manager.
Feed Integration
Feed Integration
This documentation explains how advertisers can integrate their platforms with Kadam using the Feed standard.
Bid Request/Response
Supported ad types:
- Native;
- Push;
- On site push (inpage);
- iOS calendar push;
- Clickunder.
Feed Bid Request
Feed Bid Request
Description of supported parameters
These objects should be sent in GET request parameters:
Attribute | Description | Using | Always passed |
sid | endpoint ID | Stream uniqueness in Kadam. Issued by Kadam | Yes |
skey | API key | Issued by Kadam | |
ua | user agent | To identify the user's operating system, device and browser on the Kadam side | Yes |
ip | User’s IP address | To determine the geolocation of a user's device on the Kadam sidem | Required ip or ipv6 |
uid | User ID in the SSP | For user uniqueness | Yes |
limit | Limiting the number of creatives in a response | If there is no limit in the request and on the block, the default=1 | |
language | Main browser language, ISO 3166-1 alpha-2 coding | To define the browser language. Examples: &language=ru-RU or &language=ru. If the parameter "language" is not filled in, filled in incorrectly or not passed, it is considered "undefined", it reduces the buyout | |
subage / subage_dt / subage0 / subage_ts / subage_ts_ms | User subscription age | If the "subage" parameter is not filled in, filled in incorrectly, or not passed, it is considered "undefined", this reduces the buyout. For the first day of subscription expected: subage=1, subage0=0, subage_dt - actual date of subscription, subage_ts - actual date of subscription (seconds in unixtime), subage_ts_ms - actual date of subscription (milliseconds in unixtime) | Yes (for Push) |
pid | Publisher ID | This parameter expects the ID of the publisher (site, webmaster) on the SSP | Yes |
cat | IAB-category domain | IAB24 on meinstream and IAB25-3 on adalt by default | No |
page | Page domain | Expected page domain | Desirable |
format | Traffic format | cu, pops - for clickunder;
native, teaser - for teaser; push by default |
No |
Examples of Bid Request
PUSH
/feed
?sid=5 &skey=5azqxvgap5yNsm5X5rg5PMsgDD &ua=Mozilla%2F5.0+%28Linux%3B+Android+9%3B+SAMSUNG+SM-A105FN%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+SamsungBrowser%2F12.1+Chrome%2F79.0.3945.136+Mobile+Safari%2F537.36 &ip=127.1.0.0 &uid=Xef5LfyUte-tzwpV5-fMV &limit=1 &language=en &pid=1 &subage=2 &cat=126 &page=example.com |
CLICKUNDER
/feed
?sid=555 &format=cu &ua=Mozilla%2F5.0+%28Linux%3B+Android+10%3B+SM-J600F%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F91.0.4472.88+Mobile+Safari%2F537.36 &ip=127.1.0.0 &uid=555555555 &limit=5 &language=fa-IR &pid=5555555 &page=example.com |
ON SITE PUSH (INPAGE)
/feed
?sid=5 &skey=5azqxvgap5yNsm5X5rg5PMsgDD &ua=Mozilla%2F5.0+%28Linux%3B+Android+9%3B+SAMSUNG+SM-A105FN%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+SamsungBrowser%2F12.1+Chrome%2F79.0.3945.136+Mobile+Safari%2F537.36 &ip=127.1.0.0 &uid=Xef5LfyUte-tzwpV5-fMV &limit=1 &language=en &pid=1 &cat=126 &page=example.com |
IOS CALENDAR PUSH
/feed
?sid=555 &skey=ca555555f555ec5a5a5ff55cc5b5fb5c &ua=iOS%2F14.4+%5558D52%29+dataaccessd%2F1.0 &ip=127.1.0.0 &uid=0.00695555.5515680055292 &language=en &subage_dt=2021-07-10 &pid=5555555555 &limit=1 |
NATIVE
/feed
?sid=555 &skey=b5cb555d5efcd555ade5555a5eaa5f55 &ua=Mozilla%2F5.0+%28Linux%3B+Android+11%3B+SM-T500%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F91.0.4472.120+Safari%2F537.36 &ip=127.1.0.0 &uid=5b5aa555-bd55-555b-a5d5-55f55f5c55df &language=de &pid=55 &page=example.com &format=native |
Feed Bid Response
Feed Bid Response
Description of supported parameters (to change the naming of parameters in Bid Response please contact our manager)
Attribute | Description | Using | Always passed |
id | Material ID | ||
impid | Impression ID | ||
crid (adid) | Creativity ID | yes | |
nurl | URL notification of win | It is possible to send:
Переключение режима ответа происходит через менеджера. |
|
link (click_url) | Clickable link | yes | |
campaing_id (cid) | Campaign ID | ||
category | Material category (section) ID | ||
title | Ad title | yes | |
description (desc) | Header ad | ||
text | Ad text | ||
image_url | Link to material image | yes | |
icon_url | Icon link + nurl | Used in push notifications | |
cpc (price, bid) | Bid price | yes | |
image | Link to image + nurl | ||
result | Bid objects | Used in clickunder | |
listing | Array of bid objects |
result.listing
Attribute | Description | Using | Alwayas passed |
url | Clickable link | ||
bid | Bid |
Examples of Bid Response:
PUSH
1 icon_url contains nurl and icon_url
[
] |
2 with “nurl”
[
] |
CLICKUNDER
{
} |
ON SITE PUSH (INPAGE)
[
] |
IOS CALENDAR PUSH
1
[
] |
2
[
] |
NATIVE
[
] |
OpenRTB Integration
OpenRTB Integration
This documentation explains how advertisers can integrate their platforms with Kadam using the OpenRTB standard.
Bid Request/Response
Supported ad types:
- Native;
- Native (teaser);
- Banner;
- Push;
- On site push (inpage);
- iOS calendar push;
- Clickunder;
- Video.
OpenRTB Bid Request
OpenRTB Bid Request
Description of supported parameters
These objects should be sent using JSON in the Request Body:
Attribute | Description | Using | Always passed |
id | Unique ID of the bid request, provided by the exchange | Yes | |
at | Auction type. For SSPs that work by CPC, there is always an auction of the first price | For the first price auction at=1.
Default 2 - Second Price |
No |
cur | Auction currency. Valid values:
RUB - Russian ruble; USD - American dollar |
Default - SSP currency | No |
imp | Array of objects: requirements for ad materials for placement | Used to select materials that are relevant to the requirements | Yes |
site | Details about the publisher's website | Required site or app | |
app | Details about the publisher's app | Required site or app | |
user | Details about the human user of the device | Yes | |
badv | List of domains to be excluded from the auction | No | |
bcat | Blocked categories of advertisers using IAB content categories | ||
device | Details about the user's device to which the impression will be delivered | Yes |
imp
Attribute | Description | Using | Always passed |
id | A unique identifier for this impression | Yes | |
secure | Connection type. Possible choices:
0 - indicates that you should select materials available via http and https protocols. 1 - specifies that you should select only those materials that are available via https |
Default value - https | No |
bidfloor | Minimum bid for this impression | Default 0 | No |
bidfloorcur | Impression value currency | Default - USD. Currency specified using ISO-4217 alpha codes | No |
tagid | Identifier for specific ad placement or ad tag that was used to initiate the auction | Recommended | |
ext | Additional parameters | ||
native | Parameter for native and push formats, where you need to transmit assets (headers, descriptions, pictures, icons, etc.) | Required for Native, Push | |
banner | Parameter for Banner format | Yes for Banner Ad | |
video | Parameter for Video format | Yes for Video Ad | |
instl | Valid values:
1 - full-screen ad (interstitial), 0 - not interstitial |
Default 0 | No |
battr | Blocked parameters | No |
imp.ext
Attribute | Description | Using | Always passed |
subage / subage_dt / subage0 / subage_ts | User subscription age | If the "subage" parameter is not filled in, filled in incorrectly, or not passed, it is considered "undefined", this reduces the buyout. For the first day of subscription expected: subage - 1, subage0 - 0, subage_dt - actual date of subscription, subage_ts - actual date of subscription (unixtime) | Yes for push Ad |
imp.native
Attribute | Description | Using | Always passed |
request | Request in JSON encoding for push and native materials | Options:
openrtb.native.string - JSON query text; openrtb.native - the query is a JSON object. It is similar to openrtb.native.string, only in case of string query is encoded to JSON text |
Yes |
ver | Version of the Native Ad Specification to which request complies |
imp.native.request
Attribute | Description | Using | Always passed |
plcmtcnt | The number of identical placements in this Layout |
imp.banner
Attribute | Description | Using | Always passed |
w | Width in device independent pixels (DIPS) | Required “w” and “h” or “format | |
h | Height in device independent pixels (DIPS) | Required “w” and “h” or “format | |
format | Array of Format objects representing the banner sizes permitted | Required “w” and “h” or “format” |
imp.video
Attribute | Description | Using | Always passed |
mimes | Whitelist of content MIME types supported | Popular MIME types include but are not limited to "image/jpg", "image/gif" and "application/x-shockwave-flash" | Yes |
minduration | Minimum video ad duration in seconds | ||
maxduration | Maximum video ad duration in seconds | Yes | |
protocols | Protocol versions. Valid values:
1 — VAST 1.0; 2 — VAST 2.0; 3 — VAST 3.0; 4 — VAST 1.0 Wrapper; 5 — VAST 2.0 Wrapper; 6 — VAST 3.0 Wrapper |
Yes | |
w | Width of the video player in device independent pixels (DIPS) | Yes | |
h | Height of the video player in device independent pixels (DIPS) | Yes | |
startdelay | Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements | ||
linearity | Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed | Examples:
LINEAR = 1: Linear/In-stream; NON_LINEAR = 2: Non-linear/Overlay |
|
api | List of supported API frameworks for this impression |
site
Attribute | Description | Using | Always passed |
id | Site ID on the exchange | For the uniqueness of the site, the creation of black- or white-lists | Yes |
domain | Domain of the site | For internal classification of domains in the Kadam system | Yes |
page | URL of the page where the impression will be shown | For internal classification of domains in the Kadam system | Recommended |
name | Stream name or its unique identifier | ||
publisher | Details about the Publisher object of the site | ||
content | Details about the Content within the site | ||
cat | Array of IAB content categories of the site | You don't have to pass it if the "domain" parameter is filled in, because Kadam classifies domains internally | Recommended |
ext | Additional site parameters |
site.publisher
Attribute | Description | Using | Always passed |
id | Unique ID of the site owner |
app
Attribute | Description | Using | Always passed |
id | Application ID on the exchange | For the uniqueness of the site, the creation of black- or white-lists | Yes |
domain | Domain of the application, used for advertiser side blocking. For example, “Foo.com” | For internal classification of domains in the Kadam system | Yes |
page | Full URL | For internal classification of domains in the Kadam system | |
name | Application name (may be aliased at publisher's request) | ||
bundle | A platform-specific application identifier intended to be unique to the app and independent of the exchange. Examples:
IOS - 1453331063 Android - com.foo.mygame |
||
storeurl | App store URL for an installed app | ||
cat | IAB site category | It is possible not to pass, if the parameter "domain" is filled in (Kadam has an internal classification of domains) | Recommended |
ver | The version of the native ad specification to which the request corresponds | ||
publisher | Details about the Publisher object of the app | ||
ext | Additional application parameters |
app.publisher
Attribute | Description | Using | Always passed |
id | Unique ID of the application owner | ||
name | Publisher name |
user
Attribute | Description | Using | Always passed |
id | Unique user ID in system | Kadam generates on its own if not filled in | |
buyeruid | Unique user ID in the Kadam system | Used if Cookie Matching is configured. Is prioritized over user.id | |
yob | Year of birth as a 4-digit integer | ||
Gender | Пол | "M" = male;
"F" = female; "O" = unknown |
|
ext | Additional user parameters |
user.ext
Attribute | Description | Using | Always passed |
consent | The web-safe base64-encoded IAB Transparency and Consent Framework (TCF) v2 consent string fetched from the publisher's IAB Consent Management Platform (CMP). The structure of the string is defined by the IAB TCF v2 | This field will be populated if the publisher has integrated with a CMP for TCF v2 and that CMP indicates that GDPR applies to this ad request and provides a valid consent string |
device
Attribute | Description | Using | Always passed |
ifa | The unique identifier of the device in UUID format | If available in request, used as user.id | No |
geo | Geolocation of the user device | No | |
ip | IPv4 address closest to device | To determine the geolocation of a user's device on the Kadam side | Required ip or ipv6 |
ipv6 | IP address closest to device as IPv6 | To determine the geolocation of a user's device on the Kadam side | Required ip or ipv6 |
ua | User agent | To identify the user's operating system, device and browser on the Kadam side | Yes |
js | Support for JavaScript, where 0 - no, 1 - yes | ||
language | Main browser language, ISO-639-1-alpha-2 | To define the browser language. Examples: &language=ru-RU or &language=ru. If the parameter "language" is not filled in, filled in incorrectly or not passed, it is considered "undefined", it reduces the buyout |
device.geo
Attribute | Description | Using | Always passed |
utcoffset | Local time as the number +/- of minutes from UTC | ||
country | Country using ISO-3166-1 Alpha-3 |
ext
Attribute | Description | Using | Always passed |
bsection | Used to specify the categories of material that are not allowed within a given request. Integer view | For a complete list of categories, please contact your manager | No |
btags | Used to specify the categories of material that are not allowed within a given request. Integer view | For a complete list of categories, please contact your manager | No |
Examples Bid Request
CLICKUNDER
{
} |
PUSH
{
} |
ON SITE PUSH (INPAGE)
{
} |
NATIVE (TEASER)
{
} |
NATIVE APP
{
} |
BANNER
{
} |
BANNER APP
{
} |
VIDEO
{
} |
VIDEO APP
{
} |
OpenRTB Bid Response
OpenRTB Bid Response
Description of supported parameters
Attribute | Description | Using | Always passed |
id | ID bid request | ||
cur | Bid currency using ISO-4217 alpha codes | ||
seatbid | Array of Seatbid objects |
seatbid
Attribute | Description | Using | Always passed |
bid | Array of 1+ Bid objects each related to an impression | ||
seat | ID of the buyer seat on whose behalf this bid is made | ||
group | 0 = impressions can be won individually;
1 = impressions must be won or lost as a group |
Default - 0 |
seatbid.bid
Attribute | Description | Using | Always passed |
id | ID of the bid request to which this is a response | ||
adid | ID of a preloaded ad to be served if the bid wins | ||
crid | Creative ID to assist with ad quality checking | ||
impid | ID of the Imp object in the related bid request | ||
price | Bid price expressed as CPM | ||
nurl | Win notice URL called by the exchange if the bid wins | Called when the bid wins | |
burl | Billing notice URL | If the partner supports “burl”, you must contact your manager to enable it. It is not available by default | |
lurl | Loss notice URL | Called by the exchange when a bid is known to have been lost. Before enabling the lurl pass, you should discuss reactions to the codes with your Kadam manager. Possible reactions: ban for tagid, site.domain, site.id, whole for integration. | |
adomain | Advertiser domain for block list checking (e.g., "addomain.com") | This can be an array for the case of rotating creatives. Exchanges can mandate that only one domain is allowed | |
cat | IAB content categories of the creative | ||
adm | Optional means of conveying ad markup in case the bid wins | ||
w | Width of the creative in device independent pixels (DIPS) | Used by default in response (in banner format) | |
h | Height of the creative in device independent pixels (DIPS) | Used by default in response (in banner format) |
Examples Bid Response
CLICKUNDER
{
} |
PUSH
{
|
ON SITE PUSH (INPAGE)
{
|
NATIVE (TEASER)
{
} |
NATIVE APP
{
} |
BANNER
{
} |
BANNER APP
{
} |
VIDEO
{
} |
VIDEO APP
{
} |
XML Integration
XML Integration
This documentation explains how advertisers can integrate their platforms with Kadam using the XML.
Bid Request/Response
Supported ad types:
- Native;
- Push;
- On site push (inpage);
- iOS calendar push;
- Clickunder.
XML Bid Request
XML Bid Request
Description of supported parameters
These objects should be sent in GET request parameters:
Attribute | Description | Using | Always passed |
sid | endpoint ID | Stream uniqueness in Kadam. Issued by Kadam | Yes |
skey | API key | Issued by Kadam | |
ua | user agent | To identify the user's operating system, device and browser on the Kadam side | Yes |
ip | User’s IP address | To determine the geolocation of a user's device on the Kadam sidem | Required ip or ipv6 |
uid | User ID in the SSP | For user uniqueness | Yes |
limit | Limiting the number of creatives in a response | If there is no limit in the request and on the block, the default=1 | |
language | Main browser language, ISO 3166-1 alpha-2 coding | To define the browser language. Examples: &language=ru-RU or &language=ru. If the parameter "language" is not filled in, filled in incorrectly or not passed, it is considered "undefined", it reduces the buyout | |
subage / subage_dt / subage0 / subage_ts / subage_ts_ms | User subscription age | If the "subage" parameter is not filled in, filled in incorrectly, or not passed, it is considered "undefined", this reduces the buyout. For the first day of subscription expected: subage=1, subage0=0, subage_dt - actual date of subscription, subage_ts - actual date of subscription (seconds in unixtime), subage_ts_ms - actual date of subscription (milliseconds in unixtime) | Yes (for Push) |
pid | Publisher ID | This parameter expects the ID of the publisher (site, webmaster) on the SSP | Yes |
cat | IAB-category domain | IAB24 on meinstream and IAB25-3 on adalt by default | No |
page | Page domain | Expected page domain | Desirable |
format | Traffic format | cu, pops - for clickunder;
native, teaser - for teaser; push by default |
No |
Examples of Bid Request
PUSH
/feed
?sid=5 &skey=5azqxvgap5yNsm5X5rg5PMsgDD &ua=Mozilla%2F5.0+%28Linux%3B+Android+9%3B+SAMSUNG+SM-A105FN%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+SamsungBrowser%2F12.1+Chrome%2F79.0.3945.136+Mobile+Safari%2F537.36 &ip=127.1.0.0 &uid=Xef5LfyUte-tzwpV5-fMV &limit=1 &language=en &pid=1 &subage=2 &cat=126 &page=example.com |
CLICKUNDER
/feed
?sid=555 &format=cu &ua=Mozilla%2F5.0+%28Linux%3B+Android+10%3B+SM-J600F%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F91.0.4472.88+Mobile+Safari%2F537.36 &ip=127.1.0.0 &uid=555555555 &limit=5 &language=fa-IR &pid=5555555 &page=example.com |
ON SITE PUSH (INPAGE)
/feed
?sid=5 &skey=5azqxvgap5yNsm5X5rg5PMsgDD &ua=Mozilla%2F5.0+%28Linux%3B+Android+9%3B+SAMSUNG+SM-A105FN%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+SamsungBrowser%2F12.1+Chrome%2F79.0.3945.136+Mobile+Safari%2F537.36 &ip=127.1.0.0 &uid=Xef5LfyUte-tzwpV5-fMV &limit=1 &language=en &pid=1 &cat=126 &page=example.com |
IOS CALENDAR PUSH
/feed
?sid=555 &skey=ca555555f555ec5a5a5ff55cc5b5fb5c &ua=iOS%2F14.4+%5558D52%29+dataaccessd%2F1.0 &ip=127.1.0.0 &uid=0.00695555.5515680055292 &language=en &subage_dt=2021-07-10 &pid=5555555555 &limit=1 |
NATIVE
/feed
?sid=555 &skey=b5cb555d5efcd555ade5555a5eaa5f55 &ua=Mozilla%2F5.0+%28Linux%3B+Android+11%3B+SM-T500%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F91.0.4472.120+Safari%2F537.36 &ip=127.1.0.0 &uid=5b5aa555-bd55-555b-a5d5-55f55f5c55df &language=de &pid=55 &page=example.com &format=native |
XML Bid Response
XML Bid Response
Description of supported parameters (the Bid Response format can be changed to suit your requirements, please contact our manager)
result.listing
Attribute | Description | Using | Always passed |
url | Ad link | ||
bid | Bid | ||
pixel | Nurl | ||
image | Image link | ||
title | Ad title | ||
descr | Header ad | ||
site | Site link | ||
icon | Icon link |
Examples of Bid Response:
PUSH
1. Icon contains nurl and icon, separate request pixel (nurl) is not required
<result>
<result> |
2. With “pixel”
<result>
<result> |
CLICKUNDER
<result>
<result> |
ON SITE PUSH (INPAGE)
<result>
<result> |
IOS CALENDAR PUSH
<result>
<result> |
NATIVE
<result>
<result> |