Beacon types

Here is an example of an API response returning a Commerce Display ad unit:

{
  "status": "OK",
  "onLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=sdfn829dJSHcuis_fSDJKF78wHZ_SVwv_cfy0nSfkSFHFffYs65nds6nvdshf3Rs5_fdFRGzlWsjGIawBFDQswMswBhq7yK14eKmK4cNZAPnq0etO07G-53EGqVKmlCUIqFt_HLAE2h0KJZSn_d4ozkI900RUgu-L-97OWqk_mrnkpvN-eFxXG8CM19U4n4S1QChcpDyMg1_qrbjK8lvNsCyAYioy8D-YBwHbXlMDcljf1B7Vx9-pyh4m9CMuWDuVLOcjtZ3fJ3ls9_j1bD1eEG41oHOq4dO6DS3HuTaLRTPVDHkFP8ck_WxJYyo7OSO98AB98AqM1Ra_WG9WTeJ8xTVLxBu5hF9yVdBjnZbXAyhF88_Ktm0B74rTMkB7qkHBLRvsaZh2UTESdH7nD_wP2wnjVO-McJ0mDQUFiBUzPOljik0OJA61fsKSTES4AvHr4VEVdYMZSA09obJWFwbCUMweFhLdURgHrtHOXqSXbqXTZBDx1jGocZHEwqD5nsJMdqebDg0_CEg8HBqoCZLfQI6Yfw&ev=4",
  "placements": [
    {
      "viewHome_API_desktop-Flagship": [
        {
          "format": "FS",
          "products": [
            {
              "ProductId": "16823",
              "ParentSKU": "16823",
              "OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=QsXdZsmn8ymw-ZAyoPB7JotDztSi_0h8ukCql_43BN14xQI0N4K965e1ZNo-tbt57lI78UI_MtKxer7GC5FeX08sJ1nUHXbjEIMA6_dUuO5PA-8RjllhHyX2KQfnsf75aMWwjiHRjwPLCxABBToVaBbkbLfowCECV59opCCaIQrc5YqrmzlX2PfC9vwEnI5kV8D8xAzQm7fpjaJQDx5boDFNxO_-F4iHw8Wn-hhWwNpk4A-f_v0CbonMh5Y6BdqlR17Ifya79Shdiwqqnkymbrafif72JStptOVo5cWhttQTw7EyQ8XVKaobUz6IwK1dxWrVdBNmrNcm8WYERKUpndEW160cdbECv9CRV2tXjiLPEDUW-2cGQlAfbSGJQGEzukBHzsRLVM0_iyZsalNJHg&ev=4",
              "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=s4MUgb0p2qiOW6OXiDQ9tl3s-sHHnt2WXqEoCFO8R3FKGSf3dJWtjvWJEO7oKG19T75RS1_tbsMbbQCZmgXk29dnbhUX1BJOFSzGWXdpHb3Cvj_qbatHmoLwpWIpki6xbLOPpdjwesx9gx3WSrajV0KwNtGRCWlILLZMBTSBiBzXrbnR0pmTkyJwdxHN-xR70VuGcOCWXcoDxFcgXs2x7mjF7Bwo8Rv7ncoIDJuh1rSGX_eUE_2fu5s1COjtAtjOF9IpByRHiUzfTBkOoLLNMlCo6CrLo3cksFuFvJ93xiMx3oGp2g-WPejLjeIlBuYP_3Ps6tkScZNxUz1I8YwSqgeLWUmvyV0DnAKZH-JcXGhn7Rd2R2FClEFuXoBYtrFj1LTlhf_q9_KMBgQ3NvH4uQ&ev=4",
              "OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=IZWg4EkEK2twk5A7D_FAZVTkQxrW_ZFxNplIQ6Bmm5D_XAvAlG6HlVf-rJGM0cc20c_yhL-uslQy9FlYrfiD-U7iN0q9ldQKcxiKGu36ld2oFSR3uS87hWKeOz27ZMUChe8wack-2c0_zcRnyKhzmD-T0E-87RgHDBMNewjwnbNQLbjRpI7Ho6ox7Hsjp4Pb389yx3uDTNJ4rX8P_K3IhmgVpqCUH_h7DmntcCIATWySeiJECSBIizJ_MUSyzDdb88Fbj0frlauQ5J6vjhO32igX_HmfCtolAOuKVTQMJK5z4C_ZWlEDtXNR2rYdC6nCMBYh7gcbR-XQJZBsn3K9slOS67lQJ5Y8LsCtuAyxqPkonbjuF7vKMQdqXI-ukbuscGoVFz030rvZbabkjs6AQQ&ev=4",
              "OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=84B7sn1OYECasc1VjXL4JFN1RFip8yb42Dt90z7yfYSFQ5cKQhvDw9-KEFdvsSrmaZbxrW24g1xK24fQDXRm5vqlRpQ84UbJ1Voua3k3K0DhhlpLvUZf8MCcY7G8R4J-8l1Thhy9vAgaQ9Reh2l_pKtn0G9yobBXdzdG5b_ZM6CuF7a4c2fwvZoo-oFtZisOQq2yw2D0O0leQYlofB74IsGCoo_x2vpUL5xlPtA4GvBK9LURx9waJZ9bSC1VScEd5yJDPGw0cAGHlZJ67IwybQTi36v23TGej0cEimkaEAZeE6HsR4a-w1ALeVFzNl_uaHwDYx9pqhG3vIHzwbBG8nbBy8gQTI7fLA6NZBZMmLchZBW2ZBv8PzkkndgxAP5_RWZNYRp8HSdqHnL6vM9j0A&ev=4",
              "OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=p-qo5UOTqS4wf7Xr1RzsVOdHHhtWkTjtnyS7LFTEVS7gzTgX1yp4AkZzq4ABrxS_-n3CvbV7MEflqu8jW7lHyftktBXZj4736aIGbBvQQK8zss9Pcvb44_tuPWaUO6K6XxEGo72DhlU9SVxL5ggENsS5x8RcRVxL20B4na9cJrbZ_PGXyVyBLrdmmkdn29ToWhDWpdSxA0op5nk8c9UU0IVgpWC3ZOepgB2toTH9AyIZi1zcwxEutGpQ2ptLrS0hVSyVxPWIWFsLr6F49fWje0rB-klFEjPjPj6D9zMgdT3I89UQL8Jaim0q_C_vqgOO3FG5ecwigCvS-j3kDWEThDlOVYg9QTUlupSrtP9T3K1Zdl0I4RQeP2s5oF9L7GdvX73_K7Zeb_5DZqCOEpfFqw&ev=4"
            },
            {
              "ProductId": "19494",
              "ParentSKU": "19494",
              "OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=BN_gK-f37PyfgYjOzzGJ-n_zBfXG6R7uh8_1dWWggfz_RPiKweR-HHP6-mLGDYuRmnT99Di5vWvwhi7RATE7cheBD9gGOWxwvB7WSCrPbMfrCOCKKmWfinrNluiYn0Z6WP7FOw4pkC7JJw1TCL3auxkjCWUBB743qsW8DbtAL-zo1QCNWtVlG2wSDIOnPNXPnB6qLvdJOSXtce8RPMiWb4x2Opkrp0Ai4Ku2n3oWE0KnbGyJOI4STAl4jl0uhezUO7tSsrruHeGvfFo1Uo5QYqFmRU_-yM9eghfKAtRWm8qSui7hHfuDt5_qyhMunvaTqiirEVeXppIFf4_3E9CRJPRmjAjh4KO4trCAcUOAy8c-2BMKr2Z-iSj7a6hO8ZA9cqxqPSkvZ3HxvxItciagNw&ev=4",
              "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=y5-OVUh7SAs63ua-tXWrE-hKBle8TbRjb7ITYuhBBqSTmkBxrXnxnPmHXVAby_gDc5aCqM3rF66tJY5CzFAxdIPOU9hujzb22R6nC5s4BNOmZHySBOwv-Omfsj02E1_vyAmov2TmeZofRM_ixmc7Gb-9vnD-Nya8Jus1kOLcoMF_wSDrMSlHxOpm6-fnqVEpEgnPkW4gPokouZC-bL-UPKxQM8SxsNCeaJimBcu2Pund-1SkkkK95O-qq4kboHjwnfmIijOHtFe0Xfsjsqscxy2Akz860toeZn-KISs8YBrOJBUdm82c1bHrZ5LB7NPR1iDOtzwe2ef_at96hCHoyrh-4e0v2o2jGqaoUG-E_ITG_Z2j01xs00dMqyKoPn4VEp7AzvO_ogH3sosgrBwnBg&ev=4",
              "OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=GR3fsa56mrEr8_rFee3jXYX46r69EHtPMAhvltFZM3TrjpzouRWR4ZOgWCegEKcH0C-wfg7JBqJEpDoxsTpPhvlm7stXwjqYgSItt95pkeuie8YEqLgGJGBeY-ljC8sO4JKbMjtY3eMrR8Esw7zM1paZGzYUpple4AAfTdbT1L03tLKgfz4dFcGO9_Q91smQvneqseV8qmUjcbkroMcC8-0NNPWRzPT6QnucQlsBZuiFgDvTrpUrvbwgS41hh8KW1anp5FFqFHyL2jSM0lH0lHahdo4hxxJyWOoIceGSNfGE0-nwMHmvmqeqszbmgrMfz_C5fpSsa_M8fOVBg-7g3iZcGTFDZ33WgTQnqt7VCfV1xRwUVvBSrg3klW0wgeNDrSuEJzCtlkv8pV3pupD2-Q&ev=4",
              "OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=Bvr2njkxIMlNUUbyH6ubRMJqIgw6p7mQjYr7z3tr3W1elo-OkTojl7W6yJUkRb14EiWFtJG8Jo8OeUhy-ArRym5HceeaM-vRFpFOv7weYyYe565sLG5bQBdZhXHJASWBVXobBZ4PCxniZVp-JNpCB2aU-btujaeNfeayNwtHpV24p-SkxauLgOXRy_FIlSjmZkJkGIRukzRMwxWKh55W43LxVr-2uVtOqq6Tg8QLJOneRks0noLnlOST-l2hHMJxJqK-AModUnuY5T8sn3s6x6epRtRMfDoi5MOkJooju16qurFbT6qyGNFSb_hMf82IfdA86pjRpeWJ9DBC3UAZF_bhgTZVjnX1qwHVF_GR3i-kRbNHt30BvZFMJwjO09BqMVx8bZKZaOR5iHMbHIkogA&ev=4",
              "OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=jMoh1dvUxY5LlNEdfXlGZmXRCxi5QSVhFfgptMG1pGyeAYbZ2jvsYVhDqTrFvbLIM7kHi2y1RHXzmNPfHvZifBQpW9sh26BRsuVLdljLruxfxZT_Wtyi4D1KcCA3A09vz4mCIm1MuzHlXTPN-y7oTJqPajjzkeSJSDQFbX-hYEANVbIKhjPET7udRb8R34MtYZQFuqgOuWpCXqPh0JdQSDX9DuLewmI3ZfznR9IeWAwCPMZjiVAZ8KPR6Gy-SsaoLumggq-ikAj3svtK419b47u2ukbW_5S4pZeaq8glbE6nNLpUQdt5k9Drp9echMVY2Y6YkYlvHipFlLqdmrEjKYQ6_oEVVIooxSUt97nUfeQE653nmSN9RlHDfCw8AaaEjaiINAd82jyoMbOD9BezBg&ev=4"
            },
            {
              "ProductId": "15742",
              "ParentSKU": "15742",
              "OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=XjYI_CHw2MrAK4ghgIwJ3Z-DI5SysXYoIb7BRgiYdZcLg_SFvE-zbgguqtkD-jSzspd922QHs4R3UPDRxixLH0w9Xy-2SEwq9LLhR0VTZGbnI9-pX8hNDyx8wV-AkbHRH3G5DF11ib1fX3F0FOw5c0JRN3rrGqMDukAneIN0j9jb3Hoc9zJwtojkktzS_5TgXL_zsh28qUz4ZtrspPJRZ47kuC-f2wUGtbHoxRIKbvCvvppWjT0_sx6CuL7oYoSPQ9B_pKHjPEaY0POS57ci-zAIoeyuS5QKDnrdKls8g1y2BaTVSRcW9pk2BOdEP689GYZQTy9oZisachqXR_pEIZ0YeYa3g8-Ygp_p3tnNaDiFgpdzdFdCCVF3w2n0CKWtszqMmFqJnmXZP1342v-zWg&ev=4",
              "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=nA2BvAMRGhTnq4v2AWuk3BNlPZna1pHKObORJAkN7oW6vUC_e70WtzBFKV40CyiVAX_Dl8i38Bouu9GWQambqmxwZDQgcrWgHE7AOTGMr229QTu9ZpkAAJiuvLLgLp1BdieXDoQUH7Mr5tj_JNcD8ufIW3V6qBEXsg_FB8rzmTbwaQ8Pzx5E0ukEYUUqVHBZmqS7jZqo0jfmihYR9X6U0_ayKed1mps5qHH8k9MeF6T_bMCZt7aN9ipLLPxRPOmgt-852ZDiaixUr-f0qFxFs9XobID5y5mO7TJX2dKjQjVyTeoxSfXkjdQN8JX5SYwuDtl_8k4qExzr6zZ1oL5acfimqVPrixtdBWP3DKILdDwumWp31ZdPxTq9JPbNUyE919WZLeoblsCk8Kcp5t2eYw&ev=4",
              "OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=NhGtK-T_dijg2M8c4LyLStkPbVv7l1C525iJEsTLvLaooegslXLpxbwPoIeWSfy9U2Re1Zd-l_K8UjsfBvHe6aizQ7UQsZ562DLuXGFebWcMflPhmLZ3Fy_LIH1plFbg9KmOYHhCDyeioUvBdZhqZSOeYper5LOOKP57Ld4QMh-fCtWzv0ScZpM8oWMDJMVLTF1SuT2bLFs9ZRfmNCNnu6obAecVxvv31Iod7010gme-pnvA4gImYh1rCIVZ95ISx0FmjVVw-Im5fVbjgKF2p4m8q-DPM8cpS_LvS6stnoOPi2DLDb-TM07sS4GyzB0KGIfKkMeaVBOSNvTYY4JeSJ6qGASrd2osYVFgW3l1jfB7oqkyPpRjkTCh-V4gc7xjPD01sNmqL9BOM9-jWrOO3Q&ev=4",
              "OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=65vo05e5FJF5RdRTgEI508JGOmZzDY2210JZqqjV1L20AgkC6dXSadUc6VrIOpxvs0_kzeBSNfJgwKlRoiqbuBGWKIAFnfLm3d5vSzefbV_ZSddTOsb-ZX6yNf8oxxo2EIur4BM_nu8Mu_eh4UsLK1Mq1AeEmvQ6ZJEDf9Yz4l2ouG2JrQf2NW-lyO5SI9vyKuA3SNx2S2Sf_pRP4cbGuGpfRQXxHLV_K1VXoMpJW9reKlzQv8_u7A6XdEgyX3GwVM4AITNMA6PbNsKKQdTER3ywdDyydPiAdA7jg9UOMP098RYzYi43XZPpLbLyOxvaqdKVLYyq8UBME6E6Wr7eC267SQiJn8r-jqffU6iUfH4WgUMRtOQwfbx0hGH4yJJu8y0v5JAxwxAld5VwEfP30Q&ev=4",
              "OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=RbrsRpZFm59CHAoMg0iamPzWIAOB-61izO9f1XjyUSq5GuyvZLEhy1sc7r9qWO1WWT-eZIgPp46p6J56FEodBIbdnKL844tC0f-i3pKSz26rsL1kIepzVOtAMgm_1UCCc1q2iFXeRSIPmgS1IejfR6ToEtRgylUhxjJWBEAzA1wOtSFAbOX6j3YbtqjLMRsaxgKdvSPC2h_agZ8v5JoC5zpL70crF5JhLdojd42VCzv9STkVcISbDvCovbveL92KA_GfB-NDt4mIN8_NHHZeM2_szqLeVdbv82A759STYaSZD0AzA4OFcYnGtBYplYgxK8pqgJMYPZ9yob_las_A9AHE-AUkJYKoRZDvlETUHon0p8TlYQXkpDqnVP_maU6BIpUMmmfe5NJzdwk9pSrPJQ&ev=4"
            }
          ],
          "products_order": [
            {
              "products": [
                "16823"
              ],
              "isMandatory": false
            },
            {
              "products": [
                "19494"
              ],
              "isMandatory": false
            },
            {
              "products": [
                "15742"
              ],
              "isMandatory": false
            }
          ],
          "rendering": {
            "desktop_background_image": "//retailmedia-static.azureedge.net/creativeassets-live/d6bfdeefc36e382e53befaeed8d1dc53f07110131a75b275c48fdbf279f4e853.jpg",
            "desktop_background_image_alt_text": "",
            "mobile_background_image": "//retailmedia-static.azureedge.net/creativeassets-live/71a4499cd0f16fe4f1ecd475b7b90e63188f45b212e1cce3bd1aae5a148e34d9.jpg",
            "mobile_background_image_alt_text": "",
            "optional_footer_type": "file",
            "optional_footer_redirect_url": "www.criteo.com",
            "optional_footer_redirect_target": "_blank",
            "optional_footer_redirect_url_app": "www.criteo.com",
            "optional_footer_media_file": "//retailmedia-static.azureedge.net/creativeassets-live/4ba277a9762360ac4ca6f933d522da5bfb7a7937c3491e3887291e994e512005.pdf",
            "border_color": "#CCCCCC"
          },
          "OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=kwp2GQrVizyjE_f5R4AKDxHZ_SVwv_cfy0nnuxGkZI4uv3YzfiEKFcBm3Rs5_fdFRGzlWsjGIawBFDQswMswBhq7yK14eKmK4cNZAPnq0etO07G-53EGqVKmlCUIqFt_HLAE2h0KJZSn_d4ozkI900RUgu-L-97OWqk_mrnkpvN-eFxXG8CM19U4n4S1QChcpDyMg1_qrbjK8lvNsCyAYioy8D-YBwHbXlMDcljf1B7Vx9-pyh4m9CMuWDuVLOcjtZ3fJ3ls9_j1bD1eEG41oHOq4dO6DS3HuTaLRTPVDHkFP8ck_WxJYyo7OSO98AB98AqM1Ra_WG9WTeJ8xTVLxBu5hF9yVdBjnZbXAyhF88_Ktm0B74rTMkB7qkHBLRvsaZh2UTESdH7nD_wP2wnjVO-McJ0mDQUFiBUzPOljik0OJA61fsKSTES4AvHr4VEVdYMZSA09obJWFwbCUMweFhLdURgHrtHOXqSXbqXTZBDx1jGocZHEwqD5nsJMdqebDg0_CEg8HBqoCZLfQI6Yfw&ev=4",
          "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=qrL1X0gCc0_99xluW-KXwEkCluMc7SLNbBgcDjm5todnq1SSYEcQOpthqyD69N3LbepzaFyoER1z3e7K0Y0Uv7c1fXuvlYMEkdn4Q-dx7wjkFHO_DsQwNSkSJTCk_6DKNjyksXYnzyKmuEP2AUuhfFeMPSfdtR_ogYx3YIxI4lej2XBnHXw7CH-6aS0UvfPItwL2CoTCwKmQIkQyRmp6PKCPe9di9n1YmlaQJ_o_y6MMwOC89kH6LYgNtWlIzkEa5NBzoAI41pgLJ5V1E4zqh6TKbWkQnHuEZWZE6HWtuxF7zj4zFfKXsWtOh8uGKiy-PkWbVS6n3ziq-x8Y6Z6bhbCs2DVu61eIsVLi9N-7lBwJvZRyk72tRHoSLQefIZ4teQsey0f8LoBixDIDvDFLMqtNT6UtF0kAdvVf1sGBnIGdYOskJmBpun_-5AxQ7JYYEKY8UgCuHRzuStz5kYAj6Q&ev=4",
          "OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=SufwIvPHzAmyrws2Pgfyn0bOJ6OnniYbQfms_juqg1zhFOP8_X3Xpm1lZJC6O88f4c-jZg7RWVr4cYTOtb2-bZFwabzexJlZTOft3sHibcR0uMRdSzGrPpL0bl9zg6nH0zEo0BP_hVrLTgI8jNesN9RTeuEhSWdnKOcuO-p-rVwzyxmWlh-OmeQ_di2GrQsWIa8SOcnIiJnhTtDerJp4lYF3DHqA08xh0WqQO3y431Y0cAgYSFjQX-GCA57zd36gJ1C_-T2TlDtiaH0LA1vVJplIa6c3OgbDUJuJlSfW3947jn2gRHQMoDDxWyuTKR1A3QBKpSlxF9hpqc1FA6n_8Wk7_DOr001RLLVrnjSOmWPKLqkrFiu_BN9RR8rymj7bvV1wD2vXjrBY_hI8V-LiSQ&ev=4",
          "OnFileClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=sloVjDHD68JAycBoAJGWQyFIP0DqMYoAFJSP31JQMX-u2zibhPNIgYJyzM8jtfZSVWvTguYgX_L1liSpZKPDs5IFswQ65p8x6fY7r4SqOXke00gRuROKj9aEPXRTHLYyKUHX8giA0ensbt3KM-v4qMvJZoOKVBv2_27zEAhrPt4Zz6V0Y4kRTqJRaXXvSY5IyDvm2Vj-yGYY1-es5XNN_4K5rAXRYZZJn0n9nOwXe17MepTt5MXMqwrhot37Fcjbu5ww_HkGvFQMTTB3MCgEnEnMcyxYzHUV3nC0jJr5X42-8ny3baUynPFUnuKwSfzSGQL5_5PoOr5aIZnnzzbLCMbbzcn1AgLbSpsskwxnxdtt9-TZ1IUfCGQpWw4cB0Eb7Kax5CWgZbvYj1__gqZkJvwK47N_ebBHVS9XuqWNVVY&ev=4",
          "OnBundleBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=6VUW1JJpcvC_2wJVOVs98zWwE58TE9NI_wWrdaOcnG6_HeWHFLog-1xP5F2v_zpXjCcrN6M7-PvXziHAb4BVZ5f7Tg7Rt-jhO7IkPhWVjrXE78djmHEhmgdUt9gFsFj4_4B_rYL5ZRa3QdlHns6BMntz39iElN0GnaTidmVd9aSWYM0Mw0DhT1DfvEisOsu4Dp87VFwJCRXqQB9J7tLlIEnf_m3KFvXdjImQ2x0yDUzAkVPwY_Ley-Vs3iSioioVl74xuW6rz9q2rDUCSC-B1TQETO3VmZd23H2BjrI5bF9IIShOiQG0SMtsYjHvFimInAJ9gmSbZLPi0QhopALOixXc79OJH7HbRv3DyF2ThXQX-A4F1dgXHjkk3IxY2fef803yG_Hdkbdw_UJ-rg__HQ&ev=4"
        }
      ]
    }
  ],
  "page-uid": "954ae0b4-c0c4-4898-9c18-bdd154eb9353"
}

