Guía de integración del SDK de Unreal Engine
Guía para | Desarrolladores Registro de cambios |
Requisitos previos |
|
Compatibilidad | Unreal Engine 4.23+ |
Guías de integración |
Creación de enlaces de referencia cortos
Nota: Esta funcionalidad está disponible en la versión 2.0.6+ del SDK.
Utilice los enlaces cortos para transformar enlaces singulares largos y llenos de parámetros en enlaces más cortos y seguros que resulten prácticos para compartir.
Normalmente, querrá crear enlaces cortos de forma dinámica para que los usuarios de su aplicación puedan compartirlos con sus amigos para invitarles a utilizar la aplicación.
Para crear un enlace corto, necesitas
- Un Enlace Singular que lleve a la descarga de tu app (consulta las Preguntas Frecuentes sobre Enlaces Singulares).
- Cualquier parámetro que desee añadir al enlace de forma dinámica (consulte Parámetros del enlace de seguimiento para ver la lista de opciones).
- El nombre y el ID del usuario que remite, si desea poder rastrear las nuevas instalaciones de la aplicación hasta el usuario que compartió el enlace.
Para habilitar los enlaces cortos, primero añada este código al constructor del personaje 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
}
A continuación, utilice el método CreateReferrerShortLink para crear un enlace corto como en el ejemplo siguiente.
// 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
);
Seguimiento de desinstalaciones
Nota: El seguimiento de desinstalaciones sólo está disponible para clientes Enterprise.
Seguimiento de desinstalaciones de Android
Para habilitar el seguimiento de desinstalaciones para su aplicación Android, primero configure la aplicación en la plataforma Singular como se detalla en Configuración del seguimiento de desinstalaciones. A continuación, siga las siguientes instrucciones.
Nota: Google dejó obsoletas las API de FCM en abril de 2018. Utiliza FCM para el seguimiento de desinstalaciones.
Cómo habilitar el seguimiento de desinstalaciones mediante la mensajería en la nube de Firebase (FCM)
1. Integre con FCM:
Para realizar un seguimiento de las desinstalaciones, puedes utilizar los servicios de la plataforma Firebase Cloud Messaging (FCM). Si aún no está utilizando FCM siga las instrucciones de Google sobre cómo configurar una aplicación cliente de Firebase Cloud Messaging en Android.
Requisitos de FCM(fuente)
Los clientes FCM requieren dispositivos con Android 4.1 o superior que también tengan instalada la aplicación Google Play Store, o un emulador que ejecute Android 4.1 con las API de Google. Ten en cuenta que no estás limitado a desplegar tus aplicaciones Android a través de Google Play Store.
Los usuarios/dispositivos que no se ejecuten en versiones compatibles de Android no estarán disponibles para el seguimiento de desinstalación de Singular.
2. Actualice el archivo AndroidManifest.xml:
Actualiza tu archivo AndroidManifest.xml para añadir el filtro de intent necesario para tu app (sustituye MyFirebaseMessagingService por tu clase que implemente el servicio 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. Registra y envía el token de dispositivo FCM:
Por último, establezca el token de dispositivo FCM después de inicializar su SingularConfig en OnCreate(), como se indica a continuación:
Singular.setFCMDeviceToken(String fcmDeviceToken);
Seguimiento de desinstalación de iOS
El seguimiento de desinstalación en iOS se basa en la tecnología de notificaciones push de Apple. Si su aplicación no admite actualmente notificaciones push, consulte la guía de Apple. Si su aplicación ya es compatible con las notificaciones push, todo lo que tiene que hacer es pasar el token de dispositivo devuelto por APNS mediante el método RegisterDeviceTokenForUninstall, una vez inicializado el SDK.
Método SetUninstallToken de SingularSDK |
|
---|---|
Descripción | Pasa el token de dispositivo devuelto por APNS / FCM. Tenga en cuenta que el token de APNS / FCM suele ser un dato binario en su forma nativa, pero debe pasarlo como cadena. |
Firma |
|
Ejemplo de uso |
|
Cumplimiento de las leyes de protección de datos
Singular proporciona funcionalidad de protección de la privacidad para ayudarle a cooperar con cualquier socio que pueda estar cumpliendo con las leyes de privacidad del consumidor, como GDPR y CCPA(Ley de Privacidad del Consumidor de California). Estos socios quieren ser notificados si el usuario final ha dado su consentimiento para compartir su información privada.
Limitar el uso compartido de datos
Si ha implementado una forma de solicitar a los usuarios su consentimiento para compartir su información, utilice el método limitDataSharing para notificar a Singular la elección del usuario:
- Utilice limitDataSharing:NO para indicar que el usuario ha dado su consentimiento (optado) para compartir su información.
- Utilice limitDataSharing:YES si el usuario no dio su consentimiento.
Singular utiliza LimitDataSharing en los"Postbacks de Privacidad del Usuario", así como en la transmisión de esta información a socios que la requieren para cumplir con la normativa pertinente. Consulte"Privacidad del usuario y Limitar el uso compartido de datos" para obtener más información.
Nota: El uso del método es opcional, pero puede haber información de atribución que el socio compartirá con Singular sólo si se le notifica específicamente que el usuario ha optado por ello.
Método LimitDataSharing de SingularSDK | |
---|---|
Firma | public void LimitDataSharing(bool shouldLimitDataSharing) |
Descripción | Notifica a Singular el consentimiento del usuario (opt-in) para compartir datos privados. El método Limitar el uso compartido de datos le ofrece una opción para controlar si su aplicación envía datos del usuario a terceros. Esto resulta útil si desea restringir el uso compartido de datos en función de las preferencias del usuario o los requisitos de privacidad. |
Ejemplo de uso |
|
Métodos adicionales para el cumplimiento del GDPR
Singular SDK proporciona varios métodos para ayudarle a cumplir con las políticas GDPR y permitir que Singular conozca el consentimiento o no consentimiento del usuario para el seguimiento.
Método TrackingOptIn de SingularSDK | |
---|---|
Descripción | Notifica a Singular el consentimiento del usuario (opt-in) para el seguimiento. El método TrackingOptIn() se utiliza para enviar un evento "gdpr" a los servidores de Singular. Si no llama a este método, la aplicación continuará rastreando a los usuarios como si hubieran dado su consentimiento, pero no los marcará específicamente como GDPR opt-in. Si su aplicación necesita cumplir con el GDPR (Reglamento General de Protección de Datos), debe llamar a esta función para asegurarse de que el consentimiento del usuario se registra correctamente. |
Ejemplo de uso |
|
Método StopAllTracking de SingularSDK | |
Descripción | Detiene todas las actividades de seguimiento de este usuario en esta aplicación.
Nota: Al llamar a este método se desactiva el SDK, incluso después de reiniciar la aplicación (el estado es persistente). La única forma de volver a activar el seguimiento es llamando a resumeAllTracking().
|
Ejemplo de uso |
|
Método ResumeAllTracking de SingularSDK | |
Descripción | Reanuda el seguimiento para este usuario en esta aplicación. |
Ejemplo de uso |
|
SingularSDK Método IsAllTrackingStopped | |
Descripción | Comprueba el estado del seguimiento de este usuario en esta aplicación. Devuelve true si el seguimiento se ha detenido mediante StopAllTracking() y no se ha reanudado. |
Ejemplo de uso |
|
Guía de integración de Unreal Engine SDK
Guías de integración |