Show Menu
TEMAS×

Métodos de configuración

Esta es una lista de métodos que proporciona la biblioteca iOS.
Ahora mismo, el SDK admite varias soluciones de Adobe Experience Cloud, incluidas Analytics, Target, Audience Manager y el servicio de ID de Adobe Experience Platform.
  • setAppExtensionType
    Configura el SDK de Adobe Mobile para determinar qué clase de extensión se está ejecutando.
    Establezca uno de los siguientes valores:
    • ADBMobileAppExtensionTypeRegular : La extensión está empaquetada con una aplicación contenedora.
    • ADBMobileAppExtensionTypeStandAlone : La extensión no está empaquetada con una aplicación contenedora.
    Este método solo debe usarse si la aplicación tiene una extensión o es una extensión independiente. Para obtener más información, consulte ADBMobileAppExtensionType , más adelante.
    • Esta es la sintaxis para este método:
      + (void) setAppExtensionType:(ADBMobileAppExtensionType)type;
      
      
    • Este es un ejemplo de código para este método:
      [ADBMobile setAppExtensionType:ADBMobileAppExtensionTypeStandAlone]; 
      
      
  • version
    Devuelve la versión actual de la biblioteca de Adobe Mobile.
    • Esta es la sintaxis para este método:
      +(NSString*) version;
      
      
    • Este es un ejemplo de código para este método:
      NSString*libraryVersion = [ADBMobileversion];
      
      
  • privacyStatus
    Devuelve la representación de enumeración del estado de privacidad del usuario actual:
    • ADBMobilePrivacyStatusOptIn : las visitas se envían inmediatamente.
    • ADBMobilePrivacyStatusOptOut - las visitas se descartarán.
    • ADBMobilePrivacyStatusUnknown - si está activado el seguimiento en línea, las visitas se guardan hasta que el estado de privacidad cambia a opt-in (entonces se envían las visitas) u opt-out (entonces se descartan las visitas). Si el seguimiento en línea no está activado, las visitas se descartan hasta que el estado de privacidad cambia a opt-in. El valor predeterminado se establece en el archivo ADBMobileConfig.json .
    • Esta es la sintaxis para este método:
      + (ADBMobilePrivacyStatus) privacyStatus;
      
      
    • Este es un ejemplo de código para este método:
      ADBMobilePrivacyStatus privacyStatus = [ADBMobileprivacyStatus];
      
      
  • Método setPrivacyStatus
    Establece el estado de privacidad del usuario actual como status .
    Establezca uno de los siguientes valores:
    • ADBMobilePrivacyStatusOptIn : las visitas se envían inmediatamente.
    • ADBMobilePrivacyStatusOptOut - las visitas se descartarán.
    • ADBMobilePrivacyStatusUnknown - si está activado el seguimiento en línea, las visitas se guardan hasta que el estado de privacidad cambia a opt-in (entonces se envían las visitas) u opt-out (entonces se descartan las visitas). Si el seguimiento en línea no está activado, las visitas se descartan hasta que el estado de privacidad cambia a opt-in.
    • Esta es la sintaxis para este método:
      + (void) setPrivacyStatus:(ADBMobilePrivacyStatus)status;
      
      
    • Este es un ejemplo de código para este método:
      [ADBMobile setPrivacyStatus:ADBMobilePrivacyStatusOptIn];
      
      
  • lifetimeValue
    Devuelve el valor de duración del usuario actual. El valor predeterminado es 0 .
    • Esta es la sintaxis para este método:
      + (NSDecimalNumber *) lifetimeValue;
      
      
    • Este es un ejemplo de código para este método:
      NSDecimalNumber *lifeValue = [ADBMobile lifetimeValue];
      
      
  • trackingIdentifier
    Devuelve el identificador de visitante generado automáticamente. Se trata de un identificador de visitante exclusivo y específico para la aplicación que generan los servidores de Adobe. Si los servidores de Adobe no están disponibles en el momento de la generación, el ID se genera empleando el CFUUID de Apple. El valor se genera durante el primer inicio y se almacena y utiliza a partir de ese momento. Este ID se preserva al actualizar la aplicación, se guarda y se restaura durante el proceso estándar de copia de seguridad de la aplicación y se elimina al desinstalarla.
    Si la aplicación se actualiza del SDK 3.x al 4.x de Experience Cloud, el ID de visitante previo (personalizado o generado automáticamente) se recupera y se almacena como identificador de usuario personalizado. Para obtener más información, consulte abajo la fila userIdentifier . Esto preserva los datos de visitante al actualizar el SDK. Para nuevas instalaciones sobre el SDK 4.x, el identificador de usuario tiene el valor nil y se utiliza el identificador de seguimiento.
    • Esta es la sintaxis para este método:
      + (NSString *) trackingIdentifier;
      
      
    • Este es un ejemplo de código para este método:
      NSString *tid = [ADBMobile trackingIdentifier];
      
      
  • userIdentifier
    Si se ha establecido un identificador personalizado, se devuelve el identificador de usuario. Si no se ha definido un identificador personalizado, se devuelve nil . El valor predeterminado es nil .
    Si la aplicación se actualiza del SDK 3.x al 4.x de Experience Cloud, el ID de visitante previo (personalizado o generado automáticamente) se recupera y se almacena como identificador de usuario personalizado. De este modo, se preservan los datos de visitante tras actualizar el SDK.
    Para nuevas instalaciones sobre el SDK 4.x, el identificador de usuario es nil hasta que se establece.
    • Esta es la sintaxis para este método:
      +(NSString *) userIdentifier;
      
      
    • Este es un ejemplo de código para este método:
      NSString *uid = [ADBMobileuserIdentifier];
      
      
  • setUserIdentifier
    Establece el identificador de usuario como identifier .
    • Esta es la sintaxis para este método:
      +(void)setUserIdentifier:(NSString*)identifier;
      
      
    • Este es un ejemplo de código para este método:
      [ADBMobile setUserIdentifier:@"billybob"]; 
      
      
  • debugLogging
    Devuelve la preferencia de registro de depuración actual. El valor predeterminado es NO .
    • Esta es la sintaxis para este método:
      + (BOOL) debugLogging;
      
      
    • Este es un ejemplo de código para este método:
      BOOL debugging = [ADBMobile debugLogging];
      
      
  • setDebugLogging
    Establece la preferencia de registro de depuración en debug .
    • Esta es la sintaxis para este método:
      + (void) setDebugLogging:(BOOL)debug;
      
      
    • Este es un ejemplo de código para este método:
      [ADBMobile setDebugLogging:YES];
      
      
  • keepLifecycleSessionAlive
    Indica al SDK que la siguiente reanudación desde segundo plano no debe iniciar una nueva sesión, independientemente del valor del tiempo de espera de sesión del ciclo vital en el archivo de configuración.
    El propósito de este método es que se utilice en aplicaciones que realizan un registro de notificaciones mientras se encuentran en segundo plano, y solo debería invocarse desde el código que se está ejecutando cuando la aplicación está en segundo plano.
    • Esta es la sintaxis para este método:
      + (void) keepLifecycleSessionAlive;
      
      
    • Este es un ejemplo de código para este método:
      [ADBMobile keepLifecycleSessionAlive]; 
      
      
  • collectLifecycleData
    Indica al SDK que los datos del ciclo vital deben ser recopilados para su uso en todas las soluciones en el SDK. Para obtener más información, consulte Métricas del ciclo vital .
    La ubicación preferida para invocar este método es application:didFinishLaunchingWithOptions: .
    • Esta es la sintaxis para este método:
      + (void) collectLifecycleData;
      
      
    • Este es un ejemplo de código para este método:
      [ADBMobile collectLifecycleData];
      
      
  • collectLifecycleDataWithAdditionalData:
    Le permite pasar datos adicionales al recopilar métricas del ciclo vital.
    Se debe llamar a este método desde el punto de entrada de la aplicación. Donde sea aplicable, esto puede incluir en su clase AppDelegate uno de estos dos métodos, o ambos: application:didFinishLaunchingWithOptions: o applicationWillEnterForeground: .
    Los datos pasados al SDK mediante collectLifecycleDataWithAdditionalData: : serán guardados por el SDK en NSUserDefaults . El SDK elimina cualquier valor del parámetro NSDictionary que no sea del tipo NSString o NSNumber . Para utilizar collectLifecycleDataWithAdditionalData: necesita la versión 4.4 o posterior del SDK .
    • Esta es la sintaxis para este método:
      + (void) collectLifecycleDataWithAdditionalData:(nullableNSDictionary*)data; 
      
      
    • Este es un ejemplo de código para este método:
      [ADBMobile collectLifecycleDataWithAdditionalData:@{@"entryType":@"appShortcutIcon"}]; 
      
      
  • overrideConfigPath
    Le permite cargar un archivo de configuración ADBMobile JSON diferente al iniciar la aplicación. Se utiliza la configuración distinta hasta que se cierre la aplicación.
    Para utilizar overrideConfigPath necesita la versión 4.2 o posterior del SDK.
    • Esta es la sintaxis para este método:
       + (void) overrideConfigPath: (nullableNSString *) path;
      
      
    • Este es un ejemplo de código para este método:
      NSString *filePath = [[NSBundle mainBundle] pathForResource:@"ExampleJSONFile" ofType:@"json"]; 
      [ADBMobile overrideConfigPath:filePath];
      
      
  • setPushIdentifier
    Establece el token del dispositivo para notificaciones push.
    Este método solo debe utilizarse en el método application:didRegisterForRemoteNotificationsWithDeviceToken: .
    • Esta es la sintaxis para este método:
      + (void) setPushIdentifier:(NSData *)deviceToken;
      
      
    • Este es un ejemplo de código para este método:
      - (void) application:(UIApplication *) application  didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { 
      [ADBMobile setPushIdentifier:deviceToken];  
      }
      
      
  • setAdvertisingIdentifier
    Establece el IDFA en el SDK. Si el IDFA se ha establecido en el SDK, el IDFA se enviará en el ciclo vital. También se puede acceder a él en Señales (Postbacks).
    Recupere el IDFA desde las API de Apple solo si está utilizando un servicio publicitario. Si recupera el IDFA y no lo utiliza de forma apropiada, podría rechazarse la aplicación.
    • Esta es la sintaxis para este método:
      +(void) setAdvertisingIdentifier:(NSString*)identifier;
      
      
    • Este es un ejemplo de código para este método:
      NSString *idfa = [[[ASIdentifierManager sharedManager]advertisingIdentifier] UUIDString]; 
      [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. */ 
};