PhoneGap-Plug-in-Methoden

Sie können PhoneGap-Plug-in-Methoden in Android zum Durchführen einer Vielzahl von Aufgaben verwenden.

Fügen Sie in html-Dateien, in denen Sie die Verfolgung nutzen möchten, das Tag <head> ein:

<script type="text/javascript" charset="utf-8" src="ADB_Helper.js"></script>

Konfigurationsmethoden

  • getPrivacyStatus

    Gibt den Datenschutzstatus für den aktuellen Benutzer zurück.

    Folgende Status stehen zur Verfügung:

    • ADB.optedIn: Diese Treffer werden sofort gesendet.

    • ADB.optedOut: Diese Treffer werden verworfen.

    • ADB.optUnknown: Wenn für Ihre Report Suite Zeitstempel aktiviert sind, werden Treffer so lange gespeichert, bis der Datenschutzstatus in „opt-in“ (Treffer werden gesendet) oder „opt-out“ (Treffer werden verworfen) geändert wird. Wenn für Ihre Report Suite keine Zeitstempel aktiviert sind, werden die Treffer verworfen, bis der Datenschutzstatus zu „optedin“ geändert wird.

      Der Standardwert wird in der Datei ADBMobileConfig.json festgelegt.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      getPrivacyStatus(function (value) { myTempVal = value; }, function () {myTempVal = null;}); 
      
  • setPrivacyStatus

    Legt für den aktuellen Benutzer den Datenschutzstatus status fest.

    Sie können einen der folgenden Status festlegen:

    • ADB.optedIn: Diese Treffer werden sofort gesendet.

    • ADB.optedOut: Diese Treffer werden verworfen.

    • ADB.optUnknown: Wenn für Ihre Report Suite Zeitstempel aktiviert sind, werden Treffer so lange gespeichert, bis der Datenschutzstatus in „opt-in“ (Treffer werden gesendet) oder „opt-out“ (Treffer werden verworfen) geändert wird. Wenn für Ihre Report Suite keine Zeitstempel aktiviert sind, werden die Treffer verworfen, bis der Datenschutzstatus zu „optedin“ geändert wird.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.setPrivacyStatus('ADB.optedIn');
      
  • getLifetimeValue

    Gibt den Lebenszeitwert für den aktuellen Benutzer zurück. Der Standardwert lautet 0.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.getLifetimeValue(function (value) { myTempVal = value }, function () { myTempVal = null; }); 
      
  • setDebugLogging

    Aktiviert (true) oder deaktiviert (false) die Anzeige von Debugging-Informationen. Für die Variable ist standardmäßig false festgelegt.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.setDebugLogging(true);
      
  • getVersion

    Ruft die Bibliotheksversion ab.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.getVersion(function (value) { versionNum = value }, function () { versionNum = 1.0;});
      
  • trackingIdentifier

    Gibt die automatisch generierte Besucher-ID zurück.

    Hierbei handelt es sich um eine App-spezifische Unique Visitor-ID, die beim ersten Start der App generiert und ab diesem Zeitpunkt gespeichert und verwendet wird. Diese ID bleibt zwischen App-Upgrades erhalten und wird entfernt wenn die App deinstalliert wird.

    TIPP

    Bei einem App-Upgrade von Experience Cloud 3.x auf Version 4.x des SDK wird die vorherige Besucher-ID (benutzerdefiniert oder automatisch generiert) abgerufen und als die benutzerdefinierte Benutzer-ID gespeichert. Weitere Informationen finden Sie unten unter getUserIdentifier. Diese ID bewahrt Besucherdaten bei SDK-Upgrades auf.

    Für neue Installationen für das SDK der Version 4.x lautet die Benutzer-ID null und die Tracking-ID wird verwendet.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.trackingIdentifier(function (value) { myTempVal = value; }, function () { myTempVal = null; }); 
      
  • getUserIdentifier

    Wenn eine Kunden-ID festgelegt wurde, wird diese ID zurückgesendet. Wenn keine ID festgelegt wurde, wird null zurückgesendet. Der Standardwert lautet null.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      getUserIdentifier(function(value) { myTempVal = value; }, function () { myTempVal = null; });
      
  • setUserIdentifier

    Legt die Benutzerkennung auf identifier fest.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.setUserIdentifier('testUser');
      
  • setPushIdentifier

    Legt das Geräte-Token für Push-Benachrichtigungen fest.

    getUserIdentifier(function (value) { myTempVal = value; }, function () { myTempVal = null; });
    
    • Hier finden Sie die Syntax für diese Methode:

      ADB.setPushIdentifier(pushIdentifier, success, fail);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.setPushIdentifier('test_push_identifier',function (value) { alert('success'); },function (value) { alert('fail'); }); 
      
  • keepLifecycleSessionAlive

    Legt den Keepalive-Wert der Lebenszyklussitzung fest.

    WICHTIG

    Der Aufruf von keepLifecycleSessionAlive verhindert, dass Ihre App eine neue Sitzung startet, wenn sie aus dem Hintergrund fortgesetzt wird. Sie sollten diese Methode nur verwenden, wenn Ihre App für Benachrichtigungen im Hintergrund registriert ist.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.keepLifecycleSessionAlive(); 
      
  • trackingSendQueuedHits

    Zwingt die Bibliothek, alle Treffer in der Warteschlange unabhängig von aktuellen Batch-Optionen zu senden.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.trackingSendQueuedHits();
      
  • trackingGetQueueSize

    Ruft die Anzahl der in der Offline-Warteschlange gespeicherten Verfolgungsaufrufe ab oder legt diese fest.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.trackingGetQueueSize(function (value) { myTempVal = value;}, function () { myTempVal = null;}); 
      
  • trackingClearQueue

    Entfernt sämtliche in der Offline-Warteschlange gespeicherten Verfolgungsaufrufe.

    WARNUNG

    Gehen Sie beim manuellen Leeren der Warteschlange vorsichtig vor. Dieser Vorgang kann nicht rückgängig gemacht werden.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.trackingClearQueue(function (value) { myTempVal = value; }, function () { myTempVal = null; }); 
      

