Instalar o SDK

Para instalar o SDK:

1. Faça o download e extraia o arquivo do SDK.
2. Copie a pasta SingularSDK para a pasta Plugins da sua aplicação.

3. Adicione o SingularSDK como uma dependência à matriz PublicDependencyModuleNames no arquivo Build.cs do seu aplicativo (<YOUR_APP>.Build.cs):

   PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject",
     "Engine", "InputCore", "SingularSDK" });

Inicializar o SDK

O código de inicialização do SDK deve ser chamado sempre que seu aplicativo for aberto. Ele é um pré-requisito para todas as funcionalidades de atribuição do Singular e também envia uma nova sessão para o Singular que é usada para calcular a retenção de usuários. Recomendamos inicializar o SDK o mais cedo possível na execução do seu aplicativo.

Para inicializar o SDK, chame o método Initialize na classe SingularSDKBPLibrary:

static bool Initialize(FString sdkKey, FString sdkSecret,
       int sessionTimeout = 60,
       FString customUserId = TEXT(""),
       bool skAdNetworkEnabled = true,
       bool manualSkanConversionManagement = false,
       int waitForTrackingAuthorizationWithTimeoutInterval = 0,
       bool oaidCollection = false);

#include "SingularSDKBPLibrary.h"
  
  [...]
  
  USingularSDKBPLibrary::Initialize("SDK KEY", "SDK SECRET");
  

Parâmetros do método

Definir uma ID de utilizador

Você pode enviar seu ID de usuário interno para a Singular usando um método do SDK da Singular.

• A ID de usuário pode ser qualquer identificador e não deve expor PII (Informações de identificação pessoal). Por exemplo, não deve utilizar o endereço de correio eletrónico, o nome de utilizador ou o número de telefone de um utilizador. A Singular recomenda o uso de um valor com hash exclusivo apenas para seus dados primários.
• O valor da ID de usuário passado para a Singular também deve ser a mesma ID de usuário interna que você captura em todas as plataformas (Web/Mobile/PC/Console/Offline).
• A Singular incluirá o ID de utilizador nas exportações ao nível do utilizador, ETL e postbacks do BI interno (se configurado). O ID do usuário é um dado primário e a Singular não o compartilha com outras partes.
• O valor da ID de usuário, quando definido com o método Singular SDK, persistirá até que seja desmarcado usando o método UnsetCustomUserId ou até que o aplicativo seja desinstalado. Fechar ou reiniciar a aplicação não anula a definição do ID de utilizador.

Para definir o ID de utilizador, utilize o método SetCustomUserId. Para a anular (por exemplo, se o Utilizador "sair" da conta), ligue para UnsetCustomUserId.

Se você já sabe a ID de usuário quando o aplicativo é aberto, chame SetCustomUserId antes de inicializar o SDK do Singular. Dessa forma, o Singular pode ter a ID de usuário desde a primeira sessão. No entanto, a ID de usuário normalmente não está disponível até que o usuário se registre ou faça um login. Nesse caso, chame SetCustomUserId após a conclusão do fluxo de registo.

USingularSDKBPLibrary::SetCustomUserId("custom_user_id");

USingularSDKBPLibrary::UnsetCustomUserId();

USingularSDKBPLibrary::SetDeviceCustomUserId("custom_user_id");

Suporte à transparência de rastreamento de aplicativos do iOS 14+

No iOS 14+, os aplicativos precisam solicitar o consentimento do usuário antes de compartilhar dados do usuário, incluindo o uso do valor IDFA do dispositivo (consulte Transparência do rastreamento de aplicativos). A Singular se beneficia muito de ter o IDFA para identificar dispositivos e realizar a atribuição de instalação. Portanto, você deve solicitar o consentimento do usuário antes que o SDK Singular comece a enviar uma sessão de usuário e eventos de usuário para os servidores Singular.

Depois que o SDK envia uma sessão, ele aciona o processo de atribuição de instalação do Singular, com base apenas nos dados que estão disponíveis para o Singular naquele momento.

Para atrasar o envio de uma sessão de usuário e eventos de usuário pelo SDK, inicialize o Singular SDK com o parâmetro waitForTrackingAuthorizationWithTimeoutInterval. Se isso for feito:

1. O SDK será inicializado e começará a gravar uma sessão e eventos de usuário, mas ainda não os enviará para o servidor Singular.
2. Assim que o consentimento do App Tracking Transparency for concedido/negado ou o tempo limite definido expirar, o SDK enviará a sessão e quaisquer eventos em fila para o servidor Singular (com ou sem o IDFA).
3. Em seguida, o Singular iniciará o processo de atribuição, aproveitando o IDFA se ele estiver disponível.

Para obter mais informações, consulte Preparando para o iOS 14.