Hier finden Sie eine Liste der TVJS-Methoden, die von der tvOS-Bibliothek bereitgestellt werden.
version
Gibt die aktuelle Version der Adobe Mobile-Bibliothek zurück.
Hier finden Sie die Syntax für diese Methode:
version()
Hier finden Sie ein Code-Beispiel für diese Methode:
var sdkVersion = ADBMobile.version();
Rückgabe: String
privacyStatus
Gibt die NSUInteger-Darstellung für Datenschutzstatus-Enum des aktuellen Benutzers zurück.
Das sind die Optionen:
ADBMobilePrivacyStatusOptIn
: Treffer werden umgehend gesendet.
ADBMobilePrivacyStatusOptOut
: Treffer werden verworfen.
ADBMobilePrivacyStatusUnknown
: Wenn die Offline-Verfolgung aktiviert ist, werden die Zugriffe gespeichert, bis der Datenschutzstatus zu „opt-in“ (Zugriffe werden dann gesendet) oder „opt-out“ (Zugriffe werden dann verworfen) geändert wird.
Ist die Offline-Verfolgung nicht aktiviert, werden die Treffer verworfen, bis der Datenschutzstatus zu „opt-in“ geändert wird. Der Standardwert wird in der Datei ADBMobileConfig.json
festgelegt.
Hier finden Sie die Syntax für diese Methode:
privacyStatus()
Hier finden Sie ein Code-Beispiel für diese Methode:
var privacyStatus = ADBMobile.privacyStatus();
Rückgabe: Number
setPrivacyStatus
Legt den Datenschutzstatus für den aktuellen Benutzer auf einen der folgenden Werte fest:
ADBMobilePrivacyStatusOptIn
: Treffer werden umgehend gesendet.ADBMobilePrivacyStatusOptOut
: Treffer werden verworfen.ADBMobilePrivacyStatusUnknown
: Wenn die Offline-Verfolgung aktiviert ist, werden die Zugriffe gespeichert, bis der Datenschutzstatus zu „opt-in“ (Zugriffe werden dann gesendet) oder „opt-out“ (Zugriffe werden dann verworfen) geändert wird.Ist die Offline-Verfolgung nicht aktiviert, werden die Treffer verworfen, bis der Datenschutzstatus zu „opt-in“ geändert wird.
Hier finden Sie die Syntax für diese Methode:
setPrivacyStatus(privacyStatus)
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.setPrivacyStatus(ADBMobilePrivacyStatusOptIn);
lifetimeValue
Gibt den Lebenszeitwert für den aktuellen Benutzer zurück. Der Standardwert lautet 0
.
Hier finden Sie die Syntax für diese Methode:
lifetimeValue()
Hier finden Sie ein Code-Beispiel für diese Methode:
var ltv = ADBMobile.lifetimeValue();
Rückgabe: Number
userIdentifier
Gibt die Benutzer-ID zurück, sofern eine benutzerdefinierte ID festgelegt wurde. Gibt „nil“ zurück, wenn keine benutzerdefinierte ID festgelegt wurde. Die Standardeinstellung lautet nil
.
Wenn für Ihre App ein Upgrade vom Experience Cloud-SDK 3.x auf 4.x vorgenommen wird, wird die vorherige benutzerdefinierte oder automatisch generierte Besucher-ID abgerufen und als die benutzerdefinierte Benutzer-ID gespeichert. Dadurch werden Besucherdaten zwischen SDK-Upgrades beibehalten. Für neue Installationen für das SDK der Version 4.x lautet die Benutzer-ID nil, bis die Festlegung erfolgt.
Hier finden Sie die Syntax für diese Methode:
userIdentifier()
Hier finden Sie ein Code-Beispiel für diese Methode:
var uid = ADBMobile.userIdentifier();
Rückgabe: String
setUserIdentifier
Legt die Benutzer-ID fest.
Hier finden Sie die Syntax für diese Methode:
setUserIdentifier(userId)
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.setUserIdentifier(‘myUserId’);
Gibt Folgendes zurück: N/A
Parameter: userID
setAdvertisingIdentifier
Legt den IDFA im SDK fest. Wurde er im SDK festgelegt, wird der IDFA im Lebenszyklus gesendet. Auf den IDFA kann auch in Signalen (Postbacks) zugegriffen werden.
Rufen Sie den IDFA nur dann aus den Apple-APIs ab, wenn Sie einen Dienst für Werbeanzeigen verwenden. Wenn Sie den IDFA abrufen und ihn nicht richtig verwenden, wird Ihre App ggf. abgelehnt.
Hier finden Sie die Syntax für diese Methode:
setAdvertisingIdentifier(idfa)
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.setAdvertisingIdentifier(‘myIdfa’);
Gibt Folgendes zurück: N/A
Parameter: idfa
String
setDebugLogging
Legt die Debug-Protokollierungsvoreinstellung fest.
Hier finden Sie die Syntax für diese Methode:
setDebugLogging(logging)
Hier finden Sie ein Code-Beispiel für diese Methode:
`ADBMobile.setDebugLogging(true);
Gibt Folgendes zurück: N/A
Parameter: logging
Bool
trackStateData
Verfolgt einen App-Status mit optionalen Kontextdaten. Status sind die in Ihrer App verfügbaren Ansichten wie Startseiten-Dashboard, App-Einstellungen, Warenkorb usw. Diese Statusangaben sind mit den Seiten einer Website vergleichbar und trackState-Aufrufe erhöhen die Seitenaufrufe.
Wenn der Status leer ist, wird es in Berichten als app name app version (build) angezeigt. Wenn dieser Wert in einem Bericht angezeigt wird, müssen Sie den Status in jedem trackState-Aufruf festlegen.
Dies ist der einzige Verfolgungsaufruf, bei dem die Seitenansichten inkrementiert werden.
Hier finden Sie die Syntax für diese Methode:
trackStateData(stateName [, contextData])
stateName
String
contextData
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.trackStateData(‘homepage’, {‘userid’:12345});
trackActionData
Verfolgt eine Aktion in der App. Bei Aktionen handelt es sich um die Dinge, die in Ihrer App vor sich gehen, die Sie messen möchten, beispielsweise Anmeldungen, Banner-Tippvorgänge, Feed-Abonnements und andere Metriken.
Hier finden Sie die Syntax für diese Methode:
trackActionData(actionName [, contextData])
actionName
contextData
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.trackActionData(‘likeClicked’, {‘imageName’:’funnyKitty’});
trackLocationWithLatLonData
Sendet die aktuellen Koordinaten (Längen- und Breitengrad).
Verwendet darüber hinaus in der Datei ADBMobileConfig.json
definierte Zielpunkte (Points of Interest, POI) zum Bestimmen, ob sich der Standort, den Sie als einen Parameter eingegeben haben, innerhalb Ihres Zielpunkts befindet. Falls die aktuellen Koordinaten auf einen definierten Zielpunkt passen, wird eine Kontextdatenvariable gefüllt und zusammen mit dem trackLocation
-Aufruf gesendet.
Hier finden Sie die Syntax für diese Methode:
trackLocationWithLatLonData(lat, lon [, contextData]);
lat
lon
contextData
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.trackLocationWithLatLonData(43.36, -116.12, null);
trackLifetimeValueIncreaseJsData
Erhöht den Lebenszeit-Wert des Benutzers.
Hier finden Sie die Syntax für diese Methode:
trackLifetimeValueIncreaseJsData(increaseAmount)
increaseAmount
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.trackLifetimeValueIncreaseJsData(5);
trackTimedActionStartData
Beginnt eine zeitgesteuerte Aktion mit einer benannten Aktion. Wenn Sie diese Methode für eine bereits gestartete Methode aufrufen, wird die vorherige zeitgesteuerte Aktion überschrieben.
Dieser Aufruf sendet keinen Treffer.
Hier finden Sie die Syntax für diese Methode:
trackTimedActionStartData(name [, contextData])
name
contextData
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.trackTimedActionStartData(‘level1’, {‘userId’:42423});
trackTimedActionUpdateData
Übergeben Sie diesen Wert in Daten, um die Kontextdaten zu aktualisieren, die der gegebenen Aktion zugewiesen sind.
Die übergebenen Daten werden an die vorhandenen Daten für die gegebene Aktion angehängt und wenn der Schlüssel bereits für die Aktion definiert ist, werden die Daten überschrieben.
Dieser Aufruf sendet keinen Treffer.
Hier finden Sie die Syntax für diese Methode:
trackTimedActionUpdateData(name [, contextData])
name
contextData
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.trackTimedActionUpdateData(‘level1’);
trackTimedActionEndJsLogic
Beendet eine zeitgesteuerte Aktion.
Wenn Sie eine Rückruffunktion bereitstellen, können Sie auf die endgültigen Zeitwerte zugreifen. Wenn kein Rückruf bereitgestellt wird oder der Rückruf „true“ zurückgibt, sendet das Adobe-SDK automatisch einen Treffer. Wenn der Callback „false“ zurückgibt, wird der zeitgesteuerte Aktionstreffer unterdrückt.
Hier finden Sie die Syntax für diese Methode:
trackTimedActionEndJsLogic(name [, callback])
Gibt Folgendes zurück: N/A
Parameter: name
Parameter: callback
Typ: function(inAppDuration, totalDuration, data)
Callback-Methode, deren Parameter inAppDuration
(Zahl), totalDuration
(Zahl) und data
(Kontextdatenobjekt) enthalten.
Sie können verhindern, dass der endgültige Treffer vom SDK gesendet wird, indem Sie false
in Ihrer Callback-Funktion zurückgeben.
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.trackTimedActionEndJsLogic(‘level1’,
function(inAppDuration, totalDuration, data) {
// do something with final values
return true;
});
trackingTimedActionExistsJs
Gibt zurück, ob derzeit eine zeitgesteuerte Aktion ausgeführt wird.
Hier finden Sie die Syntax für diese Methode:
trackingTimedActionExistsJs(name)
name
String
Hier finden Sie ein Code-Beispiel für diese Methode:
var actionExists = ADBMobile.trackTimedActionExistsJs(‘level1’);
trackingIdentifier
Gibt die automatisch generierte Besucher-ID zurück.
Hierbei handelt es sich um eine App-spezifische eindeutige Besucher-ID, die von Adobe-Servern generiert wird. Wenn die Adobe-Server zum Zeitpunkt der Generierung nicht erreicht werden können, wird die ID mithilfe der Apple-CFUUID von generiert. Der Wert wird beim ersten Start generiert und ab diesem Zeitpunkt gespeichert und verwendet. Diese ID wird zwischen App-Upgrades beibehalten, während des standardmäßigen Sicherungsprozesses der Anwendung gespeichert und wiederhergestellt sowie beim Deinstallieren der App entfernt.
Wenn für Ihre App ein Upgrade vom Experience Cloud-SDK 3.x auf 4.x vorgenommen wird, wird die vorherige benutzerdefinierte oder automatisch generierte Besucher-ID abgerufen und als die benutzerdefinierte Benutzer-ID gespeichert. Dadurch werden Besucherdaten zwischen SDK-Upgrades beibehalten. Für neue Installationen für das SDK der Version 4.x lautet die Benutzer-ID nil
und die Tracking-ID wird verwendet. Weitere Informationen finden Sie unten in der Zeile userIdentifier.
Hier finden Sie die Syntax für diese Methode:
trackingIdentifier()
String
Hier finden Sie ein Code-Beispiel für diese Methode:
var trackingId = ADBMobile.trackingIdentifier();
trackingSendQueuedHits
Erzwingt in der Bibliothek das Senden aller Zugriffe aus der Offline-Warteschlange, unabhängig von der Anzahl der Zugriffe.
Hier finden Sie die Syntax für diese Methode:
trackingSendQueuedHits()
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.trackingSendQueuedHits();
trackingClearQueue
Löscht alle Zugriffe aus der Offline-Warteschlange.
Hier finden Sie die Syntax für diese Methode:
trackingClearQueue()
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.trackingClearQueue();
trackingGetQueueSize
Ruft die Anzahl der Zugriffe ab, die sich derzeit in der Offline-Warteschlange befinden.
Hier finden Sie die Syntax für diese Methode:
trackingGetQueueSize()
Hier finden Sie ein Code-Beispiel für diese Methode:
var queueSize = ADBMobile.trackingGetQueueSize();
audienceVisitorProfile
Gibt das zuletzt erfasste Besucherprofil zurück.
Gibt null zurück, falls noch kein Signal übertragen wurde. Das Besucherprofil wird in NSUserDefaults
gespeichert und steht so bei jedem Start der App zur Verfügung.
Hier finden Sie die Syntax für diese Methode:
audienceVisitorProfile()
Hier finden Sie ein Code-Beispiel für diese Methode:
var profile = ADBMobile.audienceVisitorProfile();
audienceDpid
Gibt die aktuelle DPID zurück.
Hier finden Sie die Syntax für diese Methode:
audienceDpid()
Hier finden Sie ein Code-Beispiel für diese Methode:
var dpid = ADBMobile.audienceDpid();
audienceDpuuid
Gibt die aktuelle DPUUID zurück.
Hier finden Sie die Syntax für diese Methode:
audienceDpuuid()
String
Hier finden Sie ein Code-Beispiel für diese Methode:
var dpuuid = ADBMobile.audienceDpuuid();
audienceSetDpidDpuuid
Legt die dpid und dpuuid fest und wenn sie festgelegt wurden, werden Sie bei jedem Signal gesendet.
Hier finden Sie die Syntax für diese Methode:
audienceSetDpidDpuuid(dpid, dpuuid)
dpid
String
dpuuid
String
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.audienceSetDpidDpuuid(‘myDpid’, ‘userDpuuid’);
audienceSignalWithDataJsCallback
Sendet Audience Manager ein Signal mit Eigenschaften und ruft die passenden Segmente ab, die in einer Callback-Funktion zurückgegeben werden.
Hier finden Sie die Syntax für diese Methode:
audienceSignalWithDataJsCallback(traits [, callback])
traits
callback
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.audienceSignalWithDataJsCallback({‘trait’:’something’},
function(profile) {
//do something with the user’s segments found in profile
});
audienceReset
Setzt die Audience Manager-UUID zurück und löscht das aktuelle Besucherprofil.
Hier finden Sie ein Code-Beispiel für diese Methode:
audienceReset()
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.audienceReset();
visitorMarketingCloudID
Ruft die Experience Cloud ID vom ID-Service ab.
Hier finden Sie die Syntax für diese Methode:
visitorMarketingCloudID()
Hier finden Sie ein Code-Beispiel für diese Methode:
var mcid = ADBMobile.visitorMarketingCloudID();
visitorSyncIdentifiers
Zusätzlich zur Experience Cloud-ID können Sie weitere Kunden-IDs festlegen, die jedem Besucher zugeordnet werden können. Die Besucher-API akzeptiert mehrere Kunden-IDs für denselben Besucher sowie eine Kundentypkennung, die den Umfang der einzelnen Kunden-IDs abgrenzt. Diese Methode entspricht setCustomerIDs in der JavaScript-Bibliothek.
Hier finden Sie die Syntax für diese Methode:
visitorSyncIdentifiers(identifiers)
Gibt Folgendes zurück: N/A
Parameter: identifiers
Object
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.visitorSyncIdentifiers({‘idType’:’idValue’});
visitorSyncIdentifiersAuthenticationState
Synchronisiert die bereitgestellten IDs mit dem ID-Service.
Hier finden Sie die Syntax für diese Methode:
visitorSyncIdentifiersAuthenticationState(identifiers, authState)
identifiers
Object
authState
ADBMobileVisitorAuthenticationStateUnknown
ADBMobileVisitorAuthenticationStateAuthenticated
ADBMobileVisitorAuthenticationStateLoggedOut
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.visitorSyncIdentifiersAuthenticationState({'myIdType':'valueForUser'}, ADBMobileVisitorAuthenticationStateLoggedOut)
visitorSyncIdentifierWithTypeIdentifierAuthenticationState
Synchronisiert den bereitgestellten ID-Typ und -Wert mit dem ID-Service.
Hier finden Sie die Syntax für diese Methode:
visitorSyncIdentifierWithTypeIdentifierAuthenticationState(idType, identifier, authState)
idType
String
identifier
String
authState
ADBMobileVisitorAuthenticationStateUnknown
ADBMobileVisitorAuthenticationStateAuthenticated
ADBMobileVisitorAuthenticationStateLoggedOut
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.visitorSyncIdentifierWithTypeIdentifierAuthenticationState('myIdType', 'valueForUser',
ADBMobileVisitorAuthenticationStateAuthenticated);
visitorGetIDsJs
Ruft ein Array schreibgeschützter ADBVisitorID-Objekte ab. Der folgende Code ist ein Beispiel eines „VisitorID“-Objekts:
{
idType: "abc",
authenticationState: 1,
identifier: "123"
}
Hier finden Sie die Syntax für diese Methode:
visitorGetIDsJs()
Rückgabe: Array [Object]
Parameter: Ohne
Hier finden Sie ein Code-Beispiel für diese Methode:
var myVisitorIds = ADBMobile.visitorGetIDsJs();
targetThirdPartyID
Gibt die Drittanbieter-ID zurück.
Hier finden Sie die Syntax für diese Methode:
targetThirdPartyID()
String
Hier finden Sie ein Code-Beispiel für diese Methode:
var thirdPartyID = ADBMobile.targetThirdPartyID();
targetSetThirdPartyID
Legt die Drittanbieter-ID fest.
Hier finden Sie die Syntax für diese Methode:
targetSetThirdPartyID(thirdPartyID)
thirdPartyID
String
Hier finden Sie ein Code-Beispiel für diese Methode:
ADBMobile.targetSetThirdPartyID(‘thirdPartyID’);
targetPcID
Gibt die PcID zurück.
Hier finden Sie die Syntax für diese Methode:
targetPcID()
String
Hier finden Sie ein Code-Beispiel für diese Methode:
var pcID = ADBMobile.targetPcID();
targetSessionID
Gibt die Sitzungs-ID zurück.
Hier finden Sie die Syntax für diese Methode:
targetSessionID()
String
Hier finden Sie ein Code-Beispiel für diese Methode:
var sessionID = ADBMobile.targetSessionID();