Guia de integração do SDK do Unreal Engine
Guia para | Desenvolvedores Registro de alterações |
Pré-requisitos |
|
Compatibilidade | Unreal Engine 4.23+ |
Guias de integração |
Criação de links de referência curtos
Observação: essa funcionalidade está disponível na versão 2.0.6+ do SDK.
Utilize links curtos para transformar Links Singulares longos e cheios de parâmetros em links mais curtos e mais seguros que são convenientes para partilha.
Normalmente, pretende criar ligações curtas de forma dinâmica para que os utilizadores da sua aplicação possam partilhá-las com amigos para os convidar a utilizar a aplicação.
Para criar um link curto, você precisa de:
- Um link singular que leva ao download do seu aplicativo (consulte as Perguntas frequentes sobre links singulares).
- Quaisquer parâmetros que queira adicionar ao link dinamicamente (consulte Parâmetros de link de rastreamento para obter a lista de opções).
- O nome e a ID do usuário de referência, se você quiser rastrear as novas instalações do aplicativo até o usuário que compartilhou o link.
Para habilitar links curtos, primeiro adicione este código ao construtor do personagem principal:
if (AUnrealTestAppCharacter::singularDelegates == NULL) {
AUnrealTestAppCharacter::singularDelegates =
CreateDefaultSubobject<USingularDelegates>(TEXT("SingularShortLinksHandler"));
singularDelegates->OnSingularShortLinksResolved.AddDynamic(this, &AUnrealTestAppCharacter::SingularShortLinksResolved);
}
void AUnrealTestAppCharacter::SingularShortLinksResolved(const FSingularShortLinkParams& linkParams) {
const FString shortLinkURL = linkParams.SingularShortLinksParams["data"];
const FString errorMessage = linkParams.SingularShortLinksParams["error"];
// Add your share logic here
// If there is an error, add logic to retry/abort/modify the params passed
// to the function, based on the cause of the error
}
Em seguida, use o método CreateReferrerShortLink para criar um link curto, como no exemplo abaixo.
// Add parameters to the link (if they don't already exist in the long link URL)
TMap<FString, FString> params;
params.Add(TEXT("channel"), TEXT("sms"));
params.Add(TEXT("anotherparam"), TEXT("paramvalue"));
// Create the short link based on the original Singular Link URL
// with a referrer name, referrer ID, and optional additional parameters
USingularSDKBPLibrary::CreateReferrerShortLink(
"https://sample.sng.link/B4tbm/v8fp?_dl=https%3A%2F%2Fabc.com",
"referrer name",
"referrer ID",
params
);
Acompanhamento de desinstalações
Nota: O rastreamento de desinstalação está disponível apenas para clientes Enterprise.
Rastreamento de desinstalação do Android
Para ativar o rastreamento de desinstalação para seu aplicativo Android, primeiro configure o aplicativo na plataforma Singular conforme detalhado em Configurando o rastreamento de desinstalação. Em seguida, siga as instruções abaixo.
Observação: o Google descontinuou as APIs do GCM em abril de 2018. Use o FCM para rastreamento de desinstalação.
Como ativar o rastreamento de desinstalação usando o Firebase Cloud Messaging (FCM)
1. Integrar com o FCM:
Para rastrear desinstalações, você pode usar os serviços da plataforma Firebase Cloud Messaging (FCM). Se ainda não estiver usando o FCM, siga as instruções do Google sobre como Configurar um aplicativo cliente do Firebase Cloud Messaging no Android.
Requisitos do FCM(fonte)
Os clientes FCM requerem dispositivos com Android 4.1 ou superior que também tenham o aplicativo Google Play Store instalado ou um emulador com Android 4.1 com APIs do Google. Tenha em atenção que não está limitado a implementar as suas aplicações Android através da Google Play Store.
Os utilizadores/dispositivos que não estejam a executar versões suportadas do Android não estarão disponíveis para o rastreio de desinstalação Singular.
2. Atualizar o arquivo AndroidManifest.xml:
Actualize o seu ficheiro AndroidManifest.xml para adicionar o filtro de intenção necessário para a sua aplicação (substitua MyFirebaseMessagingService pela sua classe que implementa o Serviço Firebase):
<service android:name=".java.MyFirebaseMessagingService"
android:exported="false">
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter> </service>
<service
android:name=".java.MyFirebaseMessagingService"
android:exported="false">
intent-filter>
action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
3. Registar e enviar o FCM Device Token:
Por fim, defina o token de dispositivo FCM depois que o SingularConfig for inicializado em OnCreate(), da seguinte forma:
Singular.setFCMDeviceToken(String fcmDeviceToken);
Rastreamento de desinstalação do iOS
O rastreamento de desinstalação no iOS é baseado na tecnologia de notificação por push da Apple. Se o seu aplicativo não suporta atualmente notificações push, consulte o guia da Apple. Se a sua aplicação já suporta notificações push, tudo o que precisa de fazer é passar o token de dispositivo devolvido pelo APNS utilizando o método RegisterDeviceTokenForUninstall, depois de o SDK ser inicializado.
Método SetUninstallToken do SingularSDK |
|
---|---|
Descrição | Passa o token de dispositivo retornado do APNS / FCM. Note-se que o token APNS / FCM é normalmente um dado binário na forma nativa, mas é necessário passá-lo como uma cadeia de caracteres. |
Assinatura |
|
Exemplo de utilização |
|
Conformidade com as leis de privacidade de dados
A Singular fornece a funcionalidade de proteção da privacidade para o ajudar a cooperar com quaisquer parceiros que possam estar em conformidade com as leis de privacidade do consumidor, como o GDPR e o CCPA(California Consumer Privacy Act). Estes parceiros querem ser notificados se o utilizador final consentiu em partilhar as suas informações privadas.
Limitar a partilha de dados
Se você implementou uma maneira de pedir o consentimento dos usuários para compartilhar suas informações, use o método limitDataSharing para notificar a Singular sobre a escolha do usuário:
- Utilize limitDataSharing:NO para indicar que o utilizador consentiu (optou por aceitar) a partilha das suas informações.
- Utilize limitDataSharing:YES se o utilizador não deu o seu consentimento.
A Singular utiliza o LimitDataSharing em"Postbacks de privacidade do utilizador", bem como a transmissão destas informações a parceiros que as exigem para cumprir os regulamentos relevantes. Consulte"Privacidade do utilizador e Limitar partilha de dados" para obter mais informações.
Nota: A utilização do método é opcional, mas pode haver informações de atribuição que o parceiro partilhará com a Singular apenas se for especificamente notificado de que o utilizador optou por participar.
Método LimitDataSharing do SingularSDK | |
---|---|
Assinatura | public void LimitDataSharing(bool shouldLimitDataSharing) |
Descrição | Notifica a Singular sobre o consentimento do usuário (opt-in) para compartilhar dados privados. O método Limitar compartilhamento de dados oferece uma opção para controlar se seu aplicativo envia dados do usuário para terceiros. Isto é útil se quiser restringir a partilha de dados com base nas preferências do utilizador ou nos requisitos de privacidade. |
Exemplo de utilização |
|
Métodos adicionais para conformidade com o GDPR
O Singular SDK fornece vários métodos para ajudá-lo a cumprir as políticas do GDPR e permitir que o Singular saiba sobre o consentimento ou não consentimento do usuário para rastreamento.
Método TrackingOptIn do SingularSDK | |
---|---|
Descrição | Notifica a Singular sobre o consentimento do usuário (opt-in) para rastreamento. O método TrackingOptIn() é usado para enviar um evento "gdpr" para os servidores da Singular. Se você não chamar esse método, o aplicativo continuará rastreando os usuários como se eles tivessem dado consentimento, mas não os marcará especificamente como opt-in do GDPR. Se o seu aplicativo precisa estar em conformidade com o GDPR (Regulamento Geral de Proteção de Dados), você deve chamar essa função para garantir que o consentimento do usuário seja registrado corretamente. |
Exemplo de utilização |
|
Método StopAllTracking do SingularSDK | |
Descrição | Interrompe todas as actividades de rastreio para este utilizador nesta aplicação.
Nota: Chamar este método desactiva efetivamente o SDK, mesmo depois de a aplicação ser reiniciada (o estado é persistente)! A única forma de voltar a ativar o rastreio é chamar resumeAllTracking().
|
Exemplo de utilização |
|
Método ResumeAllTracking do SingularSDK | |
Descrição | Retoma a monitorização para este utilizador nesta aplicação. |
Exemplo de utilização |
|
Método SingularSDK IsAllTrackingStopped | |
Descrição | Verifica o estado do rastreio para este utilizador nesta aplicação. Devolve true se a localização tiver sido interrompida utilizando StopAllTracking() e não tiver sido retomada. |
Exemplo de utilização |
|
Guia de integração do Unreal Engine SDK
Guias de integração |