Métodos do iOS

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

Métodos de configuração

  • 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 - 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 estiver desativado, as ocorrências são descartadas até o status de privacidade ser alterado para aceitar.

    O valor padrão está definido em 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 identificador personalizado estiver configurado. Retorna null 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 identificador personalizado estiver configurado. Retorna null 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.

    DICA

    Este método é destinado a aplicativos que realizam registros para receber notificações enquanto são executados em segundo plano e só deve ser chamado a partir do código executado enquanto o aplicativo está funcionando em segundo plano.

    • Esta é a sintaxe para este método:

      public static void KeepLifecycleSessionAlive();
      
    • Esta é a amostra de código para este método:

      ADBMobile.KeepLifecycleSessionAlive();
      

Métodos do Analytics

  • 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", "pausa" e assim por diante. Esses estados são semelhantes às páginas em um site, e as chamadas TrackState incrementam as exibições de página. Se o estado estiver vazio, ele será exibido como "nome do aplicativo versão do aplicativo (build)" nos relatórios. Caso veja esse valor em relatórios, certifique-se de configurar o estado em cada chamada de TrackState.

    DICA

    Esta é 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 seu aplicativo e que deseja medir, como "mortes", "nível obtido", "assinaturas de feed" e outras métricas.

    DICA

    Se você tem um código que pode funcionar enquanto o aplicativo é executado em segundo plano (por exemplo, uma recuperação de dados em segundo plano), use trackActionFromBackground.

    • 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. Impede que os eventos do ciclo de vida sejam acionados em determinados cenários.

    DICA

    Este método deve ser chamado somente no código em execução enquanto o aplicativo estiver 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 ao valor do ciclo de vida do usuário.

    • Esta é a sintaxe para este método:

      nbsp;public void TrackLifetimeValueIncrease(double amount, NSDictionary data);

    • 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.

    DICA

    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

    Transmita dados para atualizar os dados de contexto associados à ação. Os dados transmitidos são anexados aos existentes para a ação em questão e os substituem se a mesma chave já estiver definida para a ação.

    DICA

    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 programada 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(); 
      

Métodos de ID do Experience Cloud

  • 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 ID do Experience Cloud, é possível definir outras IDs do cliente para associar a 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

    Envia request para o servidor do Target configurado e retorna o valor da cadeia de caracteres da oferta gerada em um retorno de chamada Action<NSDictionary>.

    • 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 fornecidos.

    • 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 nil se nenhum sinal tiver sido enviado. O perfil do visitante é salvo em NSUserDefaults para facilitar o acesso em várias inicializações 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, elas 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

    Envia ao gerenciamento de público-alvo um sinal com características e obtém os segmentos correspondentes retornados em um retorno de chamada Action<NSDictionary>.

    • 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 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 offset 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 offset 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);
      

Nesta página