beacons are categorized into three levels:

page,
placement,
product.

Each level has specific beacons that serve different purposes. In the sections below, we offer a detailed breakdown of each level, based on the example API response provided earlier.

Page-level beacons

OnLoadBeacon
- Description: This beacon is triggered automatically by the delivery service when the page loads. It doesn't appear in the response unless the parameter nolog=1 is used in the API call.
- Example: "OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=sdfn829dJSHcuis_fSDJKF78wHZ_SVwv_cfy0nSfkSFHFffYs65nds6nvdshf3Rs5_fdFRGzlWsjGIawBFDQswMswBhq7yK14eKmK4cNZAPnq0etO07G-53EGqVKmlCUIqFt_HLAE2h0KJZSn_d4ozkI900RUgu-L-97OWqk_mrnkpvN-eFxXG8CM19U4n4S1QChcpDyMg1_qrbjK8lvNsCyAYioy8D-YBwHbXlMDcljf1B7Vx9-pyh4m9CMuWDuVLOcjtZ3fJ3ls9_j1bD1eEG41oHOq4dO6DS3HuTaLRTPVDHkFP8ck_WxJYyo7OSO98AB98AqM1Ra_WG9WTeJ8xTVLxBu5hF9yVdBjnZbXAyhF88_Ktm0B74rTMkB7qkHBLRvsaZh2UTESdH7nD_wP2wnjVO-McJ0mDQUFiBUzPOljik0OJA61fsKSTES4AvHr4VEVdYMZSA09obJWFwbCUMweFhLdURgHrtHOXqSXbqXTZBDx1jGocZHEwqD5nsJMdqebDg0_CEg8HBqoCZLfQI6Yfw&ev=4",

