OpenRTB/Feed документация по интеграции SSP — различия между версиями
Admin (обсуждение | вклад) |
Admin (обсуждение | вклад) |
||
(не показано 20 промежуточных версий этого же участника) | |||
Строка 10: | Строка 10: | ||
* [https://wiki.kadam.net/index.php?title=OpenRTB/Feed_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F_%D0%BF%D0%BE_%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8_SSP#OpenRTB_.D0.B8.D0.BD.D1.82.D0.B5.D0.B3.D1.80.D0.B0.D1.86.D0.B8.D1.8F Интеграция по OpenRTB] | * [https://wiki.kadam.net/index.php?title=OpenRTB/Feed_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F_%D0%BF%D0%BE_%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8_SSP#OpenRTB_.D0.B8.D0.BD.D1.82.D0.B5.D0.B3.D1.80.D0.B0.D1.86.D0.B8.D1.8F Интеграция по OpenRTB] | ||
+ | * [https://wiki.kadam.net/index.php?title=OpenRTB/Feed_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F_%D0%BF%D0%BE_%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8_SSP#XML_.D0.B8.D0.BD.D1.82.D0.B5.D0.B3.D1.80.D0.B0.D1.86.D0.B8.D1.8F Интеграция по XML] | ||
'''Bid Request/Response''' | '''Bid Request/Response''' | ||
Строка 22: | Строка 23: | ||
* [https://wiki.kadam.net/index.php?title=OpenRTB/Feed_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F_%D0%BF%D0%BE_%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8_SSP#OpenRTB_Bid_Response OpenRTB Bid Response] | * [https://wiki.kadam.net/index.php?title=OpenRTB/Feed_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F_%D0%BF%D0%BE_%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8_SSP#OpenRTB_Bid_Response OpenRTB Bid Response] | ||
+ | |||
+ | * [https://wiki.kadam.net/index.php?title=OpenRTB/Feed_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F_%D0%BF%D0%BE_%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8_SSP#XML_Bid_Request XML Bid Request] | ||
+ | |||
+ | * [https://wiki.kadam.net/index.php?title=OpenRTB/Feed_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F_%D0%BF%D0%BE_%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8_SSP#XML_Bid_Response XML Bid Response] | ||
Строка 34: | Строка 39: | ||
4. Проводятся тесты на предмет работоспособности интеграции и наличия расхождений между данными системы Kadam и SSP. Тесты проводятся на “живых“ рекламных материалах. | 4. Проводятся тесты на предмет работоспособности интеграции и наличия расхождений между данными системы Kadam и SSP. Тесты проводятся на “живых“ рекламных материалах. | ||
− | 5. Если расхождения в пределах нормы и отсутствуют технические проблемы, запускается интеграция в полноценном рабочем режиме. | + | 5. Если расхождения в пределах нормы (10%) и отсутствуют технические проблемы, запускается интеграция в полноценном рабочем режиме. |
'''Ключевые моменты''' | '''Ключевые моменты''' | ||
− | * Kadam поддерживает протоколы 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]; | + | * Kadam поддерживает протоколы 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; |
* Чтобы подключить новую SSP, необходимо убедиться, что вы поддерживаете передачу необходимых параметров и готовы отправлять запросы и получать от нас ответы; | * Чтобы подключить новую SSP, необходимо убедиться, что вы поддерживаете передачу необходимых параметров и готовы отправлять запросы и получать от нас ответы; | ||
Строка 50: | Строка 55: | ||
'''Cookie Matching''' | '''Cookie Matching''' | ||
− | + | Для чего необходим Cookie Matching: | |
− | + | * позволяет избегать повторного показа рекламы пользователю; | |
− | Cookie Matching | + | * может быть использована в предикте его интересов; |
+ | * ретаргетинга. | ||
+ | С помощью Cookie Matching можно сопоставить id пользователя (по вашей версии), который просматривал ваш веб-сайт, с соответствующим id пользователя по версии Kadam. | ||
Ознакомиться подробнее с возможными вариантами интеграции можно [https://wiki.kadam.net/index.php?title=Cookie_matching здесь]. Для настройки Cookie Matching необходимо обратиться к менеджеру Kadam. | Ознакомиться подробнее с возможными вариантами интеграции можно [https://wiki.kadam.net/index.php?title=Cookie_matching здесь]. Для настройки Cookie Matching необходимо обратиться к менеджеру Kadam. | ||
Строка 76: | Строка 83: | ||
* Push; | * Push; | ||
− | * | + | * inpage (on site push); |
* iOS calendar push; | * iOS calendar push; | ||
− | * | + | * Pops. |
== Feed Bid Request == | == Feed Bid Request == | ||
Строка 134: | Строка 141: | ||
| | | | ||
|- | |- | ||
− | |subage / subage_dt / subage0 / subage_ts | + | |subage / subage_dt / subage0 / subage_ts/ subage_ts_ms |
|Возраст подписки пользователя | |Возраст подписки пользователя | ||
− | |Если параметр subage не заполнен, заполнен некорректно или не передается, он считается "неопределенным", это снижает выкуп. Для первого дня подписки ожидается: subage=1, subage0=0, subage_dt - фактическая дата подписки, subage_ts - фактическая дата подписки (unixtime) | + | |Если параметр subage не заполнен, заполнен некорректно или не передается, он считается "неопределенным", это снижает выкуп. Для первого дня подписки ожидается: subage=1, subage0=0, subage_dt - фактическая дата подписки, subage_ts - фактическая дата подписки (секунды в unixtime), subage_ts_ms - фактическая дата подписки (миллисекунды в unixtime) |
− | |Обязательный | + | |Обязательный для Push |
|- | |- | ||
|pid | |pid | ||
Строка 160: | Строка 167: | ||
По умолчанию - push | По умолчанию - push | ||
− | | | + | |Обязательный |
|} | |} | ||
Строка 195: | Строка 202: | ||
|} | |} | ||
− | ''' | + | '''POPS''' |
{| class="wikitable" style="width: 85%;" | {| class="wikitable" style="width: 85%;" | ||
Строка 220: | Строка 227: | ||
|} | |} | ||
− | '''ON SITE PUSH | + | '''INPAGE (ON SITE PUSH)''' |
{| class="wikitable" style="width: 85%;" | {| class="wikitable" style="width: 85%;" | ||
Строка 320: | Строка 327: | ||
| | | | ||
|- | |- | ||
− | |crid | + | |crid (adid) |
|ID креатива | |ID креатива | ||
| | | | ||
Строка 387: | Строка 394: | ||
|result | |result | ||
|Объект ставок | |Объект ставок | ||
− | |Используется в | + | |Используется в pops |
| | | | ||
|- | |- | ||
Строка 426: | Строка 433: | ||
:{ | :{ | ||
::"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, | ||
Строка 444: | Строка 453: | ||
:{ | :{ | ||
::"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, | ||
Строка 456: | Строка 467: | ||
|} | |} | ||
− | ''' | + | '''POPS''' |
{| class="wikitable" style="max-width: 85%; overflow-x: auto; display: block;" | {| class="wikitable" style="max-width: 85%; overflow-x: auto; display: block;" | ||
Строка 471: | Строка 482: | ||
|} | |} | ||
− | '''ON SITE PUSH | + | '''INPAGE (ON SITE PUSH)''' |
{| class="wikitable" style="max-width: 85%; overflow-x: auto; display: block;" | {| class="wikitable" style="max-width: 85%; overflow-x: auto; display: block;" | ||
Строка 562: | Строка 573: | ||
* Push; | * Push; | ||
− | * | + | * inpage (on site push); |
* iOS calendar push; | * iOS calendar push; | ||
− | * | + | * Pops; |
* Video. | * Video. | ||
Строка 1128: | Строка 1139: | ||
|- | |- | ||
|country | |country | ||
− | |Код страны (по стандарту ISO-3166-1 Alpha- | + | |Код страны (по стандарту ISO-3166-1 Alpha-2) |
| | | | ||
| | | | ||
Строка 1155: | Строка 1166: | ||
'''Примеры Bid Request''' | '''Примеры Bid Request''' | ||
− | ''' | + | '''POPS''' |
{| class="wikitable" style="width: 85%;" | {| class="wikitable" style="width: 85%;" | ||
Строка 1289: | Строка 1300: | ||
|} | |} | ||
− | '''ON SITE PUSH | + | '''INPAGE (ON SITE PUSH)''' |
{| class="wikitable" style="width: 85%;" | {| class="wikitable" style="width: 85%;" | ||
Строка 1954: | Строка 1965: | ||
'''Примеры Bid Response''' | '''Примеры Bid Response''' | ||
− | ''' | + | '''POPS''' |
{| class="wikitable" style="max-width: 85%; overflow-x: auto; display: block;" | {| class="wikitable" style="max-width: 85%; overflow-x: auto; display: block;" | ||
Строка 1968: | Строка 1979: | ||
:::::"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": [ | ||
Строка 1977: | Строка 1988: | ||
::::::"IAB9-7" | ::::::"IAB9-7" | ||
:::::], | :::::], | ||
− | :::::"adm": <nowiki>" | + | :::::"adm":<nowiki>"https://click_url_must_be_here.com"</nowiki> |
::::} | ::::} | ||
:::], | :::], | ||
Строка 2015: | Строка 2026: | ||
|} | |} | ||
− | '''ON SITE PUSH | + | '''INPAGE (ON SITE PUSH)''' |
{| class="wikitable" style="max-width: 85%; overflow-x: auto; display: block;" | {| class="wikitable" style="max-width: 85%; overflow-x: auto; display: block;" | ||
Строка 2237: | Строка 2248: | ||
:] | :] | ||
} | } | ||
+ | |} | ||
+ | |||
+ | == XML интеграция == | ||
+ | |||
+ | '''XML интеграция''' | ||
+ | |||
+ | Эта документация объясняет, как рекламодатели могут интегрировать свои платформы с Kadam, используя XML. | ||
+ | |||
+ | |||
+ | '''Bid Request/Response''' | ||
+ | |||
+ | * [https://wiki.kadam.net/index.php?title=OpenRTB/Feed_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F_%D0%BF%D0%BE_%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8_SSP#XML_Bid_Request XML Bid Request] | ||
+ | |||
+ | * [https://wiki.kadam.net/index.php?title=OpenRTB/Feed_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F_%D0%BF%D0%BE_%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8_SSP#XML_Bid_Response XML Bid Response] | ||
+ | |||
+ | |||
+ | '''Поддерживаемые типы рекламы:''' | ||
+ | |||
+ | * Native; | ||
+ | |||
+ | * Push; | ||
+ | |||
+ | * inpage (in site push); | ||
+ | |||
+ | * iOS calendar push; | ||
+ | |||
+ | * Pops. | ||
+ | |||
+ | == XML Bid Request == | ||
+ | |||
+ | |||
+ | '''XML Bid Request''' | ||
+ | |||
+ | Описание поддерживаемых параметров | ||
+ | |||
+ | '''Следующие объекты следует отправлять в GET параметрах запроса:''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | |- | ||
+ | | style="width: 10%"|'''Параметр''' | ||
+ | | style="width: 20%"|'''Описание''' | ||
+ | | style="width: 50%"|'''Использование''' | ||
+ | | style="width: 20%"|'''Обязательный''' | ||
+ | |- | ||
+ | |sid | ||
+ | |endpoint ID | ||
+ | |Уникализация потока в Kadam. Выдается Kadam | ||
+ | |Обязательный | ||
+ | |- | ||
+ | |skey | ||
+ | |Ключ API | ||
+ | |Выдается Kadam | ||
+ | | | ||
+ | |- | ||
+ | |ua | ||
+ | |user agent | ||
+ | |Для определения ос, устройства, браузера пользователя на стороне Kadam | ||
+ | |Обязательный | ||
+ | |- | ||
+ | |ip | ||
+ | |IP-адрес пользователя | ||
+ | |Для определения геолокации устройства пользователя на стороне Kadam | ||
+ | |Обязательный либо IP, либо IPv6 | ||
+ | |- | ||
+ | |uid | ||
+ | |ID пользователя в системе SSP | ||
+ | |Для уникализации пользователя | ||
+ | |Обязательный | ||
+ | |- | ||
+ | |limit | ||
+ | |Ограничение количества креативов в ответе | ||
+ | |Если лимит отсутствует в запросе и на блоке, считается как 1 по умолчанию | ||
+ | | | ||
+ | |- | ||
+ | |language | ||
+ | |Основной язык браузера, кодировка ISO 3166-1 alpha-2 | ||
+ | |Для определения языка браузера. Пример передачи: &language=ru-RU или &language=ru. Если параметр language не заполнен, заполнен некорректно или не передается, он считается "неопределенным", это снижает выкуп | ||
+ | | | ||
+ | |- | ||
+ | |subage / subage_dt / subage0 / subage_ts/ subage_ts_ms | ||
+ | |Возраст подписки пользователя | ||
+ | |Если параметр subage не заполнен, заполнен некорректно или не передается, он считается "неопределенным", это снижает выкуп. Для первого дня подписки ожидается: subage=1, subage0=0, subage_dt - фактическая дата подписки, subage_ts - фактическая дата подписки (секунды в unixtime), subage_ts_ms - фактическая дата подписки (миллисекунды в unixtime) | ||
+ | |Обязательный для Push | ||
+ | |- | ||
+ | |pid | ||
+ | |ID паблишера | ||
+ | |В параметре ожидается ID паблишера (сайта, вебмастера) на стороне SSP | ||
+ | |Обязательный | ||
+ | |- | ||
+ | |cat | ||
+ | |IAB-категория домена | ||
+ | |По умолчанию на меинстриме - IAB24, на адалте - IAB25-3 | ||
+ | |Необязательный | ||
+ | |- | ||
+ | |page | ||
+ | |Домен страницы | ||
+ | |Ожидается страница | ||
+ | |Желательный | ||
+ | |- | ||
+ | |format | ||
+ | |Формат трафика | ||
+ | |Cu, pops - для кликандера; | ||
+ | Native, teaser - для тизера; | ||
+ | |||
+ | По умолчанию - push | ||
+ | |Обязательный | ||
+ | |} | ||
+ | |||
+ | '''Примеры 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 | ||
+ | |||
+ | |} | ||
+ | |||
+ | '''POPS''' | ||
+ | |||
+ | {| 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 | ||
+ | |} | ||
+ | |||
+ | '''INPAGE (ON SITE 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 | ||
+ | |||
+ | &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''' | ||
+ | |||
+ | Описание поддерживаемых параметров (формат Bid Response может быть изменен по вашим требованиям, для этого обратитесь к нашему менеджеру) | ||
+ | |||
+ | '''result.listing''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | |- | ||
+ | | style="width: 10%"|'''Параметр''' | ||
+ | | style="width: 20%"|'''Описание''' | ||
+ | | style="width: 50%"|'''Использование''' | ||
+ | | style="width: 20%"|'''Обязательный''' | ||
+ | |- | ||
+ | |url | ||
+ | |Ссылка для перехода по объявлению | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |bid | ||
+ | |Ставка | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |pixel | ||
+ | |Nurl | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |image | ||
+ | |Ссылка на изображение материала | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |title | ||
+ | |Заголовок объявления | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |descr | ||
+ | |Текст объявления | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |site | ||
+ | |URL сайта | ||
+ | | | ||
+ | | | ||
+ | |- | ||
+ | |icon | ||
+ | |Ссылка на иконку | ||
+ | | | ||
+ | | | ||
+ | |} | ||
+ | |||
+ | '''Примеры Bid Response:''' | ||
+ | |||
+ | '''PUSH''' | ||
+ | |||
+ | '''1. Icon содержит в себе nurl и icon, отдельный вызов pixel (nurl) не требуется''' | ||
+ | |||
+ | {| 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. С отдельным полем “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> | ||
+ | |} | ||
+ | |||
+ | '''POPS''' | ||
+ | |||
+ | {| class="wikitable" style="width: 85%;" | ||
+ | | | ||
+ | <result> | ||
+ | ::<listing | ||
+ | ::::url=<nowiki>"http://example.com/click"</nowiki> | ||
+ | ::::bid="0.003" | ||
+ | ::/> | ||
+ | <result> | ||
+ | |} | ||
+ | |||
+ | '''INPAGE (ON SITE 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> | ||
+ | |} | ||
+ | |||
+ | '''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> | ||
|} | |} |
Текущая версия на 12:40, 3 июня 2024
Содержание
Общая информация
Интеграция
Узнать подробнее об интеграции по протоколам Feed и OpenRTB:
Bid Request/Response
Описание поддерживаемых параметров и примеры Bid Request/Response:
Процесс интеграции
1. Ознакомление с документацией.
2. SSP регистрирует аккаунт вебмастера в системе Kadam.
3. Kadam создает и выдает эндпоинт/фид под соответствующий формат рекламы и тип интеграции (для каждого отдельный).
4. Проводятся тесты на предмет работоспособности интеграции и наличия расхождений между данными системы Kadam и SSP. Тесты проводятся на “живых“ рекламных материалах.
5. Если расхождения в пределах нормы (10%) и отсутствуют технические проблемы, запускается интеграция в полноценном рабочем режиме.
Ключевые моменты
- Kadam поддерживает протоколы Feed, OpenRTB 2.5, Native 1.1, Native 1.2, XML;
- Чтобы подключить новую SSP, необходимо убедиться, что вы поддерживаете передачу необходимых параметров и готовы отправлять запросы и получать от нас ответы;
- Клики без nurl не учитываются и попадают в traffic back;
- В документе указаны параметры, поддерживаемые Kadam, если какие-то параметры не описаны, значит их поддержка не реализована.
Cookie Matching
Для чего необходим Cookie Matching:
- позволяет избегать повторного показа рекламы пользователю;
- может быть использована в предикте его интересов;
- ретаргетинга.
С помощью Cookie Matching можно сопоставить id пользователя (по вашей версии), который просматривал ваш веб-сайт, с соответствующим id пользователя по версии Kadam.
Ознакомиться подробнее с возможными вариантами интеграции можно здесь. Для настройки Cookie Matching необходимо обратиться к менеджеру Kadam.
Feed интеграция
Feed интеграция
Эта документация объясняет, как рекламодатели могут интегрировать свои платформы с Kadam, используя стандарт Feed.
Bid Request/Response
Поддерживаемые типы рекламы:
- Native;
- Push;
- inpage (on site push);
- iOS calendar push;
- Pops.
Feed Bid Request
Feed Bid Request
Описание поддерживаемых параметров
Следующие объекты следует отправлять в GET параметрах запроса:
Параметр | Описание | Использование | Обязательный |
sid | endpoint ID | Уникализация потока в Kadam. Выдается Kadam | Обязательный |
skey | Ключ API | Выдается Kadam | |
ua | user agent | Для определения ос, устройства, браузера пользователя на стороне Kadam | Обязательный |
ip | IP-адрес пользователя | Для определения геолокации устройства пользователя на стороне Kadam | Обязательный либо IP, либо IPv6 |
uid | ID пользователя в системе SSP | Для уникализации пользователя | Обязательный |
limit | Ограничение количества креативов в ответе | Если лимит отсутствует в запросе и на блоке, считается как 1 по умолчанию | |
language | Основной язык браузера, кодировка ISO 3166-1 alpha-2 | Для определения языка браузера. Пример передачи: &language=ru-RU или &language=ru. Если параметр language не заполнен, заполнен некорректно или не передается, он считается "неопределенным", это снижает выкуп | |
subage / subage_dt / subage0 / subage_ts/ subage_ts_ms | Возраст подписки пользователя | Если параметр subage не заполнен, заполнен некорректно или не передается, он считается "неопределенным", это снижает выкуп. Для первого дня подписки ожидается: subage=1, subage0=0, subage_dt - фактическая дата подписки, subage_ts - фактическая дата подписки (секунды в unixtime), subage_ts_ms - фактическая дата подписки (миллисекунды в unixtime) | Обязательный для Push |
pid | ID паблишера | В параметре ожидается ID паблишера (сайта, вебмастера) на стороне SSP | Обязательный |
cat | IAB-категория домена | По умолчанию на меинстриме - IAB24, на адалте - IAB25-3 | Необязательный |
page | Домен страницы | Ожидается страница | Желательный |
format | Формат трафика | Cu, pops - для кликандера;
Native, teaser - для тизера; По умолчанию - push |
Обязательный |
Примеры 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 |
POPS
/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 |
INPAGE (ON SITE 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 &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
Описание поддерживаемых параметров (для изменения нейминга параметров в Bid Response обращайтесь к нашему менеджеру)
Параметр | Описание | Использование | Обязательный |
id | ID материала | ||
impid | ID импрешна | ||
crid (adid) | ID креатива | ||
nurl | URL уведомление о выигрыше | Возможно высылать:
Переключение режима ответа происходит через менеджера. |
|
link (click_url) | Кликовая ссылка | ||
campaing_id (cid) | ID кампании | ||
category | ID категории (секции) материала | ||
title | Заголовок объявления | ||
description (desc) | Заголовок объявления | ||
text | Текст объявления | ||
image_url | Ссылка на изображение материала | ||
icon_url | Ссылка на иконку + nurl | Используется в push-уведомлениях | |
cpc (price) | Ставка (bid) материала | ||
image | Ссылка на картинку + nurl | ||
result | Объект ставок | Используется в pops | |
listing | Массив объектов ставок |
result.listing
Параметр | Описание | Использование | Обязательный |
url | Ссылка для перехода по объявлению | ||
bid | Ставка |
Примеры Bid Response:
PUSH
1. Icon_url содержит в себе nurl и icon_url
[
] |
2. С отдельным полем “nurl”
[
] |
POPS
{
} |
INPAGE (ON SITE PUSH)
[
] |
IOS CALENDAR PUSH
1
[
] |
2
[
] |
NATIVE
[
] |
OpenRTB интеграция
OpenRTB интеграция
Эта документация объясняет, как рекламодатели могут интегрировать свои платформы с Kadam, используя стандарт OpenRTB.
Bid Request/Response
Поддерживаемые типы рекламы:
- Native;
- Native (teaser);
- Banner;
- Push;
- inpage (on site push);
- iOS calendar push;
- Pops;
- Video.
OpenRTB Bid Request
OpenRTB Bid Request
Описание поддерживаемых параметров
Следующие объекты следует отправлять в кодировке JSON в request body:
Параметр | Описание | Использование | Обязательный |
id | Уникальный идентификатор аукциона | Обязательный | |
at | Тип аукциона. Для SSP, работающих по CPC, всегда проходит аукцион первой цены | Для аукциона первой цены at=1.
По умолчанию 2 - Second Price |
Необязательный |
cur | Валюта аукциона. Допустимые значения:
RUB — российский рубль; USD — американский доллар |
По умолчанию используется валюта SSP | Необязательный |
imp | Массив объектов: требования к рекламным материалам для размещения | Используется для подбора релевантных требованиям материалов | Обязательный |
site | Данные о сайте в объекте site | Обязательный site или app | |
app | Подробная информация о приложении | Обязательный site или app | |
user | Данные о пользователе в объекте user | Обязательный | |
badv | Список доменов, которые необходимо исключить из аукциона | Необязательный | |
bcat | Заблокированные категории рекламодателей, использующие категории контента IAB | ||
device | Данные об устройстве пользователя в объекте device | Обязательный |
imp
Параметр | Описание | Использование | Обязательный |
id | Уникальный идентификатор показа | Обязательный | |
secure | Тип соединения. Возможные варианты:
0 — указывает, что нужно подбирать материалы доступные и по http и https протоколам. 1 — указывает, что нужно подбирать материалы доступные только по https |
Значение по умолчанию - “https” | Необязательный |
bidfloor | Минимальная стоимость показа | По умолчанию 0 | Необязательный |
bidfloorcur | Валюта стоимости показа | По умолчанию USD, валидные значения в ISO-4217 | Необязательный |
tagid | Идентификатор конкретного плейсмента объявления или рекламного тега, который был использован для инициирования аукциона | Рекомендуется | |
ext | Дополнительные параметры | ||
native | Параметр для Native и Push форматов, где необходимо передавать ассеты (заголовки, описание, картинки, иконки и т.д) | Обязательный для Native, Push | |
banner | Параметр для формата Banner | Обязательный для Banner Ad | |
video | Параметр для формата Video | Обязательный для Video Ad | |
instl | Валидные значения:
1 - полноэкранная реклама (interstitial), 0 - нет |
По умолчанию 0 | Необязательный |
battr | Заблокированные параметры | Необязательный |
imp.ext
Параметр | Описание | Использование | Обязательный |
subage / subage_dt / subage0 / subage_ts | Возраст подписки пользователя | Если параметр subage не заполнен, заполнен некорректно или не передается, он считается "неопределенным", это снижает выкуп. Для первого дня подписки ожидается: subage=1, subage0=0, subage_dt - фактическая дата подписки, subage_ts - фактическая дата подписки (unixtime) | Обязательный для Push Ad |
imp.native
Параметр | Описание | Использование | Обязательный |
request | Запрос в кодировке JSON для Push и Native материалов | Варианты:
openrtb.native.string - JSON текст запроса; openrtb.native - запрос является JSON объектом. Он аналогичен openrtb.native.string, только в случае строки запрос кодируется в JSON текст |
Обязательный |
ver | Версия спецификации нативной рекламы, которой соответствует запрос |
imp.native.request
Параметр | Описание | Использование | Обязательный |
plcmtcnt | Количество одинаковых размещений в этом шаблоне |
imp.banner
Параметр | Описание | Использование | Обязательный |
w | Ширина баннера в пикселях | Обязательный либо “w” и “h”, либо “format” | |
h | Высота баннера в пикселях | Обязательный либо “w” и “h”, либо “format” | |
format | Массив объектов, представляющих допустимые размеры баннера | Обязательный либо “w” и “h”, либо “format” |
imp.video
Параметр | Описание | Использование | Обязательный |
mimes | White-лист поддерживаемых типов контента MIME-type | Например: "image/jpg", "image/gif" и "application/x-shockwave-flash" | Обязательный |
minduration | Минимальная длина видео в секундах | ||
maxduration | Максимальная длина видео в секундах | Обязательный | |
protocols | Версии протокола. Допустимые значения:
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 |
Обязательный | |
w | Ширина видео в пикселях | Обязательный | |
h | Высота видео в пикселях | Обязательный | |
startdelay | Задержка запуска в секундах для размещения рекламы до, во время или после прокрутки | ||
linearity | Указывает, должен ли оттиск быть линейным, нелинейным и т.д. Если ничего не указано, предполагается, что разрешены все | Примеры:
LINEAR = 1: Linear/In-stream; NON_LINEAR = 2: Non-linear/Overlay |
|
api | Список поддерживаемых API |
site
Параметр | Описание | Использование | Обязательный |
id | Уникальный идентификатор сайта | Для уникализации сайта, создания black- или white-листов партнерами | Обязательный |
domain | Домен страницы | Для внутренней классификации доменов в системе Kadam | Обязательный |
page | Полный адрес страницы | Для внутренней классификации сайтов в системе Kadam | Рекомендуемый |
name | Название сайта | ||
publisher | Данные о владельце сайта | ||
content | Подробная информация о содержимом сайта | ||
cat | Список IAB категорий сайта. Массив строк | Можно не передавать, если заполнен параметр domain, так как Kadam ведется внутренняя классификация доменов | Рекомендуемый |
ext | Дополнительные параметры сайта |
site.publisher
Параметр | Описание | Использование | Обязательный |
id | Уникальный идентификатор сайта |
app
Параметр | Описание | Использование | Обязательный |
id | Уникальный идентификатор приложения | Для уникализации приложения, создания black- или white-листов партнерами | Обязательный |
domain | Домен приложения. Например, “Foo.com” | Для внутренней классификации доменов в системе Kadam | Обязательный |
page | Полный адрес страницы | Для внутренней классификации сайтов в системе Kadam | |
name | Название приложения или псевдоним паблишера | ||
bundle | Уникальный ID приложения для конкретной платформы. Примеры:
IOS - 1453331063 Android - com.foo.mygame |
||
storeurl | App store URL установленного приложения | ||
cat | IAB-категория страницы | Можно не передавать, если заполнен параметр domain, так как Kadam ведется внутренняя классификация доменов | Рекомендуемый |
ver | Версия спецификации нативной рекламы, которой соответствует запрос | ||
publisher | Данные о владельце приложения | ||
ext | Дополнительные параметры приложения |
app.publisher
Параметр | Описание | Использование | Обязательный |
id | Уникальный идентификатор владельца приложения | ||
name | Имя владельца приложения |
user
Параметр | Описание | Использование | Обязательный |
id | Уникальный идентификатор пользователя в системе | Если не заполнен, то Kadam генерирует самостоятельно | |
buyeruid | Уникальный идентификатор пользователя в системе Kadam | Используется, если настроен Cookie Matching. Является приоритетней user.id | |
yob | Год рождения в виде целого 4-значного числа | ||
gender | Пол | "M" = мужчина;
"F" = женщина; "O" = неизвестно |
|
ext | Дополнительные параметры пользователя |
user.ext
Параметр | Описание | Использование | Обязательный |
consent | Строка согласия IAB Transparency and Consent Framework (TCF) v2, полученная от платформы управления согласием (CMP) паблишера. Структура строки определяется IAB TCF v2 | Это поле будет заполнено, если издатель интегрирован с CMP для TCF v2, и эта CMP указывает, что GDPR применяется к данному рекламному запросу и предоставляет действительную строку согласия |
device
Параметр | Описание | Использование | Обязательный |
ifa | Уникальный идентификатор устройства в формате UUID | Если имеется в реквесте, используется в качестве user.id | Необязательный |
geo | Геолокация устройства пользователя | Необязательный | |
ip | Ближайший к пользователю IPv4 адрес | Для определения геолокации устройства пользователя на стороне Kadam | Обязательный либо IP, либо IPv6 |
ipv6 | Ближайший к пользователю IPv6 адрес | Для определения геолокации устройства пользователя на стороне Kadam | Обязательный либо IP, либо IPv6 |
ua | User agent | Для определения ос, устройства, браузера пользователя на стороне Kadam | Обязательный |
js | Поддержка JS. 1 - присутствует, 0 - отсутствует | ||
language | Основной язык браузера, кодировка ISO-639-1-alpha-2 | Для определения языка браузера. Пример передачи: &language=ru-RU или &language=ru. Если параметр language не заполнен, заполнен некорректно или не передается, он считается "неопределенным", это снижает выкуп |
device.geo
Параметр | Описание | Использование | Обязательный |
utcoffset | Количество часов, на которое смещен часовой пояс от UTC | ||
country | Код страны (по стандарту ISO-3166-1 Alpha-2) |
ext
Параметр | Описание | Использование | Обязательный |
bsection | Используется для указания категорий материалов, которые запрещены в рамках данного реквеста. Целочисленный вид | Для получения полного списка категорий необходимо обратиться к менеджеру | Необязательный |
btags | Используется для указания тегов материалов, которые запрещены в рамках данного реквеста. Целочисленный вид | Для получения полного списка тегов необходимо обратиться к менеджеру | Необязательный |
Примеры Bid Request
POPS
{
} |
PUSH
{
} |
INPAGE (ON SITE PUSH)
{
} |
NATIVE (TEASER)
{
} |
NATIVE APP
{
} |
BANNER
{
} |
BANNER APP
{
} |
VIDEO
{
} |
VIDEO APP
{
} |
OpenRTB Bid Response
OpenRTB Bid Response
Описание поддерживаемых параметров
Параметр | Описание | Использование | Обязательный |
id | ID bid request | ||
cur | Валюта ставки (с использованием ISO-4217) | ||
seatbid | Массив seatbid объектов |
seatbid
Параметр | Описание | Использование | Обязательный |
bid | Массив bid объектов | ||
seat | ID покупателя, от имени которого
делается ставка |
||
group | 0 = можно выиграть в индивидуальном порядке;
1 = должны быть выиграны или проиграны группой |
По умолчанию 0 |
seatbid.bid
Параметр | Описание | Использование | Обязательный |
id | ID ставки | ||
adid | ID предварительно загруженного объявления | Будет использовано, если ставка выиграет | |
crid | Creative ID | Помогает в проверке качества рекламы | |
impid | ID объекта Imp в соответствующем запросе ставки | ||
price | Цена предложения, выраженная как CPM | ||
nurl | URL уведомление о выигрыше | Вызывается в случае выигрыша ставки | |
burl | URL биллинг-уведомление | Если партнер поддерживает burl, то для его включения необходимо обратиться к менеджеру. По умолчанию отсутствует | |
lurl | URL уведомление о проигрыше | Вызывается SSP, когда известно, что ставка была проиграна. Прежде чем включить передачу lurl, необходимо обсудить с менеджером Kadam реакции на коды. Возможные реакции: бан для tagid, site.domain, site.id, целиком для интеграции. | |
adomain | Домен рекламодателя для проверки списка блоков (например, "ford.com") | Это может быть массив для случая ротации креативов. Биржи могут установить, что разрешен только один домен | |
cat | IAB категория креатива | ||
adm | Средство передачи рекламной разметки в случае выигрыша ставки | ||
w | Ширина креатива в независимых от устройства пикселях | Используется по умолчанию при ответе баннером | |
h | Высота креатива в независимых от устройства пикселях | Используется по умолчанию при ответе баннером |
Примеры Bid Response
POPS
{
} |
PUSH
{
|
INPAGE (ON SITE PUSH)
{
|
NATIVE (TEASER)
{
} |
NATIVE APP
{
} |
BANNER
{
} |
BANNER APP
{
} |
VIDEO
{
} |
VIDEO APP
{
} |
XML интеграция
XML интеграция
Эта документация объясняет, как рекламодатели могут интегрировать свои платформы с Kadam, используя XML.
Bid Request/Response
Поддерживаемые типы рекламы:
- Native;
- Push;
- inpage (in site push);
- iOS calendar push;
- Pops.
XML Bid Request
XML Bid Request
Описание поддерживаемых параметров
Следующие объекты следует отправлять в GET параметрах запроса:
Параметр | Описание | Использование | Обязательный |
sid | endpoint ID | Уникализация потока в Kadam. Выдается Kadam | Обязательный |
skey | Ключ API | Выдается Kadam | |
ua | user agent | Для определения ос, устройства, браузера пользователя на стороне Kadam | Обязательный |
ip | IP-адрес пользователя | Для определения геолокации устройства пользователя на стороне Kadam | Обязательный либо IP, либо IPv6 |
uid | ID пользователя в системе SSP | Для уникализации пользователя | Обязательный |
limit | Ограничение количества креативов в ответе | Если лимит отсутствует в запросе и на блоке, считается как 1 по умолчанию | |
language | Основной язык браузера, кодировка ISO 3166-1 alpha-2 | Для определения языка браузера. Пример передачи: &language=ru-RU или &language=ru. Если параметр language не заполнен, заполнен некорректно или не передается, он считается "неопределенным", это снижает выкуп | |
subage / subage_dt / subage0 / subage_ts/ subage_ts_ms | Возраст подписки пользователя | Если параметр subage не заполнен, заполнен некорректно или не передается, он считается "неопределенным", это снижает выкуп. Для первого дня подписки ожидается: subage=1, subage0=0, subage_dt - фактическая дата подписки, subage_ts - фактическая дата подписки (секунды в unixtime), subage_ts_ms - фактическая дата подписки (миллисекунды в unixtime) | Обязательный для Push |
pid | ID паблишера | В параметре ожидается ID паблишера (сайта, вебмастера) на стороне SSP | Обязательный |
cat | IAB-категория домена | По умолчанию на меинстриме - IAB24, на адалте - IAB25-3 | Необязательный |
page | Домен страницы | Ожидается страница | Желательный |
format | Формат трафика | Cu, pops - для кликандера;
Native, teaser - для тизера; По умолчанию - push |
Обязательный |
Примеры 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 |
POPS
/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 |
INPAGE (ON SITE 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 &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
Описание поддерживаемых параметров (формат Bid Response может быть изменен по вашим требованиям, для этого обратитесь к нашему менеджеру)
result.listing
Параметр | Описание | Использование | Обязательный |
url | Ссылка для перехода по объявлению | ||
bid | Ставка | ||
pixel | Nurl | ||
image | Ссылка на изображение материала | ||
title | Заголовок объявления | ||
descr | Текст объявления | ||
site | URL сайта | ||
icon | Ссылка на иконку |
Примеры Bid Response:
PUSH
1. Icon содержит в себе nurl и icon, отдельный вызов pixel (nurl) не требуется
<result>
<result> |
2. С отдельным полем “pixel”
<result>
<result> |
POPS
<result>
<result> |
INPAGE (ON SITE PUSH)
<result>
<result> |
IOS CALENDAR PUSH
<result>
<result> |
NATIVE
<result>
<result> |