Show Menu
TEMAS×

iOS methods

Métodos iOS para el SDK de los componentes Xamarin para soluciones de Experience Cloud 4.x.

Configuration methods

  • 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 .
    • Esta es la sintaxis para este método:
      public static void CollectLifecycleData();
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.CollectLifecycleData();
      
      
  • DebugLogging
    Devuelve la preferencia de registro de depuración actual. El valor predeterminado es false .
    • Esta es la sintaxis para este método:
      public static bool DebugLogging(); 
      
      
    • Este es un ejemplo de código para este método:
      var debugEnabled = ADBMobile.DebugLogging();
      
      
  • SetDebugLogging
    Establece la preferencia de registro de depuración como activado.
    • Esta es la sintaxis para este método:
      public static void SetDebugLogging(bool enabled);
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.SetDebugLogging(true);
      
      
  • LifetimeValue
    Devuelve el valor de duración del usuario actual.
    • Esta es la sintaxis para este método:
      public static double LifetimeValue();
      
      
    • Este es un ejemplo de código para este método:
      var lifetimeValue = ADBMobile.LifetimeValue();
      
      
  • PrivacyStatus
    Devuelve la representación de enumeración del estado de privacidad del usuario actual.
    • ADBMobilePrivacyStatus.OptIn - las visitas se envían inmediatamente.
    • ADBMobilePrivacyStatus.OptOut - las visitas se descartarán.
    • ADBMobilePrivacyStatus.Unknown - 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) o opt-out (entonces se descartan las visitas). Si el seguimiento sin conexión está desactivado, las visitas se descartan hasta que el estado de privacidad cambie a Opt-in. The default value is set in the ADBMobileConfig.json .
    • Esta es la sintaxis para este método:
      public static ADBPrivacyStatus PrivacyStatus();
      
      
    • Este es un ejemplo de código para este método:
      var privacyStatus = ADBMobile.PrivacyStatus();
      
      
  • SetPrivacyStatus
    Establece el estado de privacidad del usuario actual como estado. Establezca uno de los siguientes valores:
    • ADBMobilePrivacyStatus.OptIn - las visitas se envían inmediatamente.
    • ADBMobilePrivacyStatus.OptOut - las visitas se descartarán.
    • ADBMobilePrivacyStatus.Unknown - 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:
      public static void SetPrivacyStatus(ADBPrivacyStatus status) 
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.SetPrivacyStatus(ADBMobilePrivacyStatus.OptIn); 
      
      
  • UserIdentifier
    Devuelve el identificador del usuario si se ha establecido un identificador personalizado. Devuelve vacío si no se ha establecido un identificador personalizado. El valor predeterminado es null .
    • Esta es la sintaxis para este método:
      public static string UserIdentifier(); 
      
      
    • Este es un ejemplo de código para este método:
      var userId = ADBMobile.UserIdentifier(); 
      
      
  • SetUserIdentifier
    Devuelve el identificador del usuario si se ha establecido un identificador personalizado. Devuelve vacío si no se ha establecido un identificador personalizado. El valor predeterminado es null .
    • Esta es la sintaxis para este método:
      public static string UserIdentifier();
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.SetUserIdentifier ("customUserIdentifier”); 
      
      
  • GetVersion
    Obtiene la versión de la biblioteca.
    • Esta es la sintaxis para este método:
      public static string Version();
      
      
    • Este es un ejemplo de código para este método:
      var version = ADBMobile.Version();
      
      
  • KeepLifecycleSessionAlive (solo iOS)
    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.
    Este método está diseñado para utilizarse en aplicaciones que se registran para recibir notificaciones en segundo plano y solo debe invocarse desde el código que se ejecuta mientras la aplicación está en segundo plano.
    • Esta es la sintaxis para este método:
      public static void KeepLifecycleSessionAlive();
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.KeepLifecycleSessionAlive();
      
      

Analytics methods

  • TrackingIdentifier
    Recupera el identificador de seguimiento analítico.
    • Esta es la sintaxis para este método:
      public static string TrackingIdentifier();
      
      
    • Este es un ejemplo de código para este método:
      var trackingId = ADBMobile.TrackingIdentifier();
      
      
  • TrackState
    Realiza un seguimiento del estado de una aplicación con datos de contexto opcionales. Los estados son las vistas que están disponibles en la aplicación, como “pantalla de título”, “nivel 1” o “pausa”, entre otros. Estos estados son similares a las páginas de un sitio web y las llamadas incrementan las vistas de página.Si el estado está vacío, se muestra como "nombre de aplicación versión de la aplicación (compilación)" en los informes. TrackState Si observa este valor en los informes, asegúrese de que está estableciendo state en todas las llamadas a TrackState .
    This is the only tracking call that increments page views.
    • Esta es la sintaxis para este método:
      public static void TrackState(string state, NSDictionary cdata); 
      
      
    • Este es un ejemplo de código para este método:
      NSDictionary contextData; 
       contextData = NSDictionary.FromObjectAndKey (NSObject.FromObject("val"),NSObject.FromObject("key")); 
        ADBMobile.TrackState("title screen", contextData); 
      
      
  • TrackAction
    Realiza un seguimiento de una acción en la aplicación. Las acciones son lo que sucede en la aplicación que desea medir, como “muertes”, “subida de nivel”, “suscripciones a la fuente”, entre otras métricas.
    If you have code that might run while the app is in the background (for example, a background data retrieval), use trackActionFromBackground instead.
    • Esta es la sintaxis para este método:
      public static void TrackAction(string action, NSDictionary cdata); 
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.TrackAction("level gained", null); 
      
      
  • TrackActionFromBackground (solo iOS)
    Realiza un seguimiento de una acción que ocurre en segundo plano. Esto impide que los eventos del ciclo vital se activen en ciertos escenarios.
    Este método solo debe invocarse en el código que se ejecuta mientras la aplicación está en segundo plano.
    • Esta es la sintaxis para este método:
      public static void TrackActionFromBackground(string action, NSDictionary cdata); 
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.TrackActionFromBackground("majorLocationChange", null);
      
      
  • TrackLocation
    Envía las coordenadas de latitud y longitud actuales. También utiliza puntos de interés definidos en el archivo ADBMobileConfig.json para determinar si la ubicación proporcionada como parámetro se encuentra en alguno de sus puntos de interés. Si las coordinadas actuales se encuentran en un punto de interés definido, se rellena una variable de datos de contexto y se envía junto con la llamada a TrackLocation .
    • Esta es la sintaxis para este método:
      public static void TrackLocation(CLLocation location, NSDictionary cdata); 
      
      
    • Este es un ejemplo de código para este método:
      CoreLocation.CLLocation l = new CoreLocation.CLLocation  (111.111, 44.156);
      ADBMobile.TrackLocation (l, null);
      
      
  • TrackBeacon
    Realiza un seguimiento cuando un usuario accede a la proximidad de una señalización.
    • Esta es la sintaxis para este método:
      public static void TrackBeacon( CLBeacon beacon, NSDictionary cdata);
      
      
    • Este es un ejemplo de código para este método:
      CoreLocation.CLBeacon beacon = new CoreLocation.CLBeacon (); 
      ADBMobile.TrackBeacon (beacon, null);
      
      
  • TrackingClearCurrentBeacon
    Borra los datos de señalizaciones una vez el usuario haya abandonado la proximidad de la señalización.
    • Esta es la sintaxis para este método:
      public static void TrackingClearCurrentBeacon();
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.TrackingClearCurrentBeacon();
      
      
  • TrackLifetimeValueIncrease
    Incrementa el valor del ciclo de vida del usuario.
    • Esta es la sintaxis para este método:
      public nbsp;static void TrackLifetimeValueIncrease(doble amount, NSDictionary data);
    • Este es un ejemplo de código para este método:
      ADBMobile.TrackLifetimeValueIncrease(5, null); 
      
      
  • TrackTimedActionStart
    Inicia una acción temporizada con acción de nombre. Si invoca este método para una acción que ya se ha iniciado, se sobrescribe la acción temporizada anterior.
    Esta llamada no envía una visita.
    • Esta es la sintaxis para este método:
      public static void TrackTimedActionStart(string action, NSDictionary cdata); 
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.TrackTimedActionStart("level2", null);
      
      
  • TrackTimedActionUpdate
    Pasa datos para actualizar los datos de contexto asociados a la acción determinada. Los datos que se pasan se añaden a los datos existentes de esa acción determinada y se sobrescriben si ya se ha definido esa clave para una acción.
    Esta llamada no envía una visita.
    • Esta es la sintaxis para este método:
      public static void TrackTimedActionUpdate(string action, NSDictionary cdata); 
      
      
    • Este es un ejemplo de código para este método:
      NSDictionary updatedData = NSDictionary.FromObjectAndKey (NSObject.FromObject("val2"), NSObject.FromObject ("key2")); 
        ADBMobile.TrackTimedActionUpdate("level2", updatedData); 
      
      
  • TrackTimedActionEnd
    Finaliza una acción temporizada.
    • Esta es la sintaxis para este método:
      public static void TrackTimedActionEnd(string action, Func<double, double, NSMutableDictionary, sbyte> block); 
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.TrackTimedActionEnd  ("level2", (double  arg1,  double  arg2,  NSMutableDictionary  arg3)  =>  { 
      return  Convert.ToSByte(true); 
      });
      
      
  • TrackingTimedActionExists
    Devuelve si una acción temporizada está (o no) en curso.
    • Esta es la sintaxis para este método:
      public static bool TrackingTimedActionExists(string action); 
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.TrackTimedActionEnd  ("timedAction",  (double  inAppDuration, 
      double  totalDuration,  NSMutableDictionary  data)  =>  { 
                   return  true; 
      });
      
      
  • TrackingSendQueuedHits
    Fuerza la biblioteca a enviar todas las visitas en la cola sin conexión, sin importar cuántas haya en la cola.
    • Esta es la sintaxis para este método:
      public static void TrackingSendQueuedHits();
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.TrackingSendQueuedHits(); 
      
      
  • TrackingClearQueue
    Borra todas las visitas de la cola sin conexión.
    • Esta es la sintaxis para este método:
      public static void TrackingClearQueue(); 
      
      
    • Este es un ejemplo de código para este método:
       ADBMobile.TrackingClearQueue();
      
      
  • TrackingGetQueueSize
    Recupera el número de visitas que hay actualmente en la cola sin conexión.
    • Este es un ejemplo de código para este método:
      public static int TrackingGetQueueSize();
      
      
    • Este es un ejemplo de código para este método:
      var queueSize = ADBMobile.TrackingGetQueueSize(); 
      
      

Experience Cloud ID methods

  • GetMarketingCloudID
    Recupera el Experience Cloud ID desde el servicio de ID.
    • Esta es la sintaxis para este método:
      public static string GetMarketingCloudID(); 
      
      
    • Este es un ejemplo de código para este método:
      var mcid = ADBMobile.GetMarketingCloudID();
      
      
  • VisitorSyncIdentifiers
    Con el ID de Experience Cloud, puede configurar ID de cliente adicionales para asociarlos a cada visitante. La API de visitante acepta varios ID de cliente para el mismo visitante, además de un identificador de tipo de cliente para separar el ámbito de los distintos ID de cliente. Este método corresponde a setCustomerIDs en la biblioteca JavaScript.
    • Esta es la sintaxis para este método:
      public static void VisitorSyncIdentifiers(NSDictionary identifiers);
      
      
    • Este es un ejemplo de código para este método:
      NSDictionary  ids  =  NSDictionary.FromObjectAndKey  (NSObject.FromObject  ("value2"),  NSObject.FromObject  ("pushID")); 
      ADBMobile.VisitorSyncIdentifiers(ids); 
      
      

Métodos de Target

  • TargetLoadRequest
    Sends request to your configured Target server and returns the string value of the offer generated in a Action<NSDictionary> callback.
    • Esta es la sintaxis para este método:
      public static void TargetLoadRequest (ADBTargetLocationRequest request, Action<NSString> callback); 
      
      
    • Este es un ejemplo de código para este método:
      NSDictionary  dict  =  NSDictionary.FromObjectAndKey  (NSObject.FromObject  ("value2"),  NSObject.FromObject  ("key1")); 
      ADBTargetLocationRequest  req  =  ADBMobile.TargetCreateRequest  ("iOSTest",  "defGal",  dict); 
      ADBMobile.TargetLoadRequest(req,    (context)  =>  { 
      Console.WriteLine  (context); 
      });
      
      
  • TargetCreateRequest
    Constructor de conveniencia para crear un objeto ADBTargetLocationRequest con los parámetros determinados.
    • Esta es la sintaxis para este método:
      public static ADBTargetLocationRequest ADBTargetLocationRequest TargetCreateRequest (string name, string defaultContent, NSDictionary parameters); 
      
      
    • Este es un ejemplo de código para este método:
      NSDictionary  dict  =  NSDictionary.FromObjectAndKey  (NSObject.FromObject  ("value2"),  NSObject.FromObject  ("key1")); 
      ADBTargetLocationRequest  req  =  ADBMobile.TargetCreateRequest  ("iOSTest",  "defGal",  dict); 
      
      
  • TargetCreateOrderConfirmRequest
    Crea un ADBTargetLocationRequest .
    • Esta es la sintaxis para este método:
      public static ADBTargetLocationRequest ADBTargetLocationRequest TargetCreateRequest (string name, string defaultContent, NSDictionary parameters);
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.TargetCreateOrderConfirmRequest ("myOrder", "12345", "29.41", "cool stuff", null); 
      
      
  • TargetClearCookies
    Borra cualquier cookie objetivo de la aplicación.
    • Esta es la sintaxis para este método:
      public static void TargetClearCookies(); 
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.TargetClearCookies(); 
      
      

Audience Manager

  • AudienceVisitorProfile
    Devuelve el perfil del visitante que se haya obtenido más recientemente. Devuelve cero si todavía no se ha enviado ninguna señal. El perfil del visitante está guardado en NSUserDefaults para acceder fácilmente entre los distintos lanzamientos de la aplicación.
    • Esta es la sintaxis para este método:
      public static NSDictionary AudienceVisitorProfile (); 
      
      
    • Este es un ejemplo de código para este método:
      NSDictionary profile = ADBMobile.AudienceVisitorProfile();
      
      
  • AudienceDpid
    Devuelve el DPID actual.
    • Esta es la sintaxis para este método:
      public static string AudienceDpid ();
      
      
    • Este es un ejemplo de código para este método:
      string currentDpid = ADBMobile.AudienceDpid();
      
      
  • AudienceDpuuid
    Devuelve el DPUUID actual.
    • Esta es la sintaxis para este método:
      public static string AudienceDpuuid ();
      
      
    • Este es un ejemplo de código para este método:
      string currentDpuuid = ADBMobile.AudienceDpuuid(); 
      
      
  • AudienceSetDpidAndDpuuid
    Establece el dpid y el dpuuid. Si el dpid y el dpuuid se han establecido, se enviarán con cada señal.
    • Esta es la sintaxis para este método:
      public static void AudienceSetDpidAndDpuuid (NSDictionary data, Action<NSDictionary> callback); 
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.AudienceSetDpidAndDpuuid ("testDppid", "testDpuuid")
      
      
  • AudienceSignalWithData
    Sends audience management a signal with traits and get the matching segments returned in a Action<NSDictionary> callback.
    • Esta es la sintaxis para este método:
      public static void AudienceSignalWithData (NSDictionary data, Action<NSDictionary> callback); 
      
      
    • Este es un ejemplo de código para este método:
      NSDictionary  audienceData  =  NSDictionary.FromObjectAndKey  (NSObject.FromObject  ("value2"),  NSObject.FromObject  ("key1")); 
      ADBMobile.AudienceSignalWithData  (audienceData,  (context)  =>  { 
      Console.WriteLine  (context); 
      }); 
      
      
  • AudienceReset
    Restaura el UUID de Audience Manager y elimina el perfil del visitante actual.
    • Esta es la sintaxis para este método:
      public static void AudienceReset ();
      
      
    • Esta es la sintaxis para este método:
      ADBMobile.AudienceReset ();
      
      

Vídeo

Para obtener más información, consulte Análisis de vídeo .
  • MediaCreateSettings
    Devuelve un objeto ADBMediaSettings con parámetros específicos.
    • Esta es la sintaxis para este método:
      public static ADBMediaSettings MediaCreateSettings ([string name, double length, string playerName, string playerID); 
      
      
    • Este es un ejemplo de código para este método:
      ADBMediaSettings settings = ADBMobile.MediaCreateSettings ("name1", 10, "playerName1", "playerID1"); 
      
      
  • MediaAdCreateSettings
    Devuelve un objeto ADBMediaSettings para su uso con el seguimiento de un vídeo de anuncio.
    • Esta es la sintaxis para este método:
      public static ADBMediaSettings MediaAdCreateSettings ( string name,  double length,  string playerName,  string parentName,  string parentPod,  double parentPodPosition,  string CPM); 
      
      
    • Este es un ejemplo de código para este método:
      ADBMediaSettings adSettings = ADBMobile.MediaAdCreateSettings("adName1", 2, "playerName1", "name1", "podName1", 4, "CPM1");
      
      
  • MediaOpenWithSettings
    Abre un objeto ADBMediaSettings para su seguimiento.
    • Esta es la sintaxis para este método:
      public static void MediaOpenWithSettings ( ADBMediaSettings settings,  Action<ADBMediaState> callback); 
      
      
    • Este es un ejemplo de código para este método:
      ADBMediaSettings settings = ADBMobile.MediaCreateSettings  ("name1",  10,  "playerName1",  "playerID1"); 
      ADBMobile.MediaOpenWithSettings  (settings,  (state)  =>  { 
      Console.WriteLine  (state.Name); 
      }); 
      
      
  • MediaClose
    Cierra el elemento de medios denominado.
    • Esta es la sintaxis para este método:
      public static void MediaClose ( string name);
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.MediaClose  (settings.Name);
      
      
  • MediaPlay
    Reproduce el elemento de medios denominado en el desplazamiento determinado (en segundos).
    • Esta es la sintaxis para este método:
      public static void MediaPlay ( string name, double offset);
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.MediaPlay (settings.Name, 0); 
      
      
  • MediaComplete
    Marca de forma manual como completo el elemento de medios en el desplazamiento proporcionado (en segundos).
    • Esta es la sintaxis para este método:
      public static void MediaComplete ( string name, double offset);
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.MediaComplete (settings.Name, 5);
      
      
  • MediaStop
    Notifica al módulo de medios que el vídeo se ha detenido o pausado en el desplazamiento determinado.
    • Esta es la sintaxis para este método:
      public static void MediaStop ( string name, double offset);
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.MediaStop (settings.Name, 3);
      
      
  • MediaClick
    Notifica al módulo de medios que se ha hecho clic en el elemento de medios.
    • Esta es la sintaxis para este método:
      public static void MediaClick ( string name, double offset); 
      
      
  • MediaTrack
    Envía una llamada de acción de seguimiento (sin visualización de página) al estado de medios actual.
    • Esta es la sintaxis para este método:
      public static void MediaTrack ( string name, NSDictionary data); 
      
      
    • Este es un ejemplo de código para este método:
       ADBMobile.MediaTrack (settings.Name, null);