PII-Methoden

  • collectPII

    Sendet eine Anfrage zur Erfassung personenbezogener Daten.

    • Hier finden Sie die Syntax für diese Methode:
    ADB.collectPII(piiData,success, fail);
    
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.collectPII({'k1':'v1','k2':'v2','k3':'v3'}, function (value) { alert('success') },function (value) { alert('fail') ;});
      

Tracking-Methoden

  • trackAdobeDeepLink

    Verfolgt einen Adobe-Deep-Link-Clickthrough.

    TIPP

    Wenn es sich bei dem Lebenszyklusaufruf um ein Startereignis handelt, werden die Adobe-Linkdaten automatisch angehängt. Andernfalls wird ein zusätzlicher Aufruf gesendet.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.trackAdobeDeepLink(deeplinkURL, success, fail); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.trackAdobeDeepLink('xyz-deeplink-url',function (value) { alert('success'); },function (value) { alert('fail') }); 
      
  • trackState

    Verfolgt einen App-Status mit optionalen Kontextdaten. Die Statusangaben entsprechen den verfügbaren Ansichten in der App, z. B. home dashboard, app settings und cart. Diese Statusangaben sind mit den Seiten in einer Website vergleichbar, und trackState-Aufrufe inkrementieren die Seitenansichten.

    cData: JSON-Objekt mit Schlüsselwertpaaren, die in den Kontextdaten gesendet werden.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.trackState(string stateName[,JSON cData]);
      
    • Hier finden Sie Code-Beispiele für diese Methode:

        ADB.trackState("login&amp;nbsp;page"); 
      
        ADB.trackState("login page", {"user":"john","remember":"true"});
      
  • trackAction

    Verfolgt eine Aktion in der App. Aktionen, wie z. B. logins, banner taps, feed subscriptions und andere Metriken, die in Ihrer App auftreten und die Sie messen möchten.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.trackAction(string action[,JSON cData]); 
      
    • Hier finden Sie Code-Beispiele für diese Methode:

        ADB.trackAction("login");
      
        ADB.trackAction("login", {"user":"john","remember":"true"}); 
      
  • trackLocation

    Sendet die aktuellen XY-Koordinaten. Ermittelt außerdem anhand der in der Datei ADBMobileConfig.json definierten Zielpunkte (POI), ob der als Parameter angegebene Standort in einem vorhandenen Zielpunkt liegt. Falls die aktuellen Koordinaten auf einen definierten POI passen, wird eine Kontextdatenvariable gefüllt und zusammen mit dem trackLocation-Aufruf gesendet.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.trackLocation(x, y[,JSON cData]); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.trackLocation('40.431596', '-111.893713'); 
      
  • trackLifetime​ValueIncrease

    Erhöht den Lebenszeitwert des Benutzers um amount.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.trackLifetimeValueIncrease(amount[,JSON cData]); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.trackLifetimeValueIncrease('10.01'); 
      
  • trackTimed​ActionStart

    Starten Sie eine zeitgesteuerte Aktion mit dem Namen action.

    Wenn Sie diese Methode für eine bereits gestartete Methode aufrufen, wird die vorherige zeitgesteuerte Aktion überschrieben.

    TIPP

    Dieser Aufruf sendet keinen Treffer.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.trackTimedActionStart(action[,JSON cData]);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.trackTimedActionStart("cartToCheckout"); 
      
  • trackTimed​ActionUpdate

    Übergeben Sie diesen Wert in cData, um die Kontextdaten zu aktualisieren, die der action zugewiesen sind.

    Die übergebenen Daten ( cData ) werden an die vorhandenen Daten für die Aktion angehängt und wenn der Schlüssel bereits für action definiert ist, werden die Daten überschrieben.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.trackTimedActionUpdate(String action[,JSON cData]);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.trackTimedActionUpdate("cartToCheckout",{'SampleContextDataKey3':'SampleContextDataVal3','SampleContextDataKey4':'SampleContextDataVal4'});
      
  • trackTimed​ActionEnd

    Beendet eine zeitgesteuerte Aktion.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.trackTimedActionEnd("cartToCheckout"); 
      
  • trackingTimedActionExists

    Gibt zurück, ob derzeit eine zeitgesteuerte Aktion ausgeführt wird.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.trackingTimedActionExists(function (value) { myTempVal = value }, function () { myTempVal = null; }); 
      

