setConsent
Kommandot setConsent talar om för Web SDK om det ska skicka data (opt in), ta bort data (opt out) eller använda defaultConsent (samtycke okänt).
Web SDK stöder följande standarder:
-
Adobe-standard: Både 1.0- och 2.0-standarder stöds.
-
IAB Transparency & Consent Framework: Om du använder den här standarden uppdateras besökarens kundprofil i realtid med medgivandeinformationen om implementeringen är korrekt konfigurerad:
- Det enskilda XDM-profilschemat innehåller fältgruppen IAB TCF 2.0-samtycke.
- Experience Event-schemat innehåller fältgruppen IAB TCF 2.0-samtycke.
- Du inkluderar IAB-medgivandeinformationen i händelsen XDM-objekt. Web SDK inkluderar inte information om samtycke automatiskt när händelsedata skickas.
När du har använt det här kommandot skriver Web SDK användarens inställningar till en cookie. Nästa gång användaren läser in webbplatsen i webbläsaren hämtar SDK dessa beständiga inställningar för att avgöra om händelser kan skickas till Adobe.
Adobe rekommenderar att du lagrar medgivandedialogrutor separat från Web SDK-medgivanden. SDK på webben erbjuder inget sätt att få samtycke. Om du vill vara säker på att användarinställningarna är synkroniserade med SDK kan du anropa kommandot setConsent vid varje sidinläsning. Web SDK gör bara ett serveranrop när medgivandet ändras.
Överväganden om identitetssynkronisering identity-considerations
Kommandot setConsent använder bara ECID från identitetskartan eftersom kommandot används på enhetsnivå. Andra identiteter från identitetskartan beaktas inte av kommandot setConsent.
Använder defaultConsent tillsammans med setConsent using-consent
Web SDK har två extra konfigurationskommandon för samtycke:
defaultConsent: Det här kommandot är avsett att fånga upp medgivandepreferenser för Adobe-kunder med hjälp av Web SDK.setConsent: Det här kommandot är avsett att fånga upp webbplatsbesökarnas medgivandeinställningar.
När de används tillsammans kan de här inställningarna leda till olika resultat för datainsamling och cookie-inställning, beroende på deras konfigurerade värden.
Se tabellen nedan för att förstå när datainsamling sker och när cookies ställs in, baserat på inställningar för samtycke.
defaultConsentsetConsentinininoutinpendinginpendingoutpendingoutinoutoutoutFöljande cookies anges när medgivandekonfigurationen tillåter:
AMCV_###@AdobeOrgidMigrationEnabled är aktiverat. Det är till hjälp vid övergång till Web SDK medan vissa delar av webbplatsen fortfarande använder visitor.js.Demdex cookiekndctr_orgid_clusterkndct_orgid_identitykndctr_orgid_consents_ecids_ecid=MCMID|<ECID>.Kör kommandot setConsent när du anropar den konfigurerade instansen av Web SDK. Du kan inkludera följande objekt i det här kommandot:
consent[]: En array medconsentobjekt. Medgivandeobjektet formateras på olika sätt beroende på vilken standard och version du väljer. Se flikarna nedan för exempel på varje samtyckesobjekt, beroende på medgivandestandarden.identityMap: Ett objekt som styr hur ett ECID genereras och vilka ID:n som godkännandeinformation är knuten till. Adobe rekommenderar att du inkluderar det här objektet närsetConsentkörs före andra kommandon, till exempelsendEvent.edgeConfigOverrides: Ett objekt som innehåller datastream-konfiguration åsidosätter .
Adobe 2.0-standardobjekt consent
Om du skickar data till Adobe Experience Platform bör du inkludera en fältgrupp för sekretessschema i ditt profilschema. Mer information om Adobe 2.0 finns i Styrning, sekretess och säkerhet i Adobe Experience Platform. Du kan lägga till data i värdeobjektet nedan som motsvarar schemat för fältet consents i profilfältgruppen Consents and Preferences.
-
standard: Den standard för samtycke som du väljer. Ange den här egenskapen som"Adobe"för Adobe 2.0-standarden. -
version: En sträng som representerar versionen av medgivandestandarden. Ange den här egenskapen som"2.0"för Adobe 2.0-standarden. -
value: Ett objekt som innehåller medgivandevärden.value.collect.val: Medgivandevärdet. Ange detta till"y"när användare väljer att delta och till"n"när användare avanmäler sig.value.metadata.time: Tidsstämpeln när användarna senast uppdaterade sina inställningar för godkännande.
| code language-js |
|---|
|
IAB TCF 2.0-standardobjekt consent
Om du vill registrera inställningar för användargodkännande som tillhandahålls via Interactive Advertising Bureau Europe (IAB) Transparency and Consent Framework (TCF) anger du medgivandesträngen enligt nedan.
När medgivandet har ställts in på det här sättet uppdateras kundprofilen i realtid med medgivandeinformationen. För att detta ska fungera måste profilens XDM-schema innehålla schemafältgruppen för profilsekretess. När händelser skickas måste IAB:s medgivandeinformation läggas till manuellt i händelsens XDM-objekt. Webb-SDK inkluderar inte automatiskt medgivandeinformationen i händelserna.
Om du vill skicka information om samtycke i händelser måste du lägga till fältgruppen för sekretess för upplevelsehändelser i ditt Profile-aktiverade XDM ExperienceEvent-schema. I avsnittet Uppdatera ExperienceEvent-schemat i guiden för datauppsättningsförberedelser finns mer information om hur du konfigurerar det här.
standard: Den standard för samtycke som du väljer. Ange den här egenskapen som"IAB TCF"för IAB TCF 2.0-standarden.version: En sträng som representerar versionen av medgivandestandarden. Ange den här egenskapen som"2.0"för IAB TCF 2.0-standarden.value: En sträng som innehåller medgivandevärdet.gdprApplies: Ett booleskt värde som avgör om GDPR gäller för det här medgivandevärdet. Dess standardvärde ärtrue.gdprContainsPersonalData: Ett booleskt värde som avgör om händelsedata som är associerade med den här användaren innehåller personuppgifter. Dess standardvärde ärfalse.
| code language-js |
|---|
|
API:t IAB TCF 2.0 innehåller en händelse för när kunden uppdaterar medgivandet. Detta inträffar när kunden från början ställer in sina inställningar och när kunden uppdaterar sina inställningar. Du kan lägga till en händelseavlyssnare för att köra kommandot setConsent:
| code language-js |
|---|
|
Ovanstående kodblock lyssnar efter useractioncomplete-händelsen och anger sedan medgivandet och skickar medgivandesträngen och gdprApplies-flaggan. Om du har anpassade identiteter för dina kunder måste du fylla i variabeln identityMap.
Adobe 1.0-standardobjekt consent
standard: Den standard för samtycke som du väljer. Ange den här egenskapen som"Adobe"för Adobe 1.0-standarden.version: En sträng som representerar versionen av medgivandestandarden. Ange den här egenskapen som"1.0"för Adobe 1.0-standarden.value.general: Medgivandevärdet. Ange detta till"in"när användare väljer att delta och till"out"när användare avanmäler sig.
| code language-js |
|---|
|
Skicka flera standarder i en begäran multiple-standards
Web SDK har också stöd för att skicka fler än ett medgivandeobjekt i en begäran, vilket visas i exemplet nedan.
alloy("setConsent", {
consent: [{
standard: "Adobe",
version: "2.0",
value: {
collect: {
val: "y"
},
metadata: {
time: "YYYY-03-17T15:48:42-07:00"
}
}
}, {
standard: "IAB TCF",
version: "2.0",
value: "CO1Z4yuO1Z4yuAcABBENArCsAP_AAH_AACiQGCNX_T5eb2vj-3Zdt_tkaYwf55y3o-wzhhaIse8NwIeH7BoGP2MwvBX4JiQCGBAkkiKBAQdtHGhcCQABgIhRiTKMYk2MjzNKJLJAilsbe0NYCD9mnsHT3ZCY70--u__7P3fAwQgkwVLwCRIWwgJJs0ohTABCOICpBwCUEIQEClhoACAnYFAR6gAAAIDAACAAAAEEEBAIABAAAkIgAAAEBAKACIBAACAEaAhAARIEAsAJEgCAAVA0JACKIIQBCDgwCjlACAoAAAAA.YAAAAAAAAAAA",
gdprApplies: true
}]
});
Förhållanden för samtycke persistence
När du har skickat användarinställningar till Web SDK med hjälp av kommandot setConsent, kommer SDK att behålla användarinställningarna för en cookie. Nästa gång användaren läser in webbplatsen i webbläsaren hämtar och använder Web SDK dessa beständiga inställningar för att avgöra om händelser kan skickas till Adobe eller inte.
Lagra användarens inställningar oberoende av varandra så att du kan visa medgivandedialogrutan med de aktuella inställningarna. Det går inte att hämta användarinställningarna från Web SDK. Om du vill vara säker på att användarinställningarna är synkroniserade med SDK kan du anropa kommandot setConsent vid varje sidinläsning. Web SDK gör bara ett serveranrop om inställningarna ändras.
Ange samtycke med hjälp av taggtillägget Web SDK
Webbtaggtillägget för SDK som är ekvivalent med det här kommandot är åtgärden Set consent.