Placement-level beacons

Placement-level beacons are associated with the entire ad placement and not with individual products. These beacons are part of each "placement" object in the API response.

OnLoadBeacon
- Description: URL to be called when the whole placement is loaded onto the page. For display ads, the placement is considered "loaded" when the entire unit is rendered. For sponsored products, the placement is considered "loaded" when at least one product is rendered.
- Example above: "OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=kwp2GQrVizyjE_f5R4AKD..."
OnViewBeacon
- Description: URL to be called when the placement is viewed according to IAB's viewable ad impression measurement guidelines. At least 50% of the placement must be in the user's viewport for at least 1 uninterrupted second.
- Example above: "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=qrL1X0gCc0_99xluW-KXwE..."
OnClickBeacon (for Commerce display ads only)
- Description: URL to be called when the user clicks on the placement itself. Typically used for commerce display ads when there is a click on the ad's image or a CTA button.
- Example above: "OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=SufwIvPHzAmyrws2Pgfyn0..."
OnFileClickBeacon (for Commerce display ads only)
- Description: URL to be called when a click is made by the user on a CTA button, or from the creative image of the format, which leads to a file download.
- Example above: "OnFileClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=sloVjDHD68JAycBo..."
OnBundleBasketChangeBeacon (for Commerce display ads only)
- Description: URL to be called when a click is made by the user on a button or image that changes the content of the cart / basket.
- Example above: "OnBundleBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=6VUW1JJpc..."