Beacon-Methoden

  • trackBeacon

    Verfolgt das Eintreten eines Benutzers in den Radius eines Beacons.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.trackBeacon(uuid, major, minor, proximity, cData) 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.trackBeacon('2F234454-CF6D-4A0F-ADF2-F4911BA9FFA6', 1, 2, 
      ADB.beaconUnknown, {'hp':'hp_val','hp.company':'adobe'}
      
  • clearCurrentBeacon

    Löscht die Beacon-Daten, sobald der Benutzer den Radius des Beacons verlässt.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.clearCurrentBeacon(success, fail)
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.clearCurrentBeacon(); 
      

Target-Methoden

  • targetLoadRequest

    Sendet eine Anfrage an Ihren konfigurierten Target-Server und gibt den Zeichenfolgenwert des Angebots zurück.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.targetLoadRequest(success, fail, name, defaultContent, parameters);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.targetLoadRequest(function&nbsp;(value)
      {myTempVal = value }, function () { myTempVal = null;},'bannerOffer', 'none', {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'}); 
      
  • targetLoadOrderConfirmRequest

    Sendet eine Anfrage an Ihren konfigurierten Target-Server.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.targetLoadOrderConfirmRequest(success, fail name orderId, orderTotal, productPurchaseId, parameters); 
      
    • Hier finden Sie die Syntax für diese Methode:

      ADB.targetLoadRequest(function (value) { myTempVal = value }
      , function ()
      { myTempVal = null; } 
      , 'name' 'orderId' 'total', 'purchaseId',
      {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'}
      ); 
      
  • targetClearCookies

    Löscht die Target-Cookies aus dem gemeinsamen Cookie-Speicher.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.targetClearCookies(); 
      
  • targetLoadRequestWithNameWithLocationParameters

    Verarbeitet eine Target-Serviceanfrage.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.targetLoadRequestWithNameWithLocationParameters(
        success, fail, name, defaultContent, profileParameters, orderParameters, mboxParameters requestLocationParameters
        ); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.targetLoadRequestWithNameWithLocationParameters  (function () { alert('success'); }, function () { alert('fail'); }, ;'bannerOffer', 'none', {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'}, {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'},{'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'},{'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'});
      
  • targetLoadRequestWithName

    Verarbeitet eine Target-Serviceanfrage.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.targetLoadRequestWithRequestName(success, fail, name, defaultContent, profileParameters, orderParameters, mboxParameters);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.targetLoadRequestWithName(
      function (value){ // handle target success} ,
      function() { // handle target failure }, 
      "mboxName",
      "defaultContent",
      {"profileParameters":"profileParametervalues"}
      {"orderId" : "32FGJ4XK" , "orderTotal" : "123.33" , "purchasedProductIds":"[46,34]" }
      {"mboxParameters":"mboxParametersvalues"}
      );
      
  • targetSessionID

    Ruft den Wert des Cookies SessionID ab, das für diesen Besucher vom Target-Server zurückgegeben wurde.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.targetSessionID (success, fail); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.targetSessionID(function (value) { alert(value) },function (value){ alert('fail'); });  
      
  • targetPcID

    Ruft den Wert des Cookies PcID ab, das für diesen Besucher vom Target-Server zurückgegeben wurde.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.targetPcID (success, fail); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.targetPcID(function  (value) { alert(value) },function (value) { alert('fail'); });
      
  • targetSetThirdPartyID

    Legt die benutzerdefinierte Besucher-ID für Target fest.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.targetSetThirdPartyID(thirdPartyID, success, fail); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.targetSetThirdPartyID('test-third-party-id' function (value) { alert('success'); },function (value) { alert('fail'); }); 
      
  • targetThirdPartyID

    Ruft die benutzerdefinierte Besucher-ID für Target ab.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.targetThirdPartyID(success, fail);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

       ADB.targetThirdPartyID(function (value) { alert(value); },function (value) { alert('fail')__;});
      

Akquisemethoden

  • acquisitionCampaignStartForApp

    Sendet eine Anfrage an Ihren konfigurierten Target-Server und gibt den Zeichenfolgenwert des Angebots zurück.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.acquisitionCampaignStartForApp(appId, data, success, fail); 
      
    • Hier finden Sie Code-Beispiele für diese Methode:

      ADB.acquisitionCampaignStartForApp(“appId”, {‘key’:‘value’}, function() {…}, function() {…}));
      
      ADB.acquisitionCampaignStartForApp(“appId”, {‘key’:‘value’});  
      

Advertising-ID

Rufen Sie in der von Cordova generierten Hauptaktivität Config.submitAdvertisingIdentifierTask() in der Methode onResume() auf. Weitere Informationen finden Sie unter Konfigurationsmethoden.

Audience Manager-Methoden

  • audienceGetVisitorProfile

    Ruft das Besucherprofil ab.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.audienceGetVisitorProfile(); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.audienceGetVisitorProfile(function(value) { profile = value;}, function() { profile = null; }); 
      
  • audienceGetDpuuid

    Gibt die DPUUID zurück.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.audienceGetDpuuid(success fail);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.audienceGetDpuuid(function(value) { dpuuid = value;}, function(){dpuuid = null; }); 
      
  • audienceGetDpid

    Gibt die DPID zurück.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.audienceGetDpid(success, fail);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.audienceGetDpid(function(value){dpid = value;}, function() {dpid =  null;}); 
      
  • audienceSetDpidAndDpuuid

    Legt die DPID und die DPUUID fest.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.audienceSetDpidAndDpuuid(dpid, dpuuid, success, fail); 
      
    • Hier finden Sie Code-Beispiele für diese Methode:

      ADB.audienceSetDpidAndDpuuid(‘dpid’, ‘dpuuid’, function() {…}, function(){…};
      
      ADB.audienceSetDpidAndDpuuid(‘dpid’, ‘dpuuid’); 
      
  • audienceSignalWithData

    Verarbeitet eine Audience Manager-Dienstanforderung.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.audienceSignalWithData(success, fail, data);
      
    • Hier finden Sie Code-Beispiele für diese Methode:

       ADB.audienceSignalWithData(function() {}, function() {} {‘key1’: ’value1’ ‘key2’: ‘value2’}); 
      
      ADB.audienceSignalWithData({‘key1’: ’value1’, ‘key2’:‘value2’}); 
      
  • audienceReset

    Audience Manager-UUID und löscht das aktuelle Besucherprofil.

    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.audienceReset();
      

ID-Dienst-Methoden

  • visitorGetMarketingCloudId

    Gibt die Experience Cloud ID vom ID-Service zurück.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.visitorGetMarketingCloudId(success, fail); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.visitorGetMarketingCloudId(function (value) { mcid = value;},function (){ mcid = null;});
      
  • visitorSyncIdentifiers

    Synchronisiert die bereitgestellten IDs mit dem ID-Service.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.visitorSyncIdentifiers(identifiers, success, fail); 
      
    • Hier finden Sie Code-Beispiele für diese Methode:

      ADB.visitorSyncIdentifiers({‘key_id_1’:’value_id_1’}, function() {…}, function() {…}));
      
      ADB.visitorSyncIdentifiers({‘key_id_1’: ‘value_id_1’});  
      
  • visitorSyncIdentifiersWithAuthenticationState

    Synchronisiert die bereitgestellten IDs mit dem ID-Service.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.visitorSyncIdentifiersWithAuthenticationState
      (identifiers, authenticationState, success, fail); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.visitorSyncIdentifiersWithAuthenticationState({'k1':'v1','k2':'v2','k3':'v3'}, ADB.mobileVisitorAuthenticationStateAuthenticated, function (value) { alert('success'); },function (value) { alert('fail'); }); 
      
  • visitorSyncIdentifierWithType

    Synchronisiert die angegebene Kennung mit dem ID-Dienst.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.visitorSyncIdentifierWithType(identifierType, identifier authenticationState, success, fail); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.visitorSyncIdentifierWithType('test-identifier-type', 'test-identifier', ADB.mobileVisitorAuthenticationStateAuthenticated, function (value) { alert('success') },function (value) { alert('fail'); }); 
      
  • visitorAppendToURL

    Hängt die Besucherkennungen an die angegebene URL an.

    • Hier finden Sie die Syntax für diese Methode:

       ADB.visitorAppendToURL(urlToAppend, success, fail); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.visitorAppendToURL('test_visitor_url', function (value) alert(value);},'');
      
  • visitorGetIDs

    Gibt alle visitorIDs zurück, die synchronisiert wurden.

    • Hier finden Sie die Syntax für diese Methode:

      ADB.visitorGetIDs (success, fail);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADB.visitorGetIDs(function (value) { alert(value); },function (value) { alert('fail') ;}); 
      

Auf dieser Seite

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free