getVisitorValues

Letzte Aktualisierung: 2023-05-24
  • Erstellt für:
  • Developer
    User
    Admin
    Leader

Hierbei handelt es sich um eine asynchrone API, die standardmäßig IDs für Analytics, den ID-Dienst, die Abmeldung von der Datenerfassung, den geografischen Standort und Metadateninhalte („Blob“) zurückgibt. Sie können auch mit dem optionalen Enum-Wert visitor.FIELDS steuern, welche IDs zurückgegeben werden.

Inhalt:

Syntax

Diese Funktion verwendet die folgende Syntax (kursiv stellt einen Platzhalter für eine Variable dar): var *values* = visitor.getVisitorValues (callback, [visitor.FIELDS. *ID type*, visitor.FIELDS. *ID type*]);

In den Funktionsparametern:

  • *callback* entspricht Ihrem eigenen Rückrufcode, der die zurückgegebenen IDs erhält.
  • (Optional) visitor.FIELDS. *ID type* ist eine Enumeration, mit der Sie ID-Werte angeben können, die von dieser Funktion zurückgegeben werden sollen.

Weitere Informationen finden Sie in den folgenden Nutzungsszenarios und Definitionen.

Nutzungsszenario 1: Standarddatensatz anfordern

Dieser Code gibt den Standarddatensatz zurück. Ihre Anforderung und Ihre Antwort könnten den folgenden Beispielen ähneln.

//Call the ID service
var visitor = Visitor.getInstance ("Insert Experience Cloud organization ID here",{...});

//Add your callback to the GET method to return IDs and data.
visitor.getVisitorValues(visitorIdsCallback);

Im Beispiel für die standardmäßige Antwort wurden einige Werte zu Demonstrationszwecken gekürzt.

//Formatted IDs in JSON response
{
    MCMID: 'mid-1234',
    MCOPTOUT: 'isoptedout-true',
    MCAID: 'aid-1234',
    MCAAMLH: 7,
    MCAAMB: 'hgfe54236786oygj'
}

Nutzungsszenario 2: Benutzerdefinierten Datensatz anfordern

In diesem Code wird ein optionales Array verwendet, um einen spezifischen Satz von IDs mit der visitor.FIELDS-Enumeration zurückzugeben. In diesem Fall möchten wir nur die Experience Cloud ID (MCID) und die Analytics-ID (MCAID) des Besuchers abrufen. Ihre Anforderung und Ihre Antwort könnten den folgenden Beispielen ähneln.

//Call the ID service
var visitor = Visitor.getInstance("Insert Experience Cloud organization ID here", { ... });

// Add an optional array to specify which IDs you want to return.
visitor.getVisitorValues(visitorIdsCallback, [visitor.FIELDS.MCMID, visitor.FIELDS.MCAID]);

Die benutzerdefinierte Antwort im Beispiel gibt nur die in der Anforderung angegebenen IDs zurück.

//Formatted IDs in JSON response
{
    MCMID: 'mid-1234',
    MCAID: 'aid-4321'
}

Definierte Antwortparameter

In der folgenden Tabelle sind die Antwortparameter aufgeführt und definiert. Dies sind auch alle Werte in der visitor.FIELDS-Enumeration. Beachten Sie, dass diese Methode eine leere Zeichenfolge zurückgibt, wenn es für eine bestimmte Variable keine Werte gibt.

Wert Beschreibung

MCAAMB

Verschlüsselte Audience Manager-Metadaten, auch „Blob“ genannt.

MCAAMLH

Die Regions-ID für die Datenerfassung. Dies ist eine numerische ID für den geografischen Standort eines bestimmten ID-Dienst-Rechenzentrums.

Siehe DCS-Regions-IDs, Standorte und Hostnamen und getLocationHint .

MCAID

Die Analytics-ID des Besuchers.

MCMID

Die Experience Cloud ID des Besuchers.

Siehe Cookies und der Experience Cloud Identity Service.

MCOPTOUT

Eine Markierung, die angibt, ob ein Besucher die Datenerfassung ablehnt.

Die Werte umfassen:

  • 'isoptedout-true': Ein Besucher möchte von der Datenerfassung ausgeschlossen werden.
  • 'isoptedout-false': Ein Besucher möchte nicht von der Datenerfassung ausgeschlossen werden.

Auf dieser Seite