Product-level beacons

Product-level beacons are tied to individual product tiles within a placement.

These beacons are part of each product object in the "products" array.

OnLoadBeacon
- Description: URL to be called when the individual product tile is loaded onto the page.
- Example above: "OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=QsXdZsmn8ymw-ZAyoPB7Jo..."
OnViewBeacon
- Description: URL to be called when the individual product tile is viewed according to IAB's viewable ad impression measurement guidelines. At least 50% of the product tile must be in the user's viewport for at least 1 uninterrupted second.
- Example: "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=s4MUgb0p2qiOW6OXiDQ9t..."
OnClickBeacon
- Description: URL to be called when the individual product tile is clicked.
- Example: "OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=IZWg4EkEK2twk5A7..."
OnBasketChangeBeacon
- Description: URL to be called when a product is added to or removed from the basket/cart. You can add the quantity of products as a query string parameter. If no quantity parameter is provided, it defaults to 1.
- Example: "OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=84B7sn1OYECasc1VjXL4...&quantity=2"
OnWishlistBeacon
- Description: URL to be called when the product is added to the wishlist/favorites.
- Example: "OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=p-qo5UOTqS4wf7Xr1Rz..."

The `ProductPage` URL

Full verbosity example

If you set the API verbosity level to full, one of the elements inside the product object is the ProductPage beacon.

