Métodos do Android

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

Métodos de configuração

  • DebugLogging

    Retorna a preferência de log de depuração atual e o padrão é false.

    • Esta é a sintaxe para este método:

      public static Boolean DebugLogging;
      
    • Esta é a amostra de código para este método:

      getter: var debuglog = Config.DebugLogging;
      setter: Config.DebugLogging = (Java.Lang.Boolean)true;
      
  • LifetimeValue

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

    • Esta é a sintaxe para este método:

      public static BigDecimal LifetimeValue; 
      
    • Esta é a amostra de código para este método:

       var lifetimeValue = Config.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 não estiver ativado, as ocorrências são descartadas até o status de privacidade ser alterado parar aceitar.

    The default value is set in the ADBMobileConfig.json file.

    • Esta é a sintaxe para este método:

      public static MobilePrivacyStatus PrivacyStatus; 
      
    • Esta é a amostra de código para este método:

      getter: var privacyStatus = Config.PrivacyStatus; 
      setter: Config.PrivacyStatus = MobilePrivacyStatus.MobilePrivacyStatusUnknown;
      
  • UserIdentifier

    Se um identificador personalizado tiver sido definido, retornará esse identificador. Se um identificador personalizado não estiver definido, retornará null. O valor padrão é null.

    • Esta é a sintaxe para este método:

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

      getter: var userId = Config.UserIdentifier;
      setter: Config.UserIdentifier = "imBatman";
      
  • Versão

    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;
      
  • PauseCollectingLifecycleData

    Indica ao SDK que o aplicativo está pausado, a fim de calcular corretamente as medições de ciclo de vida. Por exemplo, ao pausar coleta um carimbo de data e hora para determinar a duração da sessão anterior. Isso também define um sinalizador para que o ciclo de vida saiba corretamente que o aplicativo não falhou. 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:

      Config.PauseCollectingLifecycleData();
      
  • CollectLifecycleData (atividade de Atividade)

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

      Config.CollectLifecycleData (this);
      
  • CollectLifecycleData (atividade de Atividade)

    (4.2 ou posterior) 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(Activity activity, IDictionary<string, Object> context));
      
    • Esta é a amostra de código para este método:

      IDictionary<string, Java.Lang.Object> context = new Dictionary<string, 
      Java.Lang.Object> ();
      context.Add ("key", "value");
      Config.CollectLifecycleData (this, context);
      
  • OverrideConfigStream

    (4.2 ou posterior) Permite carregar um arquivo de ADBMobile JSON configuração diferente quando o aplicativo for start. A configuração diferente é utilizada até o aplicativo ser fechado.

    • Esta é a sintaxe para este método:

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

      Stream st1 = Assets.Open ("ADBMobileConfig-2.json"); 
      Config.OverrideConfigStream (st1); 
      
  • SetLargeIconResourceId(int resourceId)

    (4.2 ou posterior) Define o ícone grande usado para notificações criadas pelo SDK. Este ícone é a principal imagem exibida quando o usuário visualizar a notificação completa na central de notificações.

    • Esta é a sintaxe para este método:

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

      Config.SetLargeIconResourceId(R.drawable.appIcon);
      
  • SetSmallIconResourceId(int resourceId)

    (4.2 ou posterior) Define o ícone pequeno usado para notificações criadas pelo SDK. Esse ícone é exibido na barra de status e é a imagem secundária mostrada quando o usuário visualiza a notificação completa na central de notificações.

    • Esta é a sintaxe para este método:

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

       Config.SetSmallIconResourceId(R.drawable.appIcon);
      

Métodos do Analytics

  • TrackingIdentifier

    Retorna a ID gerada automaticamente para o Analytics. Esta é uma ID exclusiva específica do aplicativo que é gerada na primeira inicialização e é armazenada e usada a partir desse ponto. Essa ID é preservada entre as atualizações do aplicativo e é removida na desinstalação.

    • Esta é a sintaxe para este método:

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

      Var trackingId = Analytics.TrackingIdentifier
      
  • TrackState

    Rastreia um estado de aplicativo com dados de contexto opcionais. States são as visualizações disponíveis no aplicativo, como "tela de título", "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 o estado estiver vazio, será exibido como "app name app version (build)" nos relatórios. If you see this value in reports, make sure you are setting state in each TrackState call.

    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, IDictionary<string, Object> cdata); 
      
    • Esta é a amostra de código para este método:

      var cdata = new Dictionary<string, Java.Lang.Object>(); 
      cdata.Add ("key", (Java.Lang.Object)"value"); 
      Analytics.TrackState ("stateName", (IDictionary<string, 
      Java.Lang.Object>)cdata);
      
  • TrackAction

    Rastreia uma ação no seu aplicativo. As ações são coisas que ocorrem no aplicativo e que você deseja avaliar, como "mortes", "nível ganho", "subscrições 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, IDictionary<string,Object> cdata); 
      
    • Esta é a amostra de código para este método:

      var cdata = new Dictionary<string, Java.Lang.Object> (); 
      cdata.Add ("key", (Java.Lang.Object)"value");
      Analytics.TrackAction ("actionName", (IDictionary<string, 
      Java.Lang.Object>)cdata);
      
  • TrackLocation

    Envia as coordenadas atuais de latitude e longitude. Also uses points of interest defined in the ADBMobileConfig.json file to determine whether the location that was provided as a parameter is in any of your POIs. 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(Location location, IDictionary<string, Object> cdata); 
      
    • Esta é a amostra de código para este método:

       Location loc = new Location(LocationManager.GpsProvider);;
       loc.Latitude = 111; 
       loc.Longitude = 44; 
       loc.Accuracy = 5; 
       Analytics.TrackLocation (loc, null);
      
  • TrackBeacon

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

    • Esta é a sintaxe para este método:

      public static void TrackBeacon (string uuid, string major, string minor,  Analytics.BEACON_PROXIMITY prox, IDictionary<string, Object> cdata); 
      
    • Esta é a amostra de código para este método:

      Analytics.TrackBeacon ("UUID", "1", "2", 
      Analytics.BEACON_PROXIMITY.ProximityImmediate, null); 
      
  • ClearBeacon

    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:

      Analytics.ClearBeacon(); 
      
  • 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, IDictionary<string,Object> cdata); 
      
    • Esta é a amostra de código para este método:

      Analytics.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,IDictionary<string, Object> cdata); 
      
    • Esta é uma amostra de código para este método:

      Analytics.TrackTimedActionStart("level2", null);
      
  • TrackTimedActionUpdate

    Transmita dados para atualizar os dados de contexto associados a determinada ação. Os dados transmitidos são anexados aos dados 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, IDictionary<string, Object> cdata); 
      
    • Esta é a amostra de código para este método:

      var updatedData = new Dictionary<string, Java.Lang.Object> (); 
      cdata.Add ("key", (Java.Lang.Object)"value"); 
      Analytics.TrackTimedActionUpdate("level2", updatedData); 
      
  • TrackTimedActionEnd

    Encerra uma ação programada.

    • Esta é a sintaxe para este método:

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

      Analytics.TrackTimedActionEnd ("level2", new TimedActionBlock()); 
           class TimedActionBlock: Java.Lang.Object, 
      Analytics.ITimedActionBlock{ 
           public Java.Lang.Object Call (long inAppDuration, long 
      totalDuration IDictionary<string, Java.Lang.Object> contextData){ 
           return Java.Lang.Boolean.True; 
        } 
      }
      
  • TrackingTimedActionExists

    Retorna se uma ação cronometrada estiver 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:

      var level2InProgress = Analytics.TrackingTimedActionExists("level2"); 
      
  • SendQueuedHits

    Força a biblioteca a enviar todas as ocorrências na fila offline, independentemente de quantas ocorrências estão na fila no momento.

    • Esta é a sintaxe para este método:

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

      Analytics.SendQueuedHits(); 
      
  • ClearQueue

    Apaga todas as ocorrências da fila offline.

    • Esta é a sintaxe para este método:

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

      Analytics.ClearQueue(); 
      
  • QueueSize

    Recupera o número de ocorrências que estão atualmente na fila offline.

    • Esta é a sintaxe para este método:

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

      var queueSize = Analytics.QueueSize();
      

Experience Cloud ID methods

  • MarketingCloudId

    Recupera a Experience Cloud ID a partir do serviço de ID.

    • Esta é a sintaxe para este método:

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

      var mcid = Visitor.MarketingCloudId;
      
  • SyncIdentifiers

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

      IDictionary<string,string> ids = new Dictionary<string, string> ();
      ids.Add ("pushID", ;"value2");
      Visitor.SyncIdentifiers (ids);
      

Métodos do Target

  • LoadRequest

    Sends a 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 LoadRequest (TargetLocationRequest request, Target.ITargetCallback callback); 
      
    • Esta é a amostra de código para este método:

      class TargetBlock: Java.Lang.Object, Target.ITargetCallback{ 
          public void Call (Java.Lang.Object content) 
         { 
          Console.WriteLine (content.ToString()); 
         } 
      } 
      var req = Target.CreateRequest ("AndroidTest", "defGal", parameters); 
           Target.LoadRequest (req, new TargetBlock()); 
      
  • CreateRequest

    Convenience constructor to create an ADBTargetLocationRequest object with the given parameters.

    • Esta é a sintaxe para este método:

      public static TargetLocationRequest TargetCreateRequest(string name,string defaultContent,IDictionary<string,string> parameters); 
      
    • Esta é a amostra de código para este método:

      IDictionary<string, Java.Lang.Object> parameters = new Dictionary> string, Java.Lang.Object> (); 
          parameters.Add ("key1", "value2"); 
      var req = Target.CreateRequest ("AndroidTest", "defGal", parameters); 
      
  • CreateOrderConfirmRequest

    Cria um ADBTargetLocationRequest.

    • Esta é a sintaxe para este método:

      public static TargetLocationRequest TargetCreateRequest (string name, string defaultContent, IDictionary<;string, string> parameters);
      
    • Esta é a amostra de código para este método:

      var orderConfirm = Target.CreateOrderConfirmRequest ("myOrder", "12345", "29.41", "cool stuff", null); 
      
  • ClearCookies

    Limpa os cookies do Público alvo do aplicativo.

    • Esta é a sintaxe para este método:

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

      Target.ClearCookies (); 
      

Audience Manager

  • VisitorProfile

    Retorna o perfil do visitante obtido recentemente. Retorna nil se nenhum sinal tiver sido enviado ainda. O perfil do visitante é salvo em NSUserDefaults para facilitar o acesso nas várias inicializações do aplicativo.

    • Esta é a sintaxe para este método:

      public static IDictionary<string, Object> VisitorProfile; 
      
    • Esta é a amostra de código para este método:

      NSDictionary profile = AudienceManager.VisitorProfile; 
      
  • Dpid

    Returns the current DPID.

    • Esta é a sintaxe para este método:

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

      string currentDpid = AudienceManager.Dpid;
      
  • Dpuuid

    Returns the current DPUUID.

    • Esta é a sintaxe para este método:

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

      string currentDpuuid = AudienceManager.Dpuuid;
      
  • AudienceSetDpidAndDpuuid

    Define o dpid e 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 (string Dpid, String Dpuuid);
      
    • Esta é a amostra de código para este método:

      AudienceManager.SetDpidAndDpuuid ("testDpid", "testDpuuid");
      
  • SignalWithData

    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 SignalWithData (IDictionary<string, Object> audienceData, AudienceManager.IAudienceManagerCallback callback); 
      
    • Esta é a amostra de código para este método:

      class AudienceManagerCallback: Java.Lang.Object, 
       AudienceManager.IAudienceManagerCallback{ 
         public void Call (Java.Lang.Object content) 
        {
          Console.WriteLine (content.ToString()); 
        }
      }
      IDictionary<string, Java.Lang.Object> traits = new Dictionary<string, 
      Java.Lang.Object> (); 
         traits.Add ("trait", "b");
      AudienceManager.SignalWithData (traits, new AudienceManagerCallback());
      
  • Redefinir

    Resets audience manager UUID and purges current visitor profile.

    • Esta é a sintaxe para este método:

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

       AudienceManager.Reset ();
      

Vídeo

Para obter mais informações sobre a Análise de vídeo, consulte Análise devídeo.

  • MediaSettings

    Retorna um objeto MediaSettings com parâmetros especificados.

    • Esta é a sintaxe para este método:

      public static MediaSettings SettingsWith (string name, double length, string playerName, string playerID);  
      
    • Esta é a amostra de código para este método:

      MediaSettings settings = Media.SettingsWith("name1", 10, "playerName1", "playerID1");
      
  • AdSettingsWith

    Retorna um objeto MediaSettings a ser utilizado no rastreamento de um vídeo de anúncio.

    • Esta é a sintaxe para este método:

      public static MediaSettings AdSettingsWith ( string name, double length, 
        string playerName, string parentName, string parentPod, 
      double parentPodPosition, string CPM); 
      
    • Esta é a amostra de código para este método:

      MediaSettings adSettings = Media.AdSettingsWith ("adName1", 2, "playerName1", "name1", "podName1", 4, "CPM1"); 
      
  • Abrir

    Abre um objeto ADBMediaSettings para rastreamento.

    • Esta é a sintaxe para este método:

      public static void Open (MediaSettings settings, Media.IMediaCallback callback);
      
    • Esta é a amostra de código para este método:

      MediaSettings settings = Media.SettingsWith ("name1", 10, "playerName1", "playerID1"); 
         Media.Open (settings, new MediaCallback()); 
         class MediaCallback: Java.Lang.Object, Media.IMediaCallback{ 
      public void Call (Java.Lang.Object content) 
      {
      }
      }
      
  • Fechar

    Fecha o item de mídia com nome.

    • Esta é a sintaxe para este método:

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

      Media.Close (settings.Name); 
      
  • Reproduzir

    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 Play ( string name, double offset); 
      
    • Esta é a amostra de código para este método:

      Media.Play (settings.Name, 0); 
      
  • Concluído

    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 Complete (string name, double offset); 
      
    • Esta é a amostra de código para este método:

      Media.Complete (settings.Name, 5); 
      
  • Stop

    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 Stop ( string name, double offset); 
      
    • Esta é a amostra de código para este método:

      Media.Stop (settings.Name, 3);
      
  • Clique em

    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 Click ( string name, double offset); 
      
    • Esta é a amostra de código para este método:

      Media.Click (settings.Name, 3); 
      
  • Rastreamento

    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 Track ( string name, NSDictionary data); 
      
    • Esta é a amostra de código para este método:

      Media.Track (settings.Name, null); 
      

Nesta página