Métodos do ADBMobile.css

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();
      
  • EnableLocalNotifications (somente iOS)

    Ative as notificações locais no aplicativo.

    • Esta é a sintaxe para este método:

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

      ADBMobile.EnableLocalNotifications();
      
  • GetDebugLogging

    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 GetDebugLogging();
      
    • Esta é a amostra de código para este método:

      var debugEnabled = ADBMobile.GetDebugLogging();
      
  • GetLifetimeValue

    Retorna o valor do tempo de vida do usuário atual.

    • Esta é a sintaxe para este método:

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

      var lifetimeValuea = ADBMobile.GetLifetimeValue();
      
  • GetPrivacyStatus

    Retorna a representação de enumeração do status de privacidade do usuário atual.

    • MOBILE_PRIVACY_STATUS_OPT_IN: as ocorrências são enviadas imediatamente.

    • MOBILE_PRIVACY_STATUS_OPT_OUT: as ocorrências são descartadas.

    • MOBILE_PRIVACY_STATUS_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. O valor padrão está definido no arquivo ADBMobileConfig.json.

    • Esta é a sintaxe para este método:

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

      var privacyStatus = ADBMobile.GetPrivacyStatus();
      
  • GetUserIdentifier

    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 GetUserIdentifier();
      
    • Esta é a amostra de código para este método:

      var userId = ADBMobile.GetUserIdentifier();
      
  • GetVersion

    Obtém a versão da biblioteca.

    • Esta é a sintaxe para este método:

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

      var version = ADBMobile.GetVersion();
      
  • 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();
      
  • PauseCollectingLifecycleData (somente Android)

    Indica ao SDK que o aplicativo está pausado, a fim de calcular corretamente as medições de ciclo de vida. Por exemplo, ao pausar, um carimbo de data e hora é coletado para determinar a duração da sessão anterior. Isso também define um sinalizador para que o ciclo de vida saiba que o aplicativo não parou de funcionar. Para obter mais informações, consulte Medições de ciclo de vida.

    • Esta é a sintaxe para este método:

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

      ADBMobile.PauseCollectingLifecycleData();
      
  • SetContext (somente Android)

    Indica ao SDK que ele deve definir seu contexto de aplicativo a partir da atividade atual do UnityPlayer.

    • Esta é a sintaxe para este método:

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

      ADBMobile.SetContext();
      
  • 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);
      
  • SetPrivacyStatus

    Define o status de privacidade do usuário atual como status. É definido como um dos valores abaixo:

    • MOBILE_PRIVACY_STATUS_OPT_IN: as ocorrências são enviadas imediatamente.

    • MOBILE_PRIVACY_STATUS_OPT_OUT: as ocorrências são descartadas.

    • MOBILE_PRIVACY_STATUS_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(ADBPrivacyStatusstatus);
      
    • Esta é a amostra de código para esta sintaxe:

      ADBMobile.SetPrivacyStatus(ADBMobile.ADBPrivacyStatus.MOBILE_PRIVACY_STATUS_OPT_IN);
      
  • SetUserIdentifier

    Define o identificador do usuário para userId.

    • Esta é a sintaxe para este método:

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

      ADBMobile.SetUserIdentifier("myCustomUserId");
      

Métodos do Analytics

  • GetTrackingIdentifier

    Recupera o identificador do rastreamento de análises.

    • Esta é a sintaxe para este método:

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

      var trackingId = ADBMobile.GetTrackingIdentifier();
      
  • 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 de TrackState aumentam as visualizações de página.

    Se state estiver vazio, ele será exibido como app name app version (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, Dictionary<string, object> cdata);
      
    • Esta é a amostra de código para este método:

      var contextData = new Dictionary<string, object>);
      contextData.Add ("user", "jim");
      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, Dictionary<string, object> 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, Dictionary<string,object> 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(float latValue, float lonValue, Dictionary<string, object> cdata);
      
    • Esta é a amostra de código para este método:

      ADBMobile.TrackLocation(28.418649, -81.581324, null);
      
  • TrackBeacon

    Rastreia quando um usuário está perto de um beacon.

    • Esta é a sintaxe para este método:

      public static void TrackBeacon(int major, int minor, string uuid, ADBBeaconProximity proximity, Dictionary<string, object> cdata);
      
  • 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:

      public static void TrackLifetimeValueIncrease(double amount, Dictionary<string, object> cdata);
      
    • 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, Dictionary<string,object> 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, Dictionary<string, object> cdata);
      
    • Esta é a amostra de código para este método:

      var contextData = new Dictionary<string, object>;
      contextData.Add("checkpoint", "1:32");
         ADBMobile.TrackTimedActionUpdate("level2", contextData);
      
  • TrackTimedActionEnd

    Encerra uma ação programada.

    • Esta é a sintaxe para este método:

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

      ADBMobile.TrackTimedActionEnd("level2");
      
  • TrackingTimedActionExists

    Retorna se uma ação programada está em andamento ou não.

    • Esta é a sintaxe para este método:

      public static bool TrackingTimedActionExists(string action);
      
    • Esta é a amostra de código para este método:

       var level2InProgress = ADBMobile.TrackingTimedActionExists("level2");
      
  • 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 sintaxe 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(Dictionary<string, object> identifiers);
      
    • Esta é a amostra de código para este método:

      var ids = new Dictionary<string, object> ();
      ids.Add ("player1", "jimbob");
      ADBMobile.VisitorSyncIdentifiers(ids);
      

Métodos de aquisição

  • ProcessGooglePlayInstallReferrerUrl (somente Android)

    Passe o URL do referenciador retornado de uma chamada para a API do referenciador de instalação do Google Play para este método.

    • Esta é a sintaxe para este método:

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

      // in actual implementation, the referrer url should be retrieved
      // from the Google Play Install Referrer API.
      var myReferrer = "utm_source=unityTestSource&utm_content=unityTestContent&utm_campaign=unityTestCampaign";
      ADBMobile.ProcessGooglePlayInstallReferrerUrl(myReferrer);
      

Nesta página