{
  "ProductName": "Product 16823",
  "ProductId": "16823",
  "ProductPage": "//b.us5.us.criteo.com/rm?dest=https%3a%2f%2ftilt-dummy-retailer.preprod.crto.in%2fpdp%2f%3fid%3d16823&sig=1-OxTyYEct2uXeVQw334Q7rhli3hjJSfL-t1eGN0YS-2A&rm_e=py_i7Fvf9NcUbDh90rX9skAusPDfZede0ZUdFZ6QUQkRrOfgtDMmZccT040Ih2cKy_JKLK25Pz0ZqEon6zdvktSK6OlK9VzZ7OsU-dQG5tpzZ7H7ePflJYN1kvvbdvZqJ8L_HsksaQFXlt23mmL9mPun9lehTTbMmUopYwL2_9zs4GhWaZ4K0B3YaPWmSTgr7V3maueJ0Jagj8uIF5rLRmX1vkmq-8oJPO_T_oH4jOEU-s9sNlXENY9TYvlB4msCUmZ3k5r6HFJNhDDcQNO3MOPeWz0h-Ec0d78e7ysUcakDhuKB8wVATzvGhYxLHbwITw1sSc033bI24FQqh0a8TRYbn8SpteIEf7cgHhGauwdTX-VvCDfq1yUmg2HP3-LQWGYGAVv4-OF1uuMHzvQy8w&ev=4",
  "Image": "https://static.criteo.net/images/dummyretailer/glob_prod_img.png",
  "Rating": "-1",
  "Price": "69.00",
  "ComparePrice": "69.00",
  "Shipping": "0",
  "ParentSKU": "16823",
  "ClientAdvertiserId": "1205",
  "AdvertiserId": "17902833",
  "RenderingAttributes": "{\"brand\":\"retailer brand 1\",\"issellersku\":\"0\",\"mapViolation\":\"0\",\"numberOfReviews\":\"0\",\"promolabel\":\"Promo Badage blackFriday\",\"rating\":\"2\",\"shippingCost\":\"0\",\"taxonomy_text\":\"fresh foods>fruits>bananas\"}",
  "OnLoadBeacon": "//b.us5.us.criteo.com/rm?rm_e=nmqUBUCWzIFIRUl4gGX3E3gNgRMgazdfwChH0gN-qn4OpGbCJscSvaeN5HWT11vYoCMfXz0hVyf4acAt9KtrXXXk09Hs8nu-mCAuK-7jVe2TpRuP4ovQnSoomrFMwMaTky91eqHyXVAWMvQMJy9_Zm8qQLR6QLhGk98gIvj3WLI0VborYltJSR3jYaJCXfSPqmnTgbCklmRVs7KZAm1pgFBl8ySq1r84yCUH94T5UGiCr5-ScFKbxyoxiU0IcbiddZ-S5ux5BM845FnPvYuHwNwYvtlgV93reZglBK8ydkSLn1-70AGkv5Q-1BRHUj_ZpX6UhShoyttNn96Uy6Cb_vlfl2YzDLuUHITr-tBDyLDqIOKkyYMO_PKySUV1V69MCx3dEY9-noA4WwHpkEaXqg&ev=4",
  "OnViewBeacon": "//b.us5.us.criteo.com/rm?rm_e=kbWFHfXccAVy8dBa7E40XU6Ry3ya2U2IwmY0h1z5FMerZ4N512AaFn42gjuaGfwUvbe_K_uFHRYmUVdwR4SfGOTEjFgBpUOzfpw1WhWp2x6KMkolMZXFW_GjzZvHeh5Xu8GmAs93D_Opzk-YBVZef8XWDfTCQ88u76zm_ZtjdFXg-l5h53co0vXLpXdzR20WsULowjqz-hzSOu2FDprK1YKDZ728cVuEGFB-AZXObOtqwvdBa54HF8XTrWyDxTMZ756pvRUCfge05Zn-so9V6czazd1mrjP41kdbV8dnslxrVmXTgGPl-wIroD0LE-_DgfZDIMaBZmvpPI0Cmj7DH_ZUCQ45dnpiBSuUCrkRmUPoPQIaiy1jeCbn78Ai-nd2dicod9aPSyO8hwgLZR84Sg&ev=4",
  "OnClickBeacon": "//b.us5.us.criteo.com/rm?rm_e=QHQUdPbNSF7QFiR_aUBCJoABsQVbNfuBt0vVPOh5N8xpTlj2Ck7Wb0XB9MzsC8qacKG-46ByJHzMlpaN1908tbr1SX0MBAzfMYr4mrwE092H2_WqbGO39IqJMYCNRNxga3ZuQswA3R2lzNQN6-uMhlvnibm3j5DvnxM2s29ddDoCZRrsJVxj2GMQnoJ9VBnfptvhQdtkYjbqMdQa2OZKBj2ru6kRV9Xuvbijc5V26cK_pO90HiQ1Qq2vV5h_Aw-5wu6RkM88j4cV2REPc-6iEk81FmWNLkAN0kjaj_77o2Z8PKQXjNSgcj8wLAP6wEbKZA1CtJHW3UDZxmB7u7BZtidNhqTX31kZPxHdPuH8_avS4GDrGIO-jOB_hVOkuG-ZMhw23G8fewf7GsJFxQi6SA&ev=4",
  "OnBasketChangeBeacon": "//b.us5.us.criteo.com/rm?rm_e=tdIbhIcQX52KhXORFbHrW1DGerUFacDzjxrohu_JSbtsPO4qHGc6xWoNaSFtbdeskPhjexkKB7N6lAZOfNW8P13o2c_ke6X7sFgk1VArEB1qXrO3vXm1l0pC9PtC9-6jyVymLEu1qYznnDe3YvcaT-V8-0Q_lbnHrdLjfLtzoFoBL7oPnesi_Xv2b36I__vTVaceYkoOHJ0YM7jEB2AGq_js3eVY0CuOi4SQHjhq65bP6gtu_ojGeuGU0YFg6voaJ5iyCjN4EHusmUeXUwy47Bt-7XwX54toHdQ0Pm0T8bSnWgOaFdi_OqFC36hgn6lJ1mKHStJIgmohNd2AqVzaJNpmz8dpbzSl_C7P1lNKXCdP1h_n-Q0aVD0mFvTS33tmGSl2gpx5veSpRGTn6l6frQ&ev=4",
  "OnWishlistBeacon": "//b.us5.us.criteo.com/rm?rm_e=wCMwOO2JRcfkQ0SkCcDatHTQbYvSOFCbBAfhSe44328v0lvaYbDuGFrHVWCffJamgEej6RS-FLfFln_fSOOkJJTHdP9Aul267shyfnWakfwyvDHFx-N02tbIoZ1nYHHov_qrSczzfWhqQvqypYIqBXDy3eylU00zOAQ4HvO-rB5uvVTp97O4NdW5aZYT_-N6EfY-CaJ1Q7NONIg4mZzqHu-AuDTtQkNWqOLSfSctefP6tac5NYW-UVzJxf15j5GZY08hGiMzfR37oizL4iNjCX8tUZ5zBxNDXK3VIAcWo5pCDeVqtTIEZvcfc8mNvsvIDmf0BeHqVbbpmD-cZQhWuvs_dUZ2GDaEifhMEi-j7rfvJBgEx0L0LeS7Yp-OGuJZTIAD0BvfbG2Pogo4_r9kcg&ev=4"
}

This element is a URL that will:

Send an OnClickBeacon beacon to Criteo,
Redirect the shopper to the item's product page (pulled from the product feed ).

It is possible to use this as the href value for the sponsored product as a way to track clicks instead of calling the OnClickBeaconURL.

Deduplication

⚠️
All Criteo beacons should be fired only once, apart from product-level click events (OnClick, OnBasketChange, OnWishlist) which can take place multiple times.
Criteo will deduplicate all billable events internally, so if a user performs multiple click actions (adds to wishlist, adds to cart, increments their cart, then clicks through to the PDP) each one should trigger a corresponding click beacon.

Billable events include:

For CPC units (Sponsored products ads):
- ProductPage
- OnClick
- OnBasketChange
- OnWishlist
For CPM units (Display banners ads):
- placement-level onLoad
- This event can only take place once.

Page-level beacons

Placement-level beacons

Product-level beacons

The ProductPage URL

Full verbosity example

Deduplication

⚠️

The `ProductPage` URL