Integración SDK singular para Flutter

 

El SDK de Singular está disponible como complemento para Flutter. Las siguientes instrucciones le muestran cómo integrar Singular en su aplicación Flutter.

Requisitos previos

  • En este artículo se da por sentado que dispone de una aplicación Flutter funcional.
  • Para inicializar el SDK, necesita su Clave SDK de Singular y su Secreto SDK. Puede obtenerlas en la plataforma Singular en "Developer Tools > SDK Integration > SDK Keys".

Novedad: Guía en vídeo

Vea este vídeo para obtener una visión detallada del proceso de integración. Le recomendamos que utilice tanto el vídeo como la guía escrita que aparece a continuación.

Integración del plugin de Singular

Para añadir el plugin Singular a tu aplicación Flutter, añade las siguientes líneas a tu archivo pubspec.yaml:

dependencies:
  singular_flutter_sdk: ^1.4.0

A continuación, vaya a su proyecto en el terminal y ejecute lo siguiente:

flutter packages get

Pasos adicionales para Android

Añadir dependencias

Para las aplicaciones de Android, es necesario añadir la biblioteca Singular a la lista de dependencias en app/build.gradle, como se indica a continuación:

dependencies {  
  implementation fileTree(dir: 'libs', include: ['*.jar'])
  implementation 'com.android.support:appcompat-v7:28.0.0'
  //...
}

Singular SDK requiere Google Mobile Ads API, que forma parte de Google Play Services APIs 17.0.0+. Si ya has integrado Google Play Services en tu aplicación, el requisito se cumple. Si no lo has hecho, puedes integrar Google Mobile Ads de forma individual incluyendo la siguiente dependencia en el archivo build.gradle de tu aplicación:

implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'

Si has desactivado las dependencias transitivas para Singular SDK, añade lo siguiente al build. gradle de tu aplicación.

implementation 'com.android.installreferrer:installreferrer:2.2'
implementation 'com.google.android.gms:play-services-appset:16.0.2'

Nota: Si se produce un error DuplicateClasses en el momento de la compilación, es posible que ya disponga de Google play-services y puede comentar la dependencia.

Añadir permisos

Añade estos permisos bajo la etiqueta <manifest> en tu archivo AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="BIND_GET_INSTALL_REFERRER_SERVICE" />
<uses-permission android:name="com.android.vending.CHECK_LICENSE" />

Si la compilación de tu aplicación está orientada a Android 12/API nivel 31 o superior, añade permisos para acceder al ID de publicidad de Google:

<uses-permission android:name="com.google.android.gms.permission.AD_ID" />

Nota: No añadas este permiso si estás integrando el SDK para niños.

Precaución: Si tu aplicación tiene el permiso android.permission.GET_TASKS, es posible que la aplicación se inicialice antes de que el usuario la abra realmente. Esto puede inicializar el SDK Singular y causar discrepancias en el tiempo de instalación. Para evitar el problema, elimine el permiso si no es necesario, o mueva la llamada a la inicialización de Singular SDK a otra parte del código, asegurándose de que sólo se llame después de que el usuario abra la aplicación por primera vez.

Pasos adicionales para iOS

Para utilizar el plugin de Singular, tiene que añadir el framework AdServices.

Inicialización del SDK de Singular

El código de inicialización de Singular SDK debe invocarse cada vez que se abre la aplicación. Es un requisito previo para todas las funciones de atribución de Singular y también envía una nueva sesión de usuario a Singular (las sesiones se utilizan para calcular la retención de usuarios).

El código de inicialización va en el widget principal de la aplicación (es decir, main.dart), el primero que se carga al abrir la aplicación. Este widget tiene que ser stateful, y el código tiene que ser añadido en el método initState() del widget.

  1. En primer lugar, debe crear un objeto SingularConfig. El objeto contiene tu Clave y Secreto de Singular SDK.
  2. Si lo desea, puede añadir opciones para activar varias funciones del SDK. Consulte la lista completa de opciones.
  3. META Install Atribución de referencias

    Configuración SDK necesaria para activar la atribución "Meta Install Referrer":

    1. Proporcione su Id de aplicación de Facebook en el objeto de configuración singular.
      // Para habilitar META Install Referrer
      config.facebookAppId = "INSERTE AQUÍ EL ID DE SU APLICACIÓN DE FACEBOOK";
    Dónde puedo encontrar el Facebook App ID de una aplicación?

Ejemplo:

import 'package:singular_flutter_sdk/singular.dart';
import 'package:singular_flutter_sdk/singular_config.dart';
//...
class MyHomePage extends StatefulWidget { 
//... } class _MyHomePageState extends State<MyHomePage> {
//... @override  void initState() { super.initState();
//... SingularConfig config = new SingularConfig('SDK KEY', 'SDK SECRET'); // Establecer ID de usuario hash si está disponible
config.customUserId = "b642b4217b34b1e8d3bd915fc65c4452";

// Para iOS (elimine esto si no muestra un mensaje ATT).
config.waitForTrackingAuthorizationWithTimeoutInterval = 300;

// Para habilitar META Install Referrer
config.facebookAppId = "INSERTE AQUÍ EL ID DE SU APLICACIÓN DE FACEBOOK";

// Para habilitar el soporte de SkAdNetwork
config.skAdNetworkEnabled = true;

/* (opcional) Uso de la función Propiedades globales singulares para capturar identificadores de terceros. Los SDK respectivos deben inicializarse antes que el SDK de Singular. Ejemplo de cómo pasar el CleverTapID.*/
// var cleverTapId = CleverTapPlugin.getCleverTapID();
// config.withGlobalProperty("CLEVERTAPID", cleverTapId, true);
Singular.start(config); }

Envío del ID de usuario a Singular (opcional)

Puede enviar su ID de usuario interno a Singular utilizando un método del SDK de Singular.

Nota: Si utiliza la solución multidispositivo de Singular, debe recopilar el ID de usuario en todas las plataformas.

  • El ID de usuario puede ser cualquier identificador y no debe exponer PII (Personally Identifiable Information). Por ejemplo, no debe utilizar la dirección de correo electrónico, el nombre de usuario o el número de teléfono de un usuario. Singular recomienda utilizar un valor hash único sólo para sus datos de origen.
  • El valor de ID de usuario que se pasa a Singular también debe ser el mismo ID de usuario interno que se captura en todas las plataformas (Web/Móvil/PC/Consola/Offline).
  • Singular incluirá el ID de usuario en las exportaciones a nivel de usuario, ETL y devoluciones internas de BI (si está configurado). El ID de usuario es un dato de origen y Singular no lo comparte con terceros.
  • El valor del ID de usuario, cuando se establece con el método Singular SDK, persistirá hasta que se desactive utilizando el método unsetCustomUserId o hasta que se desinstale la aplicación. Cerrar o reiniciar la aplicación no anula el ID de usuario.

Para establecer el ID de usuario, utilice el método setCustomUserId. Para desactivarlo (por ejemplo, si el usuario "cierra sesión" en la cuenta), llame a unsetCustomUserId.

Nota: Si varios usuarios utilizan un único dispositivo, recomendamos implementar un flujo de cierre de sesión para establecer y desestablecer el ID de usuario para cada inicio y cierre de sesión.

Si ya conoce el ID de usuario cuando se abre la aplicación, llame a setCustomUserId antes de inicializar Singular SDK. De esta forma, Singular puede tener el ID de usuario desde la primera sesión. Sin embargo, el ID de usuario no suele estar disponible hasta que el usuario se registra o realiza un inicio de sesión. En ese caso, llame a setCustomUserId una vez finalizado el flujo de registro.

Método Singular.setCustomUserID
Descripción Envía el ID de usuario a Singular.
Firma static void setCustomUserId(String customUserId)
Ejemplo de uso
Singular.setCustomUserId("custom_user_id");
Método Singular.unsetCustomUserID
Descripción Anula la configuración del ID de usuario que se ha enviado a Singular.
Firma static void unsetCustomUserId()
Ejemplo de uso
Singular.unsetCustomUserId();

Opcional: Asignación del ID de usuario personalizado

Importante: Esta función Enterprise avanzada sólo está disponible en casos excepcionales. Por favor, consulte con uno de los Ingenieros de Soluciones de Singular antes de implementarla.

Singular puede recibir datos adicionales de seguimiento de eventos móviles a través de una integración de servidor a servidor. Para utilizar esta función, debe asignar el ID de usuario al identificador de seguimiento de dispositivos móviles de Singular.

Nota: Llame a este método tan pronto como sea posible después de inicializar el SDK de Singular o una vez que tenga el ID de usuario.

Método Singular.setDeviceCustomUserId
Descripción Establece el Id. de usuario personalizado igual que el inicio de sesión y lo asigna al identificador de seguimiento de Singular.
Firma static void setDeviceCustomUserId(String customUserId)
Ejemplo de uso
Singular.setDeviceCustomUserId("custom_user_id");

Implementación de enlaces profundos

Los enlaces profundos son enlaces que abren la aplicación en el teléfono del usuario y lo envían directamente a una página o experiencia de usuario específica, en lugar de limitarse al widget principal de la aplicación. Los enlaces profundos se utilizan normalmente en campañas de retargeting, dirigidas a usuarios que ya tienen la aplicación en su teléfono pero que puede que no hayan interactuado con ella durante un tiempo. Singular soporta enlaces profundos a través de Singular Links.

Activación de Singular Links

Para activar Singular Links en iOS y en Android, consulte Requisitos previos de Singular Links.

Para la compatibilidad con Android, añada el siguiente código en el archivo MainActivity.java del proyecto:

Java Kotlin
import com.singular.flutter_sdk.SingularBridge;
import android.content.Intent;

@Override protected void onNewIntent(@NonNull Intent intent) {   super.onNewIntent(intent);   SingularBridge.onNewIntent(intent); }

Para compatibilidad con iOS, en el archivo AppDelegate.m del proyecto, añada lo siguiente:

 

Objective-C Swift
// Parte superior de AppDelegate.m
            
#import "SingularAppDelegate.h"

- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {    [GeneratedPluginRegistrant registerWithRegistry:self];    [SingularAppDelegate shared].launchOptions = launchOptions; return [super application:application
didFinishLaunchingWithOptions:launchOptions]; }
- (BOOL)application:(UIApplication *)application
continueUserActivity:(NSUserActivity *)userActivity
restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>>
*restorableObjects))restorationHandler {    [[SingularAppDelegate shared] continueUserActivity:userActivity
restorationHandler:restorationHandler];    return [super application:application continueUserActivity:userActivity
restorationHandler:restorationHandler ]; }
- (BOOL)application:(UIApplication *)app
openURL:(NSURL *)url
options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {     [[SingularAppDelegate shared] handleOpenUrl:url options:options];      return [super application:app openURL:url options: options]; }

Manejo de enlaces de Singular

Utilice el mecanismo de gestión de Singular para leer los detalles del enlace de seguimiento que ha llevado a la apertura de la aplicación.

Por ejemplo

SingularConfig config = new SingularConfig('<SDK KEY>', '<SDK SECRET>');

config.singularLinksHandler = (SingularLinkParams params) { String deeplink = params.deeplink; String passthrough = params.passthrough; bool isDeferred = params.isDeferred; // Agregue su código aquí para manejar el enlace profundo }; Singular.init(config);

Seguimiento de eventos (no ingresos)

Singular puede recopilar datos sobre eventos dentro de la aplicación para ayudar a analizar el rendimiento de sus campañas y medir los KPI.Por ejemplo, es posible que su organización desee recopilar datos sobre inicios de sesión de usuarios, registros, finalización de tutoriales o subidas de nivel en una aplicación de juegos.

Singular soporta una variedad de eventos estándar. Las redes publicitarias suelen admitir estos eventos de uso común para la generación de informes y la optimización. Otra ventaja es que cuando utiliza nombres de eventos estándar, Singular los reconoce automáticamente y los añade a la lista de eventos sin que tenga que definirlos manualmente. Recomendamos utilizar eventos estándar siempre que sea posible.

La lista de eventos enviados a Singular (con los atributos que los acompañan) debe ser compilada por el equipo de UA/marketing/negocio basándose en los KPI de marketing de su organización. El equipo comercial puede seguir la guía Cómo realizar el seguimiento de los eventos In-App: Guía para clientes de Singular Attribution.

Con cada evento que rastree, puede pasar varios atributos. Consulte los atributos estándar recomendados por evento.

En su código, envíe eventos a Singular utilizando los métodos event o eventWithArgs.

Nota: Para los eventos estándar, utilice el nombre Flutter del evento tal y como aparece en la Lista de eventos y atributos estándar del SDK de Flutter,por ejemplo, sngLogin.

Para los eventos personalizados, eventos que su organización desea medir y que no coinciden con ninguno de los eventos estándar de Singular, utilice cualquier nombre personalizado (con un máximo de 32 caracteres). Recomendamos utilizar nombres en inglés para que sean compatibles con los socios de redes publicitarias que puedan recibir el evento de Singular con fines de optimización.

Ejemplo

Singular.event(Events.sngLogin);
Singular.eventWithArgs(eventName, {attributeName:attributeValue});
Map<String, Object> map = HashMap<String, Object>();
map ['name'] = 'John Doe';
map ['age'] = 30;
map ['isStudent'] = false;
Singular.eventWithArgs('event_Name', map);

Seguimiento de ingresos

Envío de eventos IAP

Para que Singular pueda hacer un seguimiento de los ingresos que genera su aplicación, envíe eventos IAP a Singular. Al enviar el evento IAP también permite a Singular comprobar los datos de verificación del evento y asegurarse de que no son fraudulentos.

Vea el siguiente ejemplo.

Nota : Este fragmento de código requiere el paquete Flutter IAP en https://pub.dev/packages/in_app_purchase.

import 'package:singular_flutter_sdk/singular_iap.dart';
import 'dart:io' show Platform;
            
if (Platform.isIOS) {
  singularPurchase = new SingularIOSIAP(
    product.rawPrice.toStringAsFixed(2),
    product.currencyCode,
    purchase.productID,
    purchase.purchaseID,
    purchase.verificationData.serverVerificationData
  );
}
            
else if (Platform.isAndroid) {
  singularPurchase = new SingularAndroidIAP(
    product.rawPrice.toStringAsFixed(2),
    product.currencyCode,
    purchase.verificationData.serverVerificationData,
    purchase.verificationData.localVerificationData
  );
}
            
Singular.inAppPurchase(eventName, singularPurchase);

Nota : Pase la divisa como un código de divisa ISO 4217 de tres letras, por ejemplo, "USD", "EUR", "INR".

Método alternativo: Envío de eventos de ingresos personalizados

Singular también ofrece la opción de informar de los ingresos simplemente enviando un evento de ingresos personalizado con un nombre y un importe de ingresos. Tenga en cuenta que este método no comparte el recibo de compra con Singular y, por lo tanto, no permite a Singular verificar que se trata de un evento legítimo.

Por ejemplo:

Singular.customRevenue("MyCustomRevenue", "USD", 5.50);
Map<String, Object> map = HashMap<String, Object>();
map ['name'] = 'John Doe';
map ['age'] = 30;
map ['isStudent'] =false;
Singular.customRevenueWithAttributes('MyCustomRevenue','USD', 20, map);

Nota: Pase la divisa como un código de divisa ISO 4217 de tres letras, por ejemplo, "USD", "EUR", "INR".

Seguimiento de Eventos Híbrido (Avanzado)

Singular recomienda enviar todos los eventos e ingresos a través del SDK de Singular integrado en su app. Sin embargo, Singular puede recoger eventos e ingresos de otras fuentes.

Cualquier evento NO enviado desde el SDK de Singular debe cumplir con los requisitos de documentación de eventos de servidor a servidor de Singular y proporcionar el identificador de dispositivo correspondiente para atribuir correctamente un evento.

Importante:

Se producirán discrepancias si los identificadores de dispositivo utilizados en las solicitudes de eventos de servidor a servidor no tienen un identificador de dispositivo coincidente en Singular. Tenga en cuenta las siguientes posibilidades:

  • Si se recibe una solicitud de evento "antes" de que Singular SDK haya registrado el identificador de dispositivo, desde una App Session, entonces la solicitud de evento se considerará la "primera sesión" para el dispositivo desconocido, y Singular atribuirá el dispositivo como una atribución orgánica.
  • Si Singular SDK registró un identificador de dispositivo, pero el identificador de Singular SDK difiere del identificador de dispositivo especificado en la solicitud de evento de servidor a servidor, entonces el evento se atribuirá incorrectamente.

Guías de seguimiento de eventos híbridos

Envío de eventos desde un servidor interno

Singular puede recopilar datos sobre los ingresos de su Servidor para ayudar a analizar el rendimiento y el ROI de sus campañas.

Requisitos:

  • Desde un Evento de Registro o Inicio de Sesión in-app, capture y pase los identificadores de dispositivo y almacene estos datos con el ID de Usuario en su servidor. Dado que los identificadores de dispositivo pueden cambiar para un usuario, asegúrese de actualizar los identificadores cuando un usuario genere una sesión de aplicación. Esto garantiza que el evento del lado del servidor se atribuya al dispositivo correcto.
  • Los eventos del lado del servidor son específicos de cada plataforma y sólo deben enviarse con el identificador de dispositivo que coincida con la plataforma del dispositivo (por ejemplo, IDFA o IDFV para dispositivos iOS).
  • Puede utilizar el mecanismo de postback de Singular Internal BI para enviar un evento en tiempo real a su endpoint interno para que pueda actualizar el conjunto de datos en el lado del servidor. Consulte las Preguntas Frecuentes sobre Postback de BI Interno.
  • Revise la sección "Seguimiento de Ingresos" en la guía de Integración Servidor-a-Servidor para más detalles.
Envío de Eventos desde un Proveedor de Ingresos
Proveedores de terceros como RevenueCat o adapty pueden proporcionar Ingresos por Compras y Suscripciones a Singular.

Siga los siguientes enlaces para obtener más información sobre cómo habilitar a estos socios.

Envío de Eventos desde Segmento

Para que Segment pueda enviar eventos a Singular, en paralelo con el SDK de Singular, debe añadir un Destino "Cloud-Mode" en Segment. Siga nuestra guía AQUÍ.

Añadir soporte de atribución de ingresos publicitarios

Puede configurar la atribución de ingresos publicitarios a través del SDK de Singular.

Para añadir soporte de atribución de ingresos publicitarios mediante el SDK de Flutter:

  1. Añada el fragmento de código adecuado para obtener información sobre ingresos publicitarios de la plataforma de mediación que utilice para los datos de ingresos publicitarios.

    Consulte los fragmentos de código en nuestra documentación Android SDK.

Nota: pase la divisa como un código de divisa ISO 4217 de tres letras, por ejemplo, "USD", "EUR", "INR".

Notifique los eventos de ingresos publicitarios a Singular utilizando el siguiente código
  1. Inicialice el objeto SingularAdData con los datos pertinentes.
  2. Comunique los datos a Singular
Dart
SingularAdData adData = SingularAdData(
"TU_PLATAFORMA_ANUNCIO",
"CÓDIGO_MONEDA",
0.05) Singular.adRevenue(adData)

Añadir soporte SKAdNetwork

Para activar el seguimiento de SKAdNetwork para su aplicación, active la opción de configuración skAdNetworkEnabled antes de inicializar Singular.

Modo gestionado (recomendado)

En el modo gestionado, Singular gestiona el valor de conversión de SKAdNetwork por usted automáticamente, basándose en un modelo de conversión de su elección que puede configurar en la plataforma Singular.

Para obtener más información, consulte Comprender lagestión del valor de conversión de Singular y las Preguntas frecuentes sobre la configuración del modelo de SKAdNetwork. Para obtener una guía paso a paso sobre el uso de SKAdNetwork con Singular, consulte Cómo empezar con SKAdNetwork.

Nota: El modo SKAN Managed ya está activado en el fragmento de código de inicialización anterior.Asegúrese de que estos elementos de configuración están activados.

Para habilitar SKAdNetwork en modo gestionado, utilice el siguiente código:

SingularConfig config = new SingularConfig('<SDK KEY>', '<SDK SECRET>');
config.skAdNetworkEnabled = true;
config.waitForTrackingAuthorizationWithTimeoutInterval = 300; Singular.init(config);

Modo manual

Si ya dispone de su propia estrategia y herramientas para gestionar el valor de conversión de SKAdNetwork, puede habilitar SKAdNetwork en modo manual.

SingularConfig config = new SingularConfig('SDK KEY', 'SDK SECRET');
config.skAdNetworkEnabled = true;
config.manualSkanConversionManagement = true;
config.waitForTrackingAuthorizationWithTimeoutInterval = 300; Singular.init(config);

A continuación, para actualizar el valor de conversión, utilice el siguiente código:

ingular.skanUpdateConversionValue(conversionValue)

Para saber cuándo cambia el valor de conversión, utilice la siguiente función de devolución de llamada:

config.conversionValueUpdatedCallback = (int conversionValue) {
  print('Received conversionValueUpdatedCallback: ' + conversionValue.toString());
};

Para recuperar el valor de conversión actual, utilice el siguiente código:

Singular.skanGetConversionValue().then((conversionValue) {
  print('conversion value: ' + conversionValue.toString());
});

Otras opciones

Seguimiento de desinstalaciones

Para que Singular realice un seguimiento de las desinstalaciones de aplicaciones, facilite a Singular el token APNS/FCM, como en el siguiente ejemplo:

// iOS
Singular.registerDeviceTokenForUninstall(apnsToken);
            
// Android
Singular.registerDeviceTokenForUninstall(fcmToken);

Cumplimiento de las leyes de privacidad de datos

Singular proporciona una 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(California Consumer Privacy Act). Estos socios quieren ser notificados si el usuario final ha dado su consentimiento para compartir su información privada.

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 Singular .limitDataSharing(false) para indicar que el usuario ha consentido (optado) en compartir su información.

Utilice Singular.limitDataSharing( true) 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 los 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 notifica específicamente que el usuario ha optado por ello.

Método Singular.limitDataSharing
Firma Singular.limitDataSharing(booleanshouldLimitDataSharing)
Descripción Notifica a Singular el consentimiento del usuario (opt-in) para compartir datos privados.
Ejemplo de uso
// El usuario ha optado por compartir datos
Singular.limitDataSharing(false);

Métodos adicionales para el cumplimiento de GDPR

El SDK de Singular proporciona varios métodos para ayudarle a cumplir con las políticas GDPR y comunicar a Singular el consentimiento o no consentimiento del usuario para el seguimiento.

Método Singular.trackingOptIn
Descripción Notifica a Singular el consentimiento del usuario (opt-in) para el seguimiento.
Ejemplo de uso
Singular.trackingOptIn();
Método Singular .stopAllTracking
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
Singular.stopAllTracking();
Singular.resumeAllTracking Método
Descripción Reanuda el seguimiento para este usuario en esta aplicación.
Ejemplo deuso
Singular.resumeAllTracking();
Singular .isAllTrackingStoppedMétodo
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 deuso
Singular.isAllTrackingStopped();