Show Menu
TÓPICOS×

iOS methods

Métodos do iOS para componentes do Xamarin para os SDK 4.x das soluções da Experience Cloud.

Configuration methods

  • CollectLifecycleData
    Indica ao SDK que os dados do ciclo de vida devem ser coletados para uso em todas as soluções no SDK. Para obter mais informações, consulte Medições de ciclo de vida .
    • Esta é a sintaxe para este método:
      public static void CollectLifecycleData();
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.CollectLifecycleData();
      
      
  • DebugLogging
    Retorna a preferência de log para a depuração atual. O valor padrão é false .
    • Esta é a sintaxe para este método:
      public static bool DebugLogging(); 
      
      
    • Esta é a amostra de código para este método:
      var debugEnabled = ADBMobile.DebugLogging();
      
      
  • SetDebugLogging
    Define a preferência do log de depuração como ativada.
    • Esta é a sintaxe para este método:
      public static void SetDebugLogging(bool enabled);
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.SetDebugLogging(true);
      
      
  • LifetimeValue
    Retorna o valor do tempo de vida do usuário atual.
    • Esta é a sintaxe para este método:
      public static double LifetimeValue();
      
      
    • Esta é a amostra de código para este método:
      var lifetimeValue = ADBMobile.LifetimeValue();
      
      
  • PrivacyStatus
    Retorna a representação de enumeração do status de privacidade do usuário atual.
    • ADBMobilePrivacyStatus.OptIn - hits are sent immediately.
    • ADBMobilePrivacyStatus.OptOut - as ocorrências serão descartadas.
    • ADBMobilePrivacyStatus.Unknown - se o rastreamento offline estiver ativado, as ocorrências são salvas até o status de privacidade ser alterado para aceitar (e então as ocorrências são enviadas) ou rejeitar (as ocorrências são descartadas). If offline tracking is disabled, hits are discarded until the privacy status changes to opt in. The default value is set in the ADBMobileConfig.json .
    • Esta é a sintaxe para este método:
      public static ADBPrivacyStatus PrivacyStatus();
      
      
    • Esta é a amostra de código para este método:
      var privacyStatus = ADBMobile.PrivacyStatus();
      
      
  • SetPrivacyStatus
    Define o status de privacidade do usuário atual como status. É definido como um dos valores abaixo:
    • ADBMobilePrivacyStatus.OptIn - as ocorrências são enviadas imediatamente.
    • ADBMobilePrivacyStatus.OptOut - as ocorrências serão descartadas.
    • ADBMobilePrivacyStatus.Unknown - se o rastreamento offline estiver ativado, as ocorrências são salvas até o status de privacidade ser alterado para aceitar (e então as ocorrências são enviadas) ou rejeitar (as ocorrências são descartadas). Se o rastreamento offline não estiver ativado, as ocorrências são descartadas até o status de privacidade ser alterado parar aceitar.
    • Esta é a sintaxe para este método:
      public static void SetPrivacyStatus(ADBPrivacyStatus status) 
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.SetPrivacyStatus(ADBMobilePrivacyStatus.OptIn); 
      
      
  • UserIdentifier
    Retorna o identificador do usuário personalizado se algum estiver configurado. Retorna nulo se um identificador personalizado não estiver configurado. O valor padrão é null .
    • Esta é a sintaxe para este método:
      public static string UserIdentifier(); 
      
      
    • Esta é a amostra de código para este método:
      var userId = ADBMobile.UserIdentifier(); 
      
      
  • SetUserIdentifier
    Retorna o identificador do usuário personalizado se algum estiver configurado. Retorna nulo se um identificador personalizado não estiver configurado. O valor padrão é null .
    • Esta é a sintaxe para este método:
      public static string UserIdentifier();
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.SetUserIdentifier ("customUserIdentifier”); 
      
      
  • GetVersion
    Obtém a versão da biblioteca.
    • Esta é a sintaxe para este método:
      public static string Version();
      
      
    • Esta é a amostra de código para este método:
      var version = ADBMobile.Version();
      
      
  • KeepLifecycleSessionAlive (somente iOS)
    Indica ao SDK que o próximo resumo em segundo plano não deve iniciar uma nova sessão, independentemente do tempo limite de valor da sessão do ciclo de vida presente no arquivo de configuração.
    This method is intended to be used for apps that register for notifications while in background and should only be called from your code that runs while your app is in the background.
    • Esta é a sintaxe para este método:
      public static void KeepLifecycleSessionAlive();
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.KeepLifecycleSessionAlive();
      
      

Analytics methods

  • TrackingIdentifier
    Recupera o identificador do rastreamento de análises.
    • Esta é a sintaxe para este método:
      public static string TrackingIdentifier();
      
      
    • Esta é a amostra de código para este método:
      var trackingId = ADBMobile.TrackingIdentifier();
      
      
  • TrackState
    Rastreia um estado de aplicativo com dados de contexto opcionais. Os estados são as exibições disponíveis no aplicativo, como "tela inicial", "nível 1", "pausar" e assim por diante. Esses estados são semelhantes às páginas em um site e TrackState as chamadas incrementam as exibições de página.Se o estado estiver vazio, ele será exibido como "app name app version (build)" nos relatórios. Se você encontrar esse valor nos relatórios, certifique-se de que esteja definindo state em cada chamada de TrackState .
    Essa é a única chamada de rastreamento que aumenta as exibições de página.
    • Esta é a sintaxe para este método:
      public static void TrackState(string state, NSDictionary cdata); 
      
      
    • Esta é a amostra de código para este método:
      NSDictionary contextData; 
       contextData = NSDictionary.FromObjectAndKey (NSObject.FromObject("val"),NSObject.FromObject("key")); 
        ADBMobile.TrackState("title screen", contextData); 
      
      
  • TrackAction
    Rastreia uma ação no seu aplicativo. As ações são coisas que ocorrem no aplicativo e que você deseja medir, como "mortes", "nível obtido", "assinaturas de feed" e outras 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 é a sintaxe para este método:
      public static void TrackAction(string action, NSDictionary cdata); 
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.TrackAction("level gained", null); 
      
      
  • TrackActionFromBackground (somente iOS)
    Rastreia uma ação que ocorreu em segundo plano. Isso impede que os eventos do ciclo de vida sejam acionados em cenários específicos.
    Esse método deve ser chamado somente no código executado enquanto o aplicativo está em segundo plano.
    • Esta é a sintaxe para este método:
      public static void TrackActionFromBackground(string action, NSDictionary cdata); 
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.TrackActionFromBackground("majorLocationChange", null);
      
      
  • TrackLocation
    Envia as coordenadas atuais de latitude e longitude. Também usa pontos de interesse definidos no arquivo ADBMobileConfig.json a fim de determinar se o local fornecido como parâmetro está dentro do POI. Se as coordenadas atuais estão dentro de um POI definido, uma variável de dados de contexto é preenchida e enviada com a chamada TrackLocation .
    • Esta é a sintaxe para este método:
      public static void TrackLocation(CLLocation location, NSDictionary cdata); 
      
      
    • Esta é a amostra de código para este método:
      CoreLocation.CLLocation l = new CoreLocation.CLLocation  (111.111, 44.156);
      ADBMobile.TrackLocation (l, null);
      
      
  • TrackBeacon
    Rastreia quando um usuário está perto de um beacon.
    • Esta é a sintaxe para este método:
      public static void TrackBeacon( CLBeacon beacon, NSDictionary cdata);
      
      
    • Esta é a amostra de código para este método:
      CoreLocation.CLBeacon beacon = new CoreLocation.CLBeacon (); 
      ADBMobile.TrackBeacon (beacon, null);
      
      
  • TrackingClearCurrentBeacon
    Apaga os dados de beacons depois que o usuário se distancia de um.
    • Esta é a sintaxe para este método:
      public static void TrackingClearCurrentBeacon();
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.TrackingClearCurrentBeacon();
      
      
  • TrackLifetimeValueIncrease
    Adiciona uma quantia para o valor do ciclo de vida do usuário.
    • Esta é a sintaxe para este método:
      public nbsp;static void TrackLifetimeValueIncrease (quantidade dupla, dados NSDictionary);
    • Esta é a amostra de código para este método:
      ADBMobile.TrackLifetimeValueIncrease(5, null); 
      
      
  • TrackTimedActionStart
    Inicia uma ação programada com a ação de nome. Se você chamar este método para uma ação já iniciada, a ação programada anterior será substituída.
    Essa chamada não envia uma ocorrência.
    • Esta é a sintaxe para este método:
      public static void TrackTimedActionStart(string action, NSDictionary cdata); 
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.TrackTimedActionStart("level2", null);
      
      
  • TrackTimedActionUpdate
    Repassa os dados para atualizar os dados de contexto associados à ação. Os dados transmitidos são anexados aos atuais para a ação em questão, e substituem os dados se a mesma chave já estiver definida para a ação.
    Essa chamada não envia uma ocorrência.
    • Esta é a sintaxe para este método:
      public static void TrackTimedActionUpdate(string action, NSDictionary cdata); 
      
      
    • Esta é a amostra de código para este método:
      NSDictionary updatedData = NSDictionary.FromObjectAndKey (NSObject.FromObject("val2"), NSObject.FromObject ("key2")); 
        ADBMobile.TrackTimedActionUpdate("level2", updatedData); 
      
      
  • TrackTimedActionEnd
    Encerra uma ação programada.
    • Esta é a sintaxe para este método:
      public static void TrackTimedActionEnd(string action, Func<double, double, NSMutableDictionary, sbyte> block); 
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.TrackTimedActionEnd  ("level2", (double  arg1,  double  arg2,  NSMutableDictionary  arg3)  =>  { 
      return  Convert.ToSByte(true); 
      });
      
      
  • TrackingTimedActionExists
    Retorna se uma ação cronometrada está (ou não) em andamento.
    • Esta é a sintaxe para este método:
      public static bool TrackingTimedActionExists(string action); 
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.TrackTimedActionEnd  ("timedAction",  (double  inAppDuration, 
      double  totalDuration,  NSMutableDictionary  data)  =>  { 
                   return  true; 
      });
      
      
  • TrackingSendQueuedHits
    Força a biblioteca a enviar todas as ocorrências na fila offline, independentemente de quantas estão na fila no momento.
    • Esta é a sintaxe para este método:
      public static void TrackingSendQueuedHits();
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.TrackingSendQueuedHits(); 
      
      
  • TrackingClearQueue
    Apaga todas as ocorrências da fila offline.
    • Esta é a sintaxe para este método:
      public static void TrackingClearQueue(); 
      
      
    • Esta é a amostra de código para este método:
       ADBMobile.TrackingClearQueue();
      
      
  • TrackingGetQueueSize
    Recupera o número de ocorrências na fila offline.
    • Esta é a amostra de código para este método:
      public static int TrackingGetQueueSize();
      
      
    • Esta é a amostra de código para este método:
      var queueSize = ADBMobile.TrackingGetQueueSize(); 
      
      

Experience Cloud ID methods

  • GetMarketingCloudID
    Recupera a Experience Cloud ID a partir do serviço de ID.
    • Esta é a sintaxe para este método:
      public static string GetMarketingCloudID(); 
      
      
    • Esta é a amostra de código para este método:
      var mcid = ADBMobile.GetMarketingCloudID();
      
      
  • VisitorSyncIdentifiers
    Com a Experience Cloud ID, é possível definir outras IDs do cliente para associar com cada visitante. A API de visitante aceita várias IDs do cliente para o mesmo visitante, juntamente com um identificador de tipo de cliente para separar o escopo de diferentes IDs do cliente. Este método corresponde a setCustomerIDs na biblioteca do JavaScript.
    • Esta é a sintaxe para este método:
      public static void VisitorSyncIdentifiers(NSDictionary identifiers);
      
      
    • Esta é a amostra de código para este método:
      NSDictionary  ids  =  NSDictionary.FromObjectAndKey  (NSObject.FromObject  ("value2"),  NSObject.FromObject  ("pushID")); 
      ADBMobile.VisitorSyncIdentifiers(ids); 
      
      

Métodos do Target

  • TargetLoadRequest
    Sends request to your configured Target server and returns the string value of the offer generated in a Action<NSDictionary> callback.
    • Esta é a sintaxe para este método:
      public static void TargetLoadRequest (ADBTargetLocationRequest request, Action<NSString> callback); 
      
      
    • Esta é a amostra 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
    O construtor de conveniência cria um objeto ADBTargetLocationRequest com os parâmetros em questão.
    • Esta é a sintaxe para este método:
      public static ADBTargetLocationRequest ADBTargetLocationRequest TargetCreateRequest (string name, string defaultContent, NSDictionary parameters); 
      
      
    • Esta é a amostra 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
    Cria um ADBTargetLocationRequest .
    • Esta é a sintaxe para este método:
      public static ADBTargetLocationRequest ADBTargetLocationRequest TargetCreateRequest (string name, string defaultContent, NSDictionary parameters);
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.TargetCreateOrderConfirmRequest ("myOrder", "12345", "29.41", "cool stuff", null); 
      
      
  • TargetClearCookies
    Apaga quaisquer cookies de destino do seu aplicativo.
    • Esta é a sintaxe para este método:
      public static void TargetClearCookies(); 
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.TargetClearCookies(); 
      
      

Audience Manager

  • AudienceVisitorProfile
    Retorna o perfil do visitante obtido recentemente. Retorna nulo se nenhum sinal foi enviado ainda. O perfil do visitante é salvo em NSUserDefaults para facilitar o acesso em vários lançamentos do aplicativo.
    • Esta é a sintaxe para este método:
      public static NSDictionary AudienceVisitorProfile (); 
      
      
    • Esta é a amostra de código para este método:
      NSDictionary profile = ADBMobile.AudienceVisitorProfile();
      
      
  • AudienceDpid
    Retorna a DPID atual.
    • Esta é a sintaxe para este método:
      public static string AudienceDpid ();
      
      
    • Esta é a amostra de código para este método:
      string currentDpid = ADBMobile.AudienceDpid();
      
      
  • AudienceDpuuid
    Retorna a DPUUID atual.
    • Esta é a sintaxe para este método:
      public static string AudienceDpuuid ();
      
      
    • Esta é a amostra de código para este método:
      string currentDpuuid = ADBMobile.AudienceDpuuid(); 
      
      
  • AudienceSetDpidAndDpuuid
    Define a dpid e a dpuuid. Se dpid e dpuuid estiverem definidas, então serão enviadas com cada sinal.
    • Esta é a sintaxe para este método:
      public static void AudienceSetDpidAndDpuuid (NSDictionary data, Action<NSDictionary> callback); 
      
      
    • Esta é a amostra 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 é a sintaxe para este método:
      public static void AudienceSignalWithData (NSDictionary data, Action<NSDictionary> callback); 
      
      
    • Esta é a amostra 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
    Redefine a UUID do Audience Manager e limpa o perfil de visitante atual.
    • Esta é a sintaxe para este método:
      public static void AudienceReset ();
      
      
    • Esta é a sintaxe para este método:
      ADBMobile.AudienceReset ();
      
      

Vídeo

Para obter mais informações, consulte Análise de vídeo .
  • MediaCreateSettings
    Retorna um objeto ADBMediaSettings com parâmetros especificados.
    • Esta é a sintaxe para este método:
      public static ADBMediaSettings MediaCreateSettings ([string name, double length, string playerName, string playerID); 
      
      
    • Esta é a amostra de código para este método:
      ADBMediaSettings settings = ADBMobile.MediaCreateSettings ("name1", 10, "playerName1", "playerID1"); 
      
      
  • MediaAdCreateSettings
    Retorna um objeto ADBMediaSettings a ser utilizado no rastreamento de um vídeo de anúncio.
    • Esta é a sintaxe para este método:
      public static ADBMediaSettings MediaAdCreateSettings ( string name,  double length,  string playerName,  string parentName,  string parentPod,  double parentPodPosition,  string CPM); 
      
      
    • Esta é a amostra de código para este método:
      ADBMediaSettings adSettings = ADBMobile.MediaAdCreateSettings("adName1", 2, "playerName1", "name1", "podName1", 4, "CPM1");
      
      
  • MediaOpenWithSettings
    Abre um objeto ADBMediaSettings para rastreamento.
    • Esta é a sintaxe para este método:
      public static void MediaOpenWithSettings ( ADBMediaSettings settings,  Action<ADBMediaState> callback); 
      
      
    • Esta é a amostra de código para este método:
      ADBMediaSettings settings = ADBMobile.MediaCreateSettings  ("name1",  10,  "playerName1",  "playerID1"); 
      ADBMobile.MediaOpenWithSettings  (settings,  (state)  =>  { 
      Console.WriteLine  (state.Name); 
      }); 
      
      
  • MediaClose
    Fecha o item de mídia com nome.
    • Esta é a sintaxe para este método:
      public static void MediaClose ( string name);
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.MediaClose  (settings.Name);
      
      
  • MediaPlay
    Reproduz o item de mídia com o nome no deslocamento em questão (em segundos).
    • Esta é a sintaxe para este método:
      public static void MediaPlay ( string name, double offset);
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.MediaPlay (settings.Name, 0); 
      
      
  • MediaComplete
    Marca manualmente o item de mídia como concluído no deslocamento em questão (em segundos).
    • Esta é a sintaxe para este método:
      public static void MediaComplete ( string name, double offset);
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.MediaComplete (settings.Name, 5);
      
      
  • MediaStop
    Notifica ao módulo de mídia que o vídeo foi interrompido ou pausado no deslocamento em questão.
    • Esta é a sintaxe para este método:
      public static void MediaStop ( string name, double offset);
      
      
    • Esta é a amostra de código para este método:
      ADBMobile.MediaStop (settings.Name, 3);
      
      
  • MediaClick
    Notifica ao módulo de mídia que o item de mídia foi clicado.
    • Esta é a sintaxe para este método:
      public static void MediaClick ( string name, double offset); 
      
      
  • MediaTrack
    Envia uma chamada de ação de rastreamento (sem exibição de página) para o estado de mídia atual.
    • Esta é a sintaxe para este método:
      public static void MediaTrack ( string name, NSDictionary data); 
      
      
    • Esta é a amostra de código para este método:
       ADBMobile.MediaTrack (settings.Name, null);