Zur iOS-Bibliothek der Version 4.x migrieren

Diese Informationen helfen Ihnen beim Migrieren von den Versionen 3.x oder 2.x zu Version 4.x der iOS-Bibliothek.

WICHTIG

Das SDK verwendet NSUserDefaults zum Speichern von Daten, die zur Berechnung von Unique Users und Lebenszyklusmetriken benötigt werden, und anderen mit SDK-Hauptfunktionen verbundenen Daten. Wenn Sie in NSUserDefaults die Werte, die vom SDK erwartet werden, ändern oder entfernen, kann dies zu unerwartetem Verhalten in Form von Dateninkonsistenzen führen.

In Version 4.x der iOS-SDK-Bibliothek sind alle öffentlichen Methoden in einem Header vereinigt. Außerdem steht die Funktionalität jetzt auch über Methoden auf Klassenebenen zur Verfügung, damit Sie Pointer, Instanzen und Singletons nicht verfolgen müssen.

Events, Props und eVars

In Version 4 können Sie in Ihrer App keine Variablen, wie z. B. Ereignisse, eVars, Props, Erben und Listen, mehr direkt zuweisen. Stattdessen verwendet das SDK Kontextdaten und Verarbeitungsregeln, um Ihre App-Daten Analytics-Variablen für die Berichterstellung zuzuordnen.

Verarbeitungsregeln bieten folgende Vorteile:

  • Sie können Ihre Datenzuordnung ändern, ohne eine Aktualisierung an den Appstore zu senden.

  • Sie können aussagekräftige Namen für Daten verwenden, anstatt Variablen festzulegen, die für eine Report Suite spezifisch sind.

  • Das Senden zusätzlicher Daten hat geringe Auswirkungen.

    Diese Werte werden erst dann in Berichten angezeigt, wenn sie mithilfe von Verarbeitungsregeln zugeordnet werden.

TIPP

Werte, die Sie direkt Variablen zuweisen, sollten nun zum NSDictionary data hinzugefügt werden.

Ungenutzte Eigenschaften entfernen

Die neue Datei ADBMobileConfig.json enthält anwendungsspezifische, globale Einstellungen und ersetzt die meisten Konfigurationsvariablen, die in vorherigen Versionen zum Einsatz kamen. Im Folgenden finden Sie ein Beispiel für eine ADBMobileConfig.json-Datei:

{ 
    "version" : "1.0", 
    "analytics" : { 
        "rsids" : "coolApp", 
        "server" : "my.CoolApp.com", 
        "charset" : "UTF-8", 
        "ssl" : true, 
        "offlineEnabled" : true, 
        "lifecycleTimeout" : 5, 
        "privacyDefault" : "optedin", 
        "poi" : [ 
                    ["san francisco",37.757144,-122.44812,7000], 
                    ["santa cruz",36.972935,-122.01725,600] 
                ] 
    }, 
 "target" : { 
  "clientCode" : "myTargetClientCode", 
  "timeout" : 5 
 }, 
 "audienceManager" : { 
  "server" : "myServer.demdex.com" 
 } 
}

Verschieben der Konfigurationsdatei

Verschieben der Konfigurationsdatei:

  1. Verschieben Sie den für die Variable in der ersten Spalte festgelegten Wert in die Variable in der zweiten Spalte.
  2. Entfernen Sie die alte Konfigurationsvariable aus Ihrem Code.

Migrationsinformationen

Die folgende Tabelle enthält die Konfigurationsvariablen, die Sie in die Konfigurationsdatei verschieben müssen.

Migration von Version 3.x

Verschieben Sie den Wert aus der ersten Spalte in die Variable in der zweiten Spalte.

Konfigurationsvariable Variable in der Datei ADBMobileConfig.json
offlineTrackingEnabled „offlineEnabled“
offlineHitLimit „batchLimit“
reportSuiteIDs „rsids“
trackingServer „server“
charSet „charset“
currencyCode „currency“
ssl „ssl“
linkTrackVars Entfernen, wird nicht mehr verwendet.
linkTrackEvents Entfernen, wird nicht mehr verwendet.

Migration von Version 2.x

Verschieben Sie den Wert aus der ersten Spalte in die Variable in der zweiten Spalte.

Konfigurationsvariable Variable in der Datei ADBMobileConfig.json
trackOffline „offlineEnabled“
offlineLimit „batchLimit“
account „rsids“
trackingServer „server“, Präfix "https://" entfernen. Das Protokollpräfix wird basierend auf der Einstellung „ssl“ automatisch hinzugefügt.
trackingServerSecure Entfernen. Definieren Sie für sichere Verbindungen „Server“ und aktivieren Sie dann „ssl“.
charSet „charset“
currencyCode „currency“
ssl „ssl“
linkTrackVars Entfernen, wird nicht mehr verwendet.
linkTrackEvents Entfernen, wird nicht mehr verwendet.
timestamp Entfernen, ist nicht mehr konfigurierbar.
dc Entfernen, wird nicht mehr verwendet.
userAgent Entfernen, ist nicht mehr konfigurierbar.
dynamicVariablePrefix Entfernen, wird nicht mehr verwendet.
visitorNamespace Entfernen, wird nicht mehr verwendet.
usePlugins Entfernen, wird nicht mehr verwendet.
useBestPractices Alle Aufrufe für massenhafte Messung (getChurnInstance) Entfernen: Durch Lebenszyklusmetriken ersetzt. Weitere Informationen finden Sie unter Lebenszyklusmetriken.

Verfolgungsaufruf und -variablen aktualisieren

Anstelle der auf das Web ausgelegten Aufrufe track und trackLink verwendet Version 4 des SDK folgende Methoden:

  • trackState:data: 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.

  • trackAction:data: Aktionen, wie z. B. logons, banner taps, feed subscriptions und andere Metriken, die in Ihrer App auftreten und die Sie messen möchten.

Beim Parameter data für beide dieser Methoden handelt es sich um ein NSDictionary, das Namen-Wert-Paare enthält, die als Kontextdaten gesendet werden.

Events, Props und eVars

In Version 4 können Sie in Ihrer App keine Variablen, wie z. B. Ereignisse, eVars, Props, Erben und Listen, mehr direkt zuweisen. Das SDK verwendet jetzt Kontextdaten und Verarbeitungsregeln, um Ihre App-Daten Analytics-Variablen für die Berichterstellung zuzuordnen.

Verarbeitungsregeln bieten folgende Vorteile:

  • Sie können Ihre Datenzuordnung ändern, ohne eine Aktualisierung an den Appstore zu senden.

  • Sie können aussagekräftige Namen für Daten verwenden, anstatt Variablen festzulegen, die für eine Report Suite spezifisch sind.

  • Das Senden zusätzlicher Daten hat geringe Auswirkungen.

    Diese Werte werden erst dann in Berichten angezeigt, wenn sie mithilfe von Verarbeitungsregeln zugeordnet werden. Weitere Informationen finden Sie unter Verarbeitungsregeln und Kontextdaten.

Werte, die Sie direkt zu Variablen zugewiesen haben, sollten stattdessen zum data NSDictionary hinzugefügt werden. Aufrufe zu setProp, setEvar und Zuweisungen zu persistenten Kontextdaten sollten entfernt und die Daten dem Parameter data hinzugefügt werden.

AppSection/Server, GeoZip, Transaktions-ID, Kampagne und andere Standardvariablen

Daten, die Sie im Messobjekt festgelegt haben, einschließlich der oben aufgeführten Variablen, sollten stattdessen zum data NSDictionary hinzugefügt werden. Die einzigen Daten, die mit dem Aufruf trackState oder trackAction gesendet werden, beinhalten die Nutzlast des Parameters data.

Verfolgungsaufrufe ersetzen

Ersetzen Sie in Ihrem Code folgende Methoden durch einen Aufruf von trackState oder trackAction:

Migration von Version 3.x

  • trackAppState (trackState)
  • trackEvents (trackAction)
  • track (trackAction)
  • trackWithContextData (trackAction)
  • trackLinkURL (trackAction)

Migration von Version 2.x

  • track (trackState)
  • trackLink (trackAction)

Benutzerspezifische Besucher-ID

Ersetzen Sie die Variable visitorID durch einen Aufruf von setUserIdentifier:.

Offline-Verfolgung

Die Offline-Verfolgung wird in der Datei ADBMobileConfig.json aktiviert. Alle anderen Offline-Konfigurationen erfolgen automatisch.

Entfernen Sie aus Ihrem Code Aufrufe folgender Methoden:

Version 3.x

  • setOnline
  • setOffline

Version 2.x

  • forceOffline
  • forceOnline

Variable „products“

Da die Variable „products“ in Verarbeitungsregeln nicht verfügbar ist, können Sie die folgende Syntax zum Festlegen von products verwenden:

//create a processing rule to set the corresponding product event. 
// for example, set prodView event when context data a.action = "product view" 
[ADBMobile trackAction:@"LikeButtonClicked"  
                  data:@{@"&&products" : @";Cool Shoe"}];

Auf dieser Seite