Sutikimas cross-origin iframe viduje: __tcfapiLocator ir __gppLocator modelis
Problema: sutikimas gyvena viršutiniame lange
CMP veikia jūsų puslapyje, aukščiausio lygio lange. Didelė jūsų reklamos dalis — ne. Rodomieji kūriniai, rich media, header bidding atvaizduokliai ir daugelis trečiųjų šalių valdiklių veikia iframe viduje, dažnai kitame origin. Cross-origin iframe esantis kodas negali tiesiogiai iškviesti tėvinio puslapio funkcijos, todėl negali tiesiog iškviesti __tcfapi ar __gpp ir perskaityti lankytojo pasirinkimo.
IAB sistemos tai sprendžia nedidele, gerai apibrėžta pranešimų konvencija. Jei kuriate reklamos produktus, įterpimus ar matavimo skriptus, veikiančius kadruose, arba derinate tokius veikiančius reklamos sluoksnius, verta tiksliai žinoti, kaip tai veikia.
Locator kadras
Šalia JavaScript API TCF CMP į aukščiausio lygio puslapį prideda tuščią, nematomą iframe, pavadintą __tcfapiLocator. GPP CMP tą patį daro su kadru, pavadintu __gppLocator. Šie kadrai neturi turinio. Jų vienintelis darbas — būti randamiems: bet kuris skriptas bet kuriame įdėtame kadre gali eiti aukštyn langų hierarchija ir patikrinti, ar kiekviename lygyje yra kadras tokiu pavadinimu.
Kadangi kadrų pavadinimai matomi tarp origin per window.frames, skriptas giliai įdėtame cross-origin iframe gali rasti langą, kuriame yra CMP, neturėdamas prieigos prie nieko kito tame puslapyje.
Kaip kadre esantis skriptas randa CMP
- Pradėkite nuo dabartinio lango. Jei __tcfapi egzistuoja lokaliai, naudokite jį tiesiogiai — skriptas nėra kadre arba kadras dalijasi CMP.
- Priešingu atveju eikite aukštyn ciklu: patikrinkite, ar dabartiniame lange yra kadras, pavadintas __tcfapiLocator; jei ne, pereikite prie window.parent ir tikrinkite vėl, sustodami ties aukščiausiu langu.
- Radus locator, jį talpinantis langas yra CMP langas. Bendravimas dabar vyksta per postMessage.
Kiekvieną prieigą apgaubkite try/catch, nes kai kurios naršyklės ar smėlio dėžės nustatymai išmeta išimtį pasiekiant cross-origin savybes, ir sustabdykite ciklą, kai window.parent lygus dabartiniam langui.
Pranešimo formatas
TCF atveju kadre esantis skriptas siunčia CMP langui pranešimą, kuriame yra objektas su savybe __tcfapiCall. Joje yra keturi laukai:
- command — pavyzdžiui, getTCData, ping ar addEventListener;
- parameter — bet koks komandos reikalingas argumentas arba null;
- version — API versija, TCF v2 atveju 2;
- callId — unikali reikšmė, sugeneruota kviečiančiojo.
CMP klauso šių pranešimų, vykdo komandą ir siunčia atgal objektą su savybe __tcfapiReturn, kurioje yra returnValue, success ir tas pats callId. Kviečiantysis laiko laukiančių callback žemėlapį pagal callId, klauso message įvykių ir kiekvieną grąžinimą perduoda tinkamam callback. GPP seka tuo pačiu modeliu su __gppCall ir __gppReturn.
Daugelis integracijų parašo mažą tarpinį sluoksnį: vietinę funkciją, pavadintą __tcfapi, kadro viduje, kuri išverčia kvietimus į pranešimus. Aukščiausio lygio langui parašytas kodas tada kadre veikia nepakitęs.
Įvykių klausytojai tarp kadrų
Per postMessage išsiųstas addEventListener kvietimas nėra vienkartinė užklausa. CMP išsiųs grąžinimo pranešimą kaskart, kai pasikeis sutikimo būsena, visus su tuo pačiu callId. Todėl jūsų dispatcher turi palikti tą callback užregistruotą, o ne ištrinti po pirmo atsakymo. Pamiršti tai yra klasikinė klaida: kadre esantis skriptas sutikimą perskaito vieną kartą ir niekada nepastebi vėlesnio atšaukimo.
Saugumo svarstymai
- Tikrinkite pranešimo formą. Ignoruokite bet kokį pranešimą, kuriame nėra tikėtos savybės, ir eilutinius payload nagrinėkite atsargiai, nes kai kurios implementacijos siunčia JSON eilutes, o ne objektus.
- Nepasitikėkite aklai. Bet kuris puslapis gali siųsti pranešimus į jūsų kadrą. Atsakymus traktuokite kaip sutikimo signalus, kuriuos reikia gerbti, o ne kaip autentifikuotus duomenis, ir niekada neleiskite jiems paleisti privilegijuotų veiksmų.
- Kur galite, naudokite konkrečius tikslinius origin. Kai CMP origin žinomas, siųskite jam, o ne visiems origin.
Kur modelis nepasiekia
Kai kurios reklamos aplinkos kūrinius izoliuoja griežčiau. SafeFrame konteineriai, smėlio dėžėje veikiantys iframe be reikiamų leidimų ir atskiruose dokumentuose atvaizduojami kūriniai gali negalėti perženkti kadrų medžio ar gauti pranešimų. Tokiais atvejais sutikimo signalą paprastai reikia perduoti aiškiai, pavyzdžiui, kaip reklamos užklausos parametrus arba reikšmes, kurias kūriniui perduoda ad serveris, tokias kaip parametrai gdpr ir gdpr_consent, kuriuos palaiko daug reklamos žymų.
Derinimo kontrolinis sąrašas
- Aukščiausio lygio lango DevTools skydelyje Elements patvirtinkite, kad locator kadrai egzistuoja.
- Perjunkite konsolės kontekstą į iframe ir patikrinkite, ar iš ten locator pasiekiamas.
- Registruokite gaunamus message įvykius abiejuose languose, kad patvirtintumėte, jog kvietimai ir grąžinimai teka.
- Pakeiskite sutikimą reklamjuostėje ir patikrinkite, ar kadruose esantys klausytojai gauna atnaujinimą.
- Testuokite su vėlai įkeltu CMP, kad įsitikintumėte, jog kadre esantis kodas bando iš naujo ar laukia, užuot iškart pasidavęs.
Pagrindinės išvados
- Cross-origin kadrai pasiekia CMP per __tcfapiLocator ir __gppLocator kadrus.
- Kvietimai ir grąžinimai naudoja postMessage su __tcfapiCall/__tcfapiReturn ar GPP atitikmenimis, susiejamais pagal callId.
- Palikite klausytojų callback užregistruotus, kad vėlesni sutikimo pakeitimai pasiektų.
- Tikrinkite kiekvieną pranešimą ir netraktuokite jo kaip patikimos įvesties.
- Kur kadrai visiškai izoliuoti, perduokite sutikimą aiškiai reklamos užklausoje.