Das JavaScript-SDK für Erfassungspunkte ist die einfachste Möglichkeit, das OneTrust Universal-Einwilligungs- und Präferenzmanagement in Ihre vorhandenen Schnittstellen zu integrieren. Sie können das SDK verwenden, um Präferenzen für Verarbeitungszwecke, Themen und zusätzliche Datenelemente zu übergeben. Das folgende Beispiel-SDK und die zugehörigen Anweisungen können als Referenz verwendet werden, wenn das Erfassungspunkt-SDK in Ihr Webformular integriert wird.
Anmerkung
Dieser Artikel bezieht sich nur auf die ältere Implementierungsmethode für das JavaScript-SDK. Die unten aufgeführten JavaScript-Methoden werden bei Verwendung der neuen Implementierungsmethode nicht unterstützt.
Beispiel A: Ein einziger Zweck, nur Formularübermittlung
Das einfachste Modell für die Verwendung des SDK ist ein Erfassungspunkt mit einem einzigen Zweck ohne Themen und dem Interaktionstyp „Nur Formularübermittlung“. Bei Interaktionen vom Typ „Nur Formularübermittlung“ klickt ein Benutzer auf die Schaltfläche „Formular übermitteln“ oder auf eine ähnliche Schaltfläche und ein Einwilligungsvorgang wird für einen einzigen Verarbeitungszweck erstellt.
Im Folgenden finden Sie ein Beispiel für die SDK-Ausgabe für dieses Modell unter Verwendung nicht gehosteter Einstellungen:
<!-- OneTrust Consent Receipt Start -->
<script src="https://{BASE URL}/consent-receipt-scripts/otconsent-1.0.js" type="text/javascript" charset="UTF-8" id="consent-receipt-script">
triggerId="trigger";
identifierId="inputEmail";
confirmationId="confirmation";
token="eyJhbGciOiJSUzUxMiJ9.eyJwcm9jZXNzSWQiOiJlNWM1MzJjMi0yYzAyLTQ4OGEtYWY5MS02ZDBkOWNmZGVlZjUiLCJpYXQiOiIyMDE4LTA3LTI0VDExOjAzOjQxLjUyIiwibW9jIjoiV0VCX0ZPUk0iLCJzdWIiOiJlbWFpbCIsImlzcyI6Imh0dHBzOi8vZ292aWNwIiwidGVuYW50SWQiOiIxODRhMjBlNC1jODU4LTRlZDYtOTI5NC05ZDBjN2JiYzFhOWMiLCJkZXNjcmlwdGlvbiI6ImdvdmljcCIsImNvbnNlbnRUeXBlIjoiRk9STVNVQk1JVCIsInBvbGljeV91cmkiOiJodHRwczovL2dvdmljcCIsInB1cnBvc2VzIjpbeyJpZCI6IjM2NzMwNGIyLWU4MDktNDRmMi1iOWZhLTcwMGEwNjAyNGEzNSIsInRvcGljcyI6W119XSwiZHNEYXRhRWxlbWVudHMiOlsiRmlyc3ROYW1lIiwiTGFzdE5hbWUiXX0.muL6uxuSi7irrd0iqDBn3faggx748-2lsV_IHpu_jPfiSjNP9DWw9zUBvcb8K_STB5RU1Ku3k5vQmhVOv34tsEdrinLEVailGDIQapY1xxhPMUfosO2s5KM7ECPlFStodPt3c6c5xVDDYteAWoPy-1CtStHto2jLY6zd_CQaDA6llIu1ebNnv5Z2B261mfxpUZ5loIBXa1Z0Qd2NH6zgi-GTWZXv82e6HcZtIMLcSJ3HHh-CJPsvB-Xdx7SyF8t9xrFXQ4zIR4fpFHRqD2F8RU911KNj4Pa88vDEtpyXfkVLitqdCkfdWUgkWghPPkzU8Vh4X1PQMv58GEloOtLvdg";
settings="eyJyZWNlaXB0QXBpRW5kcG9pbnQiOiJodHRwczovL2NyLWRzLWVhc3R1cy5kZXYub3RkZXYub3JnL3JlcXVlc3QvdjEvY29uc2VudHJlY2VpcHRzIiwibWFudWFsVHJpZ2dlciI6ZmFsc2UsImNvbnRpbnVlT25FcnJvciI6dHJ1ZX0=";
</script>
<script type="text/javascript" charset="UTF-8">
OneTrust.ScriptTag.Preferences = [
{
"purpose": "{PURPOSE GUID}",
"identifierAttributes": "value",
"identifierValues": "Purpose1 Name",
"labels": [
{
"language": "de",
"label": "Purpose1 DE",
"description": "Allows us to send you news and information about our products and services. DE"
},
{
"language": "en-us",
"label": "Purpose1",
"description": "Allows us to send you news and information about our products and services."
},
{
"language": "fr",
"label": "Purpose1 FR",
"description": "Allows us to send you news and information about our products and services. FR"
}
]
}
];
</script>
<!-- OneTrust Consent Receipt End -->
So verwenden Sie das obige Skript:
Der Code sollte auf der Seite platziert werden, auf der sich das Formular zur Einholung der Einwilligung befindet, und optional auf jeder Seite, auf die der Nutzer nach dem Übermitteln des Formulars weitergeleitet wird.
Folgende Attribute sollten für das Formular angepasst werden:
Attribut
Beschreibung
triggerId
ID des Formularelements, das den Service auslöst und eine Bestätigung generiert, wenn darauf geklickt wird. In Standard-Webformularen wäre dies die ID des Schaltflächenelements für die Übermittlung.
identifierID
ID des Formularelements, das die eindeutige ID der betroffenen Person enthält, z. B. eine E-Mail-Adresse. Der von diesem Formularelement übermittelte Wert wird an die Bestätigungs-API übergeben und zusammen mit der Bestätigung gespeichert, um zukünftige Suchen und Abrufe zu ermöglichen. Dies ist auch die Betroffenen-ID in der Liste der betroffenen Personen.
Wichtig
Der Bezeichnertyp, den dieser Wert darstellt, wird durch den für den Erfassungspunkt konfigurierten Bezeichnertyp bestimmt. Daher ist es wichtig, dass diese korrekt übereinstimmen. Legen Sie z. B. nicht den Bezeichnertyp „E-Mail“ fest und geben dann als Formulareingabe eine Telefonnummer an.
Anmerkung
Der Bezeichnertyp „E-Mail“ oder „Telefonnummer“ wird definiert, wenn Sie den Erfassungspunkt einrichten, das SDK prüft jedoch nicht, ob der übergebene Wert den richtigen Typ hat. Wenn Sie den Bezeichnertyp als E-Mail-Adresse definieren, aber einen Wert über das Formular senden, der eigentlich eine Telefonnummer ist, wird er in der Tabelle „Betroffene Personen“ weiterhin als ID vom Typ E-Mail identifiziert.
confirmationID
(Optional)
Wenn dieser Parameter in einem DOM-Element verwendet wird, wird die Bestätigungsnummer in dieses Element geschrieben, wenn das SDK einen erfolgreichen Aufruf an die API zur Erstellung einer Bestätigung ausführt. Ein ausgeblendetes Formularfeld mit einer confirmationId ermöglicht Ihnen, die Bestätigungsnummer einzufügen und über die Formularbearbeitung in Ihre eigene Datenbank einzufügen.
Anmerkung
Weitere Informationen zur Verwendung des Abschnitts ScriptTag.Preferences einschließlich Beschriftungen für Sprache finden Sie unten. Sie müssen diese Werte nicht ändern, wenn Sie den Interaktionstyp „Nur Formular übermitteln“ verwenden.
Beispiel B: Mehrere Zwecke und/oder Themen, Opt-in-Kontrollkästchen
Wenn Sie die Einwilligung für mehrere Verarbeitungszwecke und/oder Themen, die einem Zweck hinzugefügt wurden, einholen und Ihr Erfassungspunkt einen Kontrollkästchen-Interaktionstyp verwendet, sucht das SDK nach Kontrollkästchen-Elementen im Webformular, um die Einwilligung für jeden Zweck anzuzeigen. Sie müssen das SDK so konfigurieren, dass die korrekten Bestätigungs- und Einwilligungsvorgangsinformationen erstellt werden, wenn Besucher die verschiedenen Optionen auswählen, um ihre Einwilligung anzugeben.
Im Folgenden finden Sie ein Beispiel für die SDK-Ausgabe für dieses Modell:
<!-- OneTrust Consent Receipt Start -->
<script src="https://{BASE URL}/consent-receipt-scripts/otconsent-1.0.js" type="text/javascript" charset="UTF-8" id="consent-receipt-script">
triggerId="trigger";
identifierId="inputEmail";
conditionalConsentTriggerId="conditionalCheckbox";
confirmationId="confirmation";
token="eyJhbGciOiJSUzUxMiJ9.eyJwcm9jZXNzSWQiOiJlNWM1MzJjMi0yYzAyLTQ4OGEtYWY5MS02ZDBkOWNmZGVlZjUiLCJpYXQiOiIyMDE4LTA3LTI0VDExOjAzOjQxLjUyIiwibW9jIjoiV0VCX0ZPUk0iLCJzdWIiOiJlbWFpbCIsImlzcyI6Imh0dHBzOi8vZ292aWNwIiwidGVuYW50SWQiOiIxODRhMjBlNC1jODU4LTRlZDYtOTI5NC05ZDBjN2JiYzFhOWMiLCJkZXNjcmlwdGlvbiI6ImdvdmljcCIsImNvbnNlbnRUeXBlIjoiT1BUSU5DSEVDS0JPWCIsInBvbGljeV91cmkiOiJodHRwczovL2dvdmljcCIsInB1cnBvc2VzIjpbeyJpZCI6IjM2NzMwNGIyLWU4MDktNDRmMi1iOWZhLTcwMGEwNjAyNGEzNSIsInRvcGljcyI6W119LHsiaWQiOiJiYTU0ZWIyNS05MGYwLTQ2MzMtYWIxMi1jN2JmNWFmZGQ4NTYiLCJ0b3BpY3MiOlt7ImlkIjoiMDBiZTYwOGItMjhkZC00NzBhLWJlNjItZGE5ZWMwNTBlYjQwIn0seyJpZCI6ImY3MTJmNzczLWUyMWUtNDc1Mi05NjEwLWNlZTA0YjU2ZDMxMSJ9LHsiaWQiOiI0NmYwYzkwYS1lZTdiLTRhODQtYTkzMi1hZDU2MDlkNzE2YTIifV19XSwiZHNEYXRhRWxlbWVudHMiOlsiRmlyc3ROYW1lIiwiTGFzdE5hbWUiXX0.lE9D0Ri025kLyhfcKUJ2OV6CfH3wrhijh_J8rs_9yW9wmoQ3RcLzgeTtDiX8GAKc6AFwSQXukyscMW_xg-Agjq0e6RqOUoE3hBZhmcKX4DKQ_Oo8a-Kom5AMOndrpgGHjn2emNBrHnhG_snVMeW_Rl0KUkb6xqXwfyUjqrdLS5K6K39hJJLQDZDtKzRUEtbK0AL98ImzWyrECXnIc4B04BXIF9fGjDSql0aRCq8Lx64a5rY2qWKUf6m8Z0LFcvFYsHykDT-Aa5GCg0SOgR6rg2WGa1rafJuZd-fCNw8jeN9bRKn559RNz24n6kUIx9eGXIJsPdNMVrCBhvvz6zgyDQ";
settings="eyJyZWNlaXB0QXBpRW5kcG9pbnQiOiJodHRwczovL2NyLWRzLWVhc3R1cy5kZXYub3RkZXYub3JnL3JlcXVlc3QvdjEvY29uc2VudHJlY2VpcHRzIiwibWFudWFsVHJpZ2dlciI6ZmFsc2UsImNvbnRpbnVlT25FcnJvciI6dHJ1ZX0=";
</script>
<script type="text/javascript" charset="UTF-8">
OneTrust.ScriptTag.Preferences = [
{
"purpose": "{GUID}",
"identifierAttributes": "value",
"identifierValues": "Purpose1 Name",
"labels": [
{
"language": "de",
"label": "Purpose1 DE",
"description": "Allows us to send you news and information about our products and services. DE"
},
{
"language": "en-us",
"label": "Purpose1",
"description": "Allows us to send you news and information about our products and services."
},
{
"language": "fr",
"label": "Purpose1 FR",
"description": "Allows us to send you news and information about our products and services. FR"
}
]
} ,
{
"purpose": "{GUID}",
"identifierAttributes": "value",
"identifierValues": "Purpose2 Name",
"labels": [
{
"language": "de",
"label": "Purpose2 DE",
"description": "Allows us to send you news and information about our products and services. DE"
},
{
"language": "en-us",
"label": "Purpose2",
"description": "Allows us to send you news and information about our products and services."
},
{
"language": "fr",
"label": "Purpose2 FR",
"description": "Allows us to send you news and information about our products and services. FR"
}
]
"topics" : [
{
"topic": "{GUID}",
"identifierAttributes": "value",
"identifierValues": "Topic1",
"labels": [
{
"language": "en-us",
"label": "Topic1"
},
{
"language": "de",
"label": "Topic1 DE"
}
]
} ,
{
"topic": "{GUID}",
"identifierAttributes": "value",
"identifierValues": "Topic2",
"labels": [
{
"language": "en-us",
"label": "Topic2"
},
{
"language": "de",
"label": "Topic2 DE"
}
]
} ,
{
"topic": "{GUID}",
"identifierAttributes": "value",
"identifierValues": "Topic3",
"labels": [
{
"language": "en-us",
"label": "Topic3"
},
{
"language": "de",
"label": "Topic3 DE"
}
]
}
]
}
];
</script>
<!-- OneTrust Consent Receipt End -->
So verwenden Sie das obige Skript:
Wenn Sie den obigen Code verwenden, müssen Sie möglicherweise die Werte identifierAttributes und identifierValues so ändern, dass sie dem Formular auf Ihrer Seite entsprechen (oder Ihr Formular so bearbeiten, dass diese Werte verwendet werden), und zwar für jeden Zweck der Verarbeitung in Ihrem Erfassungspunkt.
Attribut
Beschreibung
identifierAttributes
„identifierAttributes“ sollte der Attributname in Ihrem Kontrollkästchen-Element sein, der den eindeutigen Identifikationswert enthält, der jedes Feld von allen anderen unterscheidet. „Value“ ist der Standardwert, kann jedoch geändert werden, wenn Ihr Formular abweicht.
identifierValues
„identifierValues“ sollte der gespeicherte Wert dieses Attributs sein, das dem bestimmten Zweck oder Thema zugeordnet ist. Standardmäßig wird hier der Zweck- oder Themenname angegeben, der der System-GUID entspricht. Sie können ihn jedoch ändern, wenn Ihr Formular andere Werte verwendet.
Beispiel: Die erste Zweckzuordnung im obigen Code (mit „identifierAttributes“: „value“ und „identifierValues“: „Purpose1 Name“) würde dem folgenden Kontrollkästchen zugeordnet werden: <input type="checkbox" value="Purpose1 Name" />
Wichtig
Sie sollten die im Code angegebenen Zweck- oder Themen-GUIDs nicht ändern. Dies führt höchstwahrscheinlich dazu, dass keine Bestätigungen generiert werden.
Anmerkung
Die Variable „conditionalConsentTriggerId“ ist ein optionales zusätzliches Steuerelement für das Auslösen der Einwilligung, das über die Zuordnung von Zwecken und Themen hinausgeht. Dies kann dann nützlich sein, wenn Sie eine zusätzliche Interaktion in Form eines Kontrollkästchens wünschen, um die Erteilung der Einwilligung zu signalisieren. Bei Verwendung löst das SDK eine Einwilligungsanfrage nur aus, wenn dieses zusätzliche Kontrollkästchen aktiviert ist, unabhängig von Zuordnungen.
Diese Variable muss die ID des Kontrollkästchens enthalten, das ausgewählt werden muss, wie etwa conditionalConsentTriggerId=„conditionalCheckbox“.
Benutzerdefinierte Präferenzen
Die Zuordnungen für benutzerdefinierte Präferenzen funktionieren ähnlich denen von Zwecken und Themen. Zu jedem Zweck müssen die Optionen für benutzerdefinierte Präferenzen „identifierAttributes“ und „identifierValues“ zu den IDs in den Formularfeldern passen, die es dem SDK ermöglichen, die korrekten Werte beim Übermitteln abzurufen.
Im Folgenden finden Sie ein Beispiel für die Zuordnung benutzerdefinierter Präferenzen in JavaScript.
Überschreiben der Optionen für benutzerdefinierte Präferenzen
Wenn in Ihrem Webformular andere Elemente als Kontrollkästchen verwendet werden (z. B. Optionsschaltflächen, Auswahlen, benutzerdefinierte Webkomponenten usw.), können Sie überschreiben, wie das SDK den Wert der Option abruft, zu der Einwilligung erteilt wurde. Wenn wir z. B. ein Auswahl-Drop-down-HTML-Element verwenden, sodass nur einer einzigen Option zugestimmt wird, können wir überschreiben, wie das SDK diese abruft.
Konfigurationssignatur
Im Folgenden finden Sie ein Beispiel für eine benutzerdefinierte Schnittstelle zur Definition eines Erfassungspunkts.
Im Folgenden finden Sie ein Beispiel für JavaScript-Code, um eine benutzerdefinierte Präferenz für einen Zweck außer Kraft zu setzen.
// To ensure external settings are loaded, use the Initialized promise:
OneTrust.Api.Initialized.then(() => {
console.log("External settings loaded. We're ready to use them.");
const PURPOSE_ID = 'a6570910-4d90-48f8-8f8d-5f0b4af0ce12';
// custom function to get the ID of the selected option
const getOptionsValue = () => {
// select with id "customPreferenceOptions"
const options = document.getElementById('customPreferenceOptions');
// return the option's value attribute
return options ? [options.value] : [];
};
// define custom preferences definitions for purpose with id PURPOSE_ID
OneTrust.Api.SetCustomPreferencesDefinitions(PURPOSE_ID, [{
identifierValues: 'customPreference1',
getOptionsValue
}]);
});
Verwenden gehosteter Einstellungen
Wenn Sie die Version des SDK mit gehosteten Einstellungen verwenden, können Sie die folgenden beiden Optionen nutzen:
Option 1:
Ändern Sie Ihr Formular so, dass es standardmäßig „identifierValues“ und „identifierAttributes“ verwendet. Weitere Informationen finden Sie in der Attributtabelle in Beispiel B.
Option 2:
Überschreiben Sie die gehosteten Werte. Weitere Informationen finden Sie unter „Überschreiben der gehosteten SDK-Einstellungen“.
Überschreiben der gehosteten SDK-Einstellungen
Das folgende Skript ist ein Beispiel für das Überschreiben von gehosteten SDK-Einstellungen.
// To ensure external settings are loaded, use the Initialized promise:
OneTrust.Api.Initialized.then(() => {
// Override identifier value
let customDefinitions = OneTrust.Api.GetPurposeDefinitions();
customDefinitions[0].identifierValues = "purpose1-modified";
OneTrust.Api.SetPurposeDefinitions(customDefinitions);
});
Zwecke und Themen
Sie können die Werte für Zweck- und Themen-ID auch direkt mit API-Aufrufen festlegen:
Themen sind untergeordnete Elemente von Zwecken im Erfassungspunktschema. Ihre Benutzeroberfläche muss jedoch keine Kontrollkästchen für den Zweck enthalten, wenn mehrere Themen vorhanden sind. Wenn das SDK erkennt, dass ein Thema aktiviert wurde, wird automatisch ein Einwilligungsdatensatz für den übergeordneten Zweck erstellt. Wenn Ihre Benutzeroberfläche Kontrollkästchen für Zwecke als übergeordnete Elemente von Themen enthält, sollten Sie sicherstellen, dass Ihre Benutzeroberfläche eine Logik enthält, die dieses Verhalten widerspiegelt.
Datenelemente
Das SDK unterstützt auch die Möglichkeit, Datenelementwerte aus einem Formular zu senden, die in OneTrust gespeichert werden (Name, Land, Unternehmen usw.). Dazu müssen die Datenelementnamen zuerst für den Erfassungspunkt konfiguriert werden.
Nach der Konfiguration können Sie zusätzlichen JavaScript-Code hinzufügen, ähnlich dem folgenden Beispiel. Ähnlich wie bei den Zwecken oben müssen die Datenelemente „identifierAttributes“ und „identifierValues“ mit den Bezeichnern in den Formularfeldern übereinstimmen, damit das SDK beim Übermitteln die richtigen Werte abrufen kann.
Im Folgenden finden Sie ein Beispiel für das Übermitteln von Datenelementwerten im SDK:
Wenn Sie die Sprachen für einen Erfassungspunkt definieren, enthält das SDK alle verfügbaren Textbeschriftungen für die Zwecke und Themen, für die die Übersetzungen erstellt wurden. Die beiden obigen Auszüge zeigen Beispiele für diese Bezeichnungen, die auch in der Datei der gehosteten SDK-Einstellungen enthalten sind. OneTrust bietet eine Reihe von JavaScript-Methoden für die Verwendung dieser Beschriftungen in der Benutzeroberfläche Ihres Webformulars. So können Sie sicherstellen, dass Ihre Formulare die gleiche Sprache für Zwecke und Themen verwenden, die betroffenen Personen bei der Anmeldung in den Präferenz-Centern angezeigt wird.
Im Folgenden finden Sie ein Beispiel für unterstützte JavaScript-Methoden für Sprachen:
// To ensure external settings are loaded first, use the Initialized promise:
OneTrust.Api.Initialized.then(() => {
// Get all purpose labels for a language(can always be skipped to get a single/default/first label entry):
const frenchPurposeLabels = OneTrust.Api.GetPurposeLabels("fr");
// Get purpose label by language and purposeId/domIdentifier
const frenchPurpose1Label = OneTrust.Api.GetPurposeLabel("purpose1", "fr");
// Get all topic labels for a language:
const frenchTopicLabels = OneTrust.Api.GetTopicLabels("fr");
// Get topic label by language and topicId/domIdentifier
const frenchTopic1Label = OneTrust.Api.GetTopicLabel("topic1", "fr");
// Get all purpose labels for a default language(should only be used when a single language is defined)
var allPurposeLabels = OneTrust.Api.GetPurposeLabels();
});
Jede Beschriftung hat die folgende Struktur:
{
id: "{GUID}",
domId: "HTML attribute value used to find the checkbox on the page",
language: "language code of the label",
label: "Purpose/Topic label for a given language"
description: "Purpose description for a given language(not defined for Topic labels)"
}
Senden der Sprache der betroffenen Person
Das SDK kann die Sprache für eine betroffene Person zusammen mit der Formularübermittlung senden, was als Attribut dieser betroffenen Person gespeichert wird. OneTrust verwendet dann diesen Sprachcode, um E-Mail-Benachrichtigungen in der gespeicherten Sprache der betroffenen Person zu versenden.
Anmerkung
Dazu muss sichergestellt werden, dass die Vorlagen für diese Sprache in den E-Mail-Vorlagen vorhanden sind, die Teil der Konfiguration der globalen Einstellungen sind.
Um die Spracheinstellung einer betroffenen Person korrekt zu speichern, muss Ihr Webformular die Sprache in einem ISO-Standardsprache- oder Sprachkulturcode-Format generieren. Dazu wird die Variable OneTrust.ScriptTag.Language gesetzt.
Nachstehend finden Sie ein Beispiel für die Einstellung der Sprachpräferenz einer betroffenen Person:
Es werden sowohl die Formate „en“ als auch „en-GB“ unterstützt. Dieses Tag muss außerdem nach dem Haupt-SDK-Tag in einem Tag platziert werden und muss festgelegt werden, bevor das Webformular gesendet wird.
Wichtig
Wenn Sie diese Funktion verwenden, sind Sie dafür verantwortlich, die betroffenen Personen zu informieren, dass diese Daten erhoben und dazu verwendet werden können, in der ausgewählten/erkannten Sprache mit ihnen zu kommunizieren.
Nicht codierte Einstellungen direkt in JavaScript
Sie können nicht codierte Einstellungen direkt in Ihre Seite schreiben, um Änderungen am JavaScript einfacher vorzunehmen.
identifierAttributes und identifierValues müssen mit den Kennungen in den Formularfeldern übereinstimmen, damit das SDK die korrekten Werte übergeben kann, wenn das Formular gesendet wird.
Die Einstellungen sollten nach dem Tag <body> in der HTML für die Seite platziert werden. Im Folgenden finden Sie ein Beispiel für nicht kodierte Einstellungen.
<script type="text/javascript" charset="UTF-8">
OneTrust.ScriptTag.ReceiptApiEndpoint = "{endpoint URL}"; //optional - can be left in settings - but if used settings can be removed completely.
OneTrust.ScriptTag.DataElements = [
{
"identifierAttributes": "id",
"identifierValues": "firstName",
"dataElementName": "First Name"
},
{
"identifierAttributes": "id",
"identifierValues": "lastName",
"dataElementName": "Last Name"
},
{
"identifierAttributes": "id",
"identifierValues": "inputEmail",
"dataElementName": "Email"
}
];
OneTrust.ScriptTag.Preferences = [
{
"purpose": "622ab782-8ad7-4886-9dc3-8618dcf03900",
"identifierValues": "Sample Purpose",
"identifierAttributes": "value",
"topics": [
{
"topic": "2b55ca4e-c232-4396-9602-d6f2ea5bbd18",
"identifierValues": "A Topic",
"identifierAttributes": "value"
},
{
"topic": "e4e19d3b-7de6-4054-a3f0-fd6b8a82775a",
"identifierValues": "AA Topic",
"identifierAttributes": "value"
}
]
}
];
</script>
Verwenden von manualTrigger
manualTrigger ist eine boolesche Variable, die im Teil für kodierte Einstellungen des SDK enthalten ist. Sie können die Einstellungen mit einem base64-Dekodierungstool dekodieren, ändern und die Einstellungs-Zeichenfolge neu kodieren. Der Standardwert ist „false“, wenn Sie den Wert jedoch auf „true“ setzen, kann der benutzerdefinierte Arbeitsablauf ausgeführt werden. Dies ermöglicht Szenarien, in denen Sie eine alternative Logik oder einen Arbeitsablauf verwenden möchten, um die Zahlungsgenerierungsaktion auszulösen, anstatt das Standard-Kontrollkästchen/die Sendelogik zu verwenden.
Wenn die Auslöserbedingungen erfüllt sind, rufen Sie Receipt.TriggerReceiptAction(downloadRawReceipt) aus JavaScript auf, um die Bestätigung zu erstellen. Um die reine Bestätigungssignatur herunterzuladen, setzen Sie den Parameter downloadRawReceipt auf „true“.
Laden von OneTrust über einen Tag-Manager
Nachdem Sie Ihr Skript konfiguriert haben, kann es über ein Tag-Management-Tool wie Google Tag Manager geladen werden. Es muss nur auf die Seite geladen werden, auf der sich Ihr Webformular befindet. Wenn Sie Google Tag Manager verwenden, setzen Sie den Auslöser für die Seite auf „DOM Ready“, um sicherzustellen, dass das Formular selbst vollständig vor dem Skript geladen wird.
Unterstützung für mehrere Formulare auf einer Seite
Um mehrere Formulare auf einer einzelnen Seite zu unterstützen, können Sie sowohl den Bezeichner als auch das Token über JavaScript mit einem benutzerdefinierten Fluss übergeben. Sie können auch die Bestätigungsanfrage auslösen.
OneTrust.Api.TriggerReceiptAction("user@identifier.com", "CP token"); // pass both token and identifier, which can be used to create receipts for multiple CPs with a single script tag
OneTrust.Api.TriggerReceiptAction("user@identifier.com"); // pass custom identifier only, when shared default token from the script tag is to be used.
OneTrust.Api.TriggerReceiptAction(); // trigger receipt request with defaults working as before
Anmerkung
Da der Erfassungs-Service die Standard-Zweck-ID eines JWT für nicht explizite Einzel-Zweck-Erfassungspunkte nicht übergibt, müssen Benutzer mit benutzerdefiniertem Fluss die Zweck-ID wie unten dargestellt manuell an die Anfrage-Payload übergeben. Der Erfassungs-Service behandelt eine fehlende Payload als korrekt, gibt die Bestätigungs-ID zurück, erstellt jedoch keine Einwilligungsvorgänge.
var purposes = [{Id: "b0dc5e4e-ffe8-4db5-ae5f-577747e5f86a"}];
OneTrust.Api.TriggerReceiptAction("user@identifier.com", "CP token", purposes); // pass both token and identifier, which can be used to create receipts for multiple CPs with a single script tag
OneTrust.Api.TriggerReceiptAction("user@identifier.com", null, purposes); // pass custom identifier only, when shared default token from the script tag is to be used.
OneTrust.Api.TriggerReceiptAction(null, null, purposes); // trigger receipt request with defaults working as before
Da die Verwendung mehrerer Einwilligungsformulare auf einer Seite wahrscheinlich bedeutet, dass mehrere Erfassungspunkte verwendet werden, besteht der häufigste Anwendungsfall darin, sowohl den Bezeichner als auch das Token wie in der ersten Zeile oben zu übergeben. Alle anderen optionalen Parameter (Zwecke, Datenelemente, benutzerdefinierte Präferenzen) können an die Methode OneTrust.API.TriggerReceiptAction() übergeben werden.
„Fire and Forget“
Sie können einen Einwilligungsvorgang mit Textinhalt anstelle von JSON auslösen und das Warten auf die Bestätigungs-ID umgehen. Dazu können Sie die Funktion TriggerBeaconReceiptAction aufrufen. Diese Funktion akzeptiert Bezeichner, Token, Zwecke, dsDataElements (Datenelemente der betroffenen Person), customElements und downloadRawReceipt als optionale Parameter.
Im Folgenden finden Sie ein Beispiel für „Fire and Forget“.