Show Menu
ARGOMENTI×

Metodi di configurazione

Elenco di metodi forniti dalla libreria iOS.
L'SDK supporta attualmente più soluzioni Adobe Experience Cloud, tra cui Analytics, Target, Audience Manager e il servizio Adobe Experience Platform Identity.
  • setAppExtensionType
    Configura l’impostazione Adobe Mobile SDK per determinare il tipo di estensione attualmente in esecuzione.
    Imposta uno dei valori seguenti:
    • ADBMobileAppExtensionTypeRegular - l'estensione è inclusa in un pacchetto con un'app contenitore.
    • ADBMobileAppExtensionTypeStandAlone - l'estensione non è inclusa in un pacchetto con un'app contenitore.
    Usa questo metodo solo se l'app ha un'estensione o se si tratta di un'estensione autonoma. Per ulteriori informazioni, consulta ADBMobileAppExtensionType , di seguito.
    • Di seguito è riportata la sintassi per questo metodo:
      + (void) setAppExtensionType:(ADBMobileAppExtensionType)type;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      [ADBMobile setAppExtensionType:ADBMobileAppExtensionTypeStandAlone]; 
      
      
  • version
    Restituisce la versione corrente della libreria Adobe Mobile.
    • Di seguito è riportata la sintassi per questo metodo:
      +(NSString*) version;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      NSString*libraryVersion = [ADBMobileversion];
      
      
  • privacyStatus
    Restituisce la rappresentazione enum dello stato di privacy per l'utente corrente:
    • ADBMobilePrivacyStatusOptIn - gli hit vengono inviati immediatamente.
    • ADBMobilePrivacyStatusOptOut - gli hit vengono eliminati.
    • ADBMobilePrivacyStatusUnknown - se è abilitato il tracciamento offline, gli hit vengono salvati finché lo stato di privacy non cambia quando l'utente acconsente (opt in, gli hit vengono inviati) o rinuncia (opt out, gli hit vengono eliminati). Se il tracciamento offline non è abilitato, gli hit vengono eliminati finché lo stato di privacy non cambia quando l'utente acconsente. Il valore predefinito è impostato nel file ADBMobileConfig.json .
    • Di seguito è riportata la sintassi per questo metodo:
      + (ADBMobilePrivacyStatus) privacyStatus;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      ADBMobilePrivacyStatus privacyStatus = [ADBMobileprivacyStatus];
      
      
  • setPrivacyStatus
    Imposta lo stato di privacy per l'utente corrente su status .
    Imposta uno dei valori seguenti:
    • ADBMobilePrivacyStatusOptIn - gli hit vengono inviati immediatamente.
    • ADBMobilePrivacyStatusOptOut - gli hit vengono eliminati.
    • ADBMobilePrivacyStatusUnknown - se è abilitato il tracciamento offline, gli hit vengono salvati finché lo stato di privacy non cambia quando l'utente acconsente (opt in, gli hit vengono inviati) o rinuncia (opt out, gli hit vengono eliminati). Se il tracciamento offline non è abilitato, gli hit vengono eliminati finché lo stato di privacy non cambia quando l'utente acconsente.
    • Di seguito è riportata la sintassi per questo metodo:
      + (void) setPrivacyStatus:(ADBMobilePrivacyStatus)status;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      [ADBMobile setPrivacyStatus:ADBMobilePrivacyStatusOptIn];
      
      
  • lifetimeValue
    Restituisce il valore "lifetime" del ciclo di vita dell'utente corrente. Il valore predefinito è 0 .
    • Di seguito è riportata la sintassi per questo metodo:
      + (NSDecimalNumber *) lifetimeValue;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      NSDecimalNumber *lifeValue = [ADBMobile lifetimeValue];
      
      
  • trackingIdentifier
    Restituisce l'identificatore visitatore generato automaticamente. Si tratta di un ID visitatore univoco specifico per l’app, generato dai server Adobe. Se non è possibile raggiungere i server Adobe al momento della generazione, l’ID viene generato utilizzando l’identificatore CFUUID di Apple. Il valore viene generato al primo avvio, quindi viene memorizzato e utilizzato da tale momento in poi. Questo ID viene mantenuto nei successivi aggiornamenti dell’app, viene salvato e ripristinato durante il processo standard di backup dell’applicazione e viene rimosso al momento della disinstallazione.
    Se l'app viene aggiornata dall'SDK di Experience Cloud 3.x alla versione 4.x, l'ID precedente (personalizzato o generato in automatico) viene recuperato e memorizzato come identificatore utente personalizzato. Per ulteriori informazioni, consulta la riga userIdentifier di seguito. In tal modo i dati del visitatore vengono mantenuti da un aggiornamento all'altro dell'SDK. Per le nuove installazioni con l'SDK 4.x, l'identificatore dell'utente è nil e viene utilizzato l'identificatore di tracciamento.
    • Di seguito è riportata la sintassi per questo metodo:
      + (NSString *) trackingIdentifier;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      NSString *tid = [ADBMobile trackingIdentifier];
      
      
  • userIdentifier
    Se è stato impostato un identificatore personalizzato, viene restituito l'identificatore utente. Se non è stato impostato un identificatore personalizzato, viene restituito nil . Il valore predefinito è nil .
    Se l'app viene aggiornata dall'SDK di Experience Cloud 3.x alla versione 4.x, l'ID visitatore precedente (personalizzato o generato in automatico) viene recuperato e memorizzato come identificatore utente personalizzato. In tal modo i dati del visitatore vengono mantenuti da un aggiornamento all'altro dell'SDK.
    Per le nuove installazioni con l'SDK 4.x, l'identificatore dell'utente è nil finché non viene impostato.
    • Di seguito è riportata la sintassi per questo metodo:
      +(NSString *) userIdentifier;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      NSString *uid = [ADBMobileuserIdentifier];
      
      
  • setUserIdentifier
    Imposta l'identificatore utente su identifier .
    • Di seguito è riportata la sintassi per questo metodo:
      +(void)setUserIdentifier:(NSString*)identifier;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      [ADBMobile setUserIdentifier:@"billybob"]; 
      
      
  • debugLogging
    Restituisce l'attuale preferenza di accesso di debug. Il valore predefinito è NO .
    • Di seguito è riportata la sintassi per questo metodo:
      + (BOOL) debugLogging;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      BOOL debugging = [ADBMobile debugLogging];
      
      
  • setDebugLogging
    Imposta la preferenza per l'accesso di su debug debug.
    • Di seguito è riportata la sintassi per questo metodo:
      + (void) setDebugLogging:(BOOL)debug;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      [ADBMobile setDebugLogging:YES];
      
      
  • keepLifecycleSessionAlive
    Indica all'SDK che la prossima ripresa dal background non rappresenta l'avvio di una nuova sessione, indipendentemente dal valore di timeout della sessione del ciclo di vita nel file di configurazione.
    Questo metodo è destinato alle app che si registrano per le notifiche mentre sono in background e dovrebbe essere invocato solo dal codice in esecuzione mentre l'app è in background.
    • Di seguito è riportata la sintassi per questo metodo:
      + (void) keepLifecycleSessionAlive;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      [ADBMobile keepLifecycleSessionAlive]; 
      
      
  • collectLifecycleData
    Indica all'SDK che i dati del ciclo di vita devono essere raccolti per l'utilizzo in tutte le soluzioni dell'SDK. Per ulteriori informazioni, vedi Metriche del ciclo di vita .
    La posizione preferita da cui invocare questo metodo è in application:didFinishLaunchingWithOptions: .
    • Di seguito è riportata la sintassi per questo metodo:
      + (void) collectLifecycleData;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      [ADBMobile collectLifecycleData];
      
      
  • collectLifecycleDataWithAdditionalData:
    Consente di passare dati aggiuntivi durante la raccolta delle metriche "lifecycle" sul ciclo di vita.
    Questo metodo deve essere invocato dal punto di ingresso dell'app. Se applicabile, potrebbe includere i metodi application:didFinishLaunchingWithOptions: e/o applicationWillEnterForeground: nella classe AppDelegate.
    I dati passati all'SDK tramite collectLifecycleDataWithAdditionalData: verranno memorizzati dall'SDK in NSUserDefaults . L'SDK eliminerà dal parametro NSDictionary i valori che non sono di tipo NSString o NSNumber . Per usare collectLifecycleDataWithAdditionalData: , devi disporre della versione SDK 4.4 o successiva.
    • Di seguito è riportata la sintassi per questo metodo:
      + (void) collectLifecycleDataWithAdditionalData:(nullableNSDictionary*)data; 
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      [ADBMobile collectLifecycleDataWithAdditionalData:@{@"entryType":@"appShortcutIcon"}]; 
      
      
  • pauseCollectingLifecycleData
    Utilizza questa API per mettere in pausa la raccolta dati del ciclo di vita. Per ulteriori informazioni, consulta Metriche del ciclo di vita .
    Nel metodo delegato applicationDidEnterBackground devi prima chiamare il metodo pauseCollectingLifecycleData .
    L'API attenua il problema su iPhone 7/7s o dispositivi precedenti con iOS 13, in cui la metrica della lunghezza di sessione era anormale. La causa è riconducibile ad alcune modifiche non note in iOS 13, per cui iOS non lascia abbastanza tempo per il completamento dell'attività quando l'app viene mantenuta in background.
    • Di seguito è riportata la sintassi per questo metodo:
      + (void) pauseCollectingLifecycleData;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      - (void)applicationDidEnterBackground:(UIApplication *)application{
          // manually stop the lifecycle of SDK
          // important: do NOT call any track state or track action after this line
          [ADBMobile pauseCollectingLifecycleData];   
      
      
          // the following code is optional, may help to mitigate the issue a bit more. If you have other logic to run here that probably takes more than 10ms, then there is no need to add this line of code.
          [NSThread sleepForTimeInterval:0.01];
      
      
          // app's code to handle applicationDidEnterBackground
      }
      
      
  • overrideConfigPath
    Consente di caricare un diverso file di configurazione ADBMobile JSON all’avvio dell’applicazione. La configurazione diversa viene utilizzata fino alla chiusura dell’applicazione.
    Per usare overrideConfigPath , devi disporre della versione SDK 4.2 o successiva.
    • Di seguito è riportata la sintassi per questo metodo:
       + (void) overrideConfigPath: (nullableNSString *) path;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      NSString *filePath = [[NSBundle mainBundle] pathForResource:@"ExampleJSONFile" ofType:@"json"]; 
      [ADBMobile overrideConfigPath:filePath];
      
      
  • setPushIdentifier
    Imposta il token dispositivo per le notifiche push.
    Usa questo metodo solo nel metodo application:didRegisterForRemoteNotificationsWithDeviceToken: .
    • Di seguito è riportata la sintassi per questo metodo:
      + (void) setPushIdentifier:(NSData *)deviceToken;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      - (void) application:(UIApplication *) application  didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { 
      [ADBMobile setPushIdentifier:deviceToken];  
      }
      
      
  • setAdvertisingIdentifier
    Imposta l’identificatore IDFA nell’SDK. Se l’identificatore IDFA è stato impostato nell’SDK, verrà inviato nel ciclo di vita. È inoltre possibile accedervi in Segnali (Postback).
    Recupera l'identificatore IDFA dall'API di Apple solo se utilizzi un servizio di annunci. Se recuperi l'identificatore IDFA e non lo utilizzi correttamente, l'app potrebbe venire rifiutata.
    Se l’applicazione richiede l’identificatore IDFA, consulta la documentazione di Apple per informazioni sulle preferenze dell’utente in merito al tracciamento degli annunci e per ottenere il valore IDFA.
    Per iOS 14 e versioni successive, per consentire il corretto recupero del valore IDFA è necessario implementare il nuovo framework App Tracking Transparency .
    • Di seguito è riportata la sintassi per questo metodo:
      +(void) setAdvertisingIdentifier:(NSString*)identifier;
      
      
    • Di seguito è riportato un esempio di codice per questo metodo:
      NSString *idfa = // retrieve IDFA using AdSupport (before iOS 14.0) and/or AppTrackingTransparency (iOS 14.0+)
      [ADBMobile setAdvertisingIdentifier:idfa]; 
      
      

ADBMobileAppExtensionType enum

/** 
 * @brief An enum type. 
 * The possible types of app extension you might use 
 * @see setAppExtensionType 
 */ 
typedef NS_ENUM(NSUInteger, ADBMobileAppExtensionType) { 
    ADBMobileAppExtensionTypeRegular = 0, /*!< Enum value ADBMobileAppExtensionTypeRegular. */ 
    ADBMobileAppExtensionTypeStandAlone = 1 /*!< Enum value ADBMobileAppExtensionTypeStandAlone. */ 
};