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, necesitas la clave y el secreto del SDK de Singular. Puedes obtenerlas en la plataforma Singular en"Developer Tools > SDK Integration > SDK Keys".

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.1

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'

Además, añada lo siguiente para admitir la referencia de instalación de Samsung Galaxy Store si su aplicación se distribuye a través de Samsung Galaxy Store:

implementation 'store.galaxy.samsung.installreferrer:samsung_galaxystore_install_referrer:4.0.0'

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" />

Además, añade lo siguiente para admitir el referente de instalación de Samsung Galaxy Store si tu aplicación se distribuye a través de Samsung Galaxy Store y está orientada a Android 11 o superior:

<queries>
   <package android:name="com.sec.android.app.samsungapps" />
</queries>

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" />

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 la clave y el secreto de Singular SDK.
2. Opcionalmente, puede añadir opciones para activar varias funciones del SDK. Consulte la lista completa de opciones.
3. Instalación de META Soporte de atribución de referencia

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

   1. Proporcione su Id. de aplicación de Facebook en el objeto de configuración singular.
      

      // To enable META Install Referrer
                config.facebookAppId = "INSERT YOUR FACEBOOK APP ID HERE";

   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');
      // Set hashed User ID if available
      config.customUserId = "b642b4217b34b1e8d3bd915fc65c4452";
      
      // For iOS (Remove this if you are not displaying an ATT prompt)!
      config.waitForTrackingAuthorizationWithTimeoutInterval = 300;
      
      // To enable SkAdNetwork Support
      config.skAdNetworkEnabled = true;
      
      // To enable META Install Referrer
      config.facebookAppId = "INSERT YOUR FACEBOOK APP ID HERE";
      
      // (optional) Using Singular Global Properties feature to capture 
      // third party identifiers. The respective SDK(s) must be initialized
      // before the Singular SDK. Example of passing the CleverTapID.
      // var cleverTapId = CleverTapPlugin.getCleverTapID();
      // config.withGlobalProperty("CLEVERTAPID", cleverTapId, true);
              
      Singular.start(config);
  }

Gestión del consentimiento ATT (establecimiento de un retardo de inicialización)

Visualización de un aviso ATT (App Tracking Transparency)

A partir de iOS 14.5, las aplicaciones están obligadas a solicitar el consentimiento del usuario (mediante el marco App Tracking Transparency) antes de poder acceder y compartir algunos datos del usuario útiles para fines de seguimiento, incluido el IDFA del dispositivo.

Singular se beneficia enormemente de tener el IDFA para identificar dispositivos y realizar la atribución de instalaciones (aunque hay formas de realizar la atribución sin el IDFA). Le recomendamos encarecidamente que solicite el consentimiento del usuario para obtener el IDFA.

Retrasar la inicialización para esperar la respuesta de la ATT

Por defecto, Singular SDK envía una sesión de usuario cuando se inicializa. Cuando se envía una sesión desde un nuevo dispositivo, se activa inmediatamente el proceso de atribución de Singular, que se realiza basándose únicamente en los datos de que dispone Singular en ese momento. Por lo tanto, es esencial solicitar el consentimiento y recuperar el IDFA antes de que el SDK de Singular envíe la primera sesión.

Para retrasar el lanzamiento de una sesión de usuario, inicialice Singular SDK con la opción waitForTrackingAuthorizationWithTimeoutInterval en el objeto Config. Esta opción ya está incluida en el ejemplo de código anterior.

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.

• 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 del 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.

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.

Singular.setCustomUserId("custom_user_id");

Singular.unsetCustomUserId();

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 compatibilidad con Android, añada el siguiente código en el archivo MainActivity.java del proyecto:

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

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

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

override fun onNewIntent(intent: Intent) {
  super.onNewIntent(intent)
  SingularBridge.onNewIntent(intent);
}

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

// Top of 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];
}

import singular_flutter_sdk
  
override func application(_ application: UIApplication, 
  didFinishLaunchingWithOptions
  launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    GeneratedPluginRegistrant.register(with: self) if 
      let singularAppDelegate = SingularAppDelegate.shared() {
        singularAppDelegate.launchOptions = launchOptions
      }
  return super.application(application, didFinishLaunchingWithOptions:launchOptions)
}

override func application(_ application: UIApplication, 
  continue userActivity:NSUserActivity, 
  restorationHandler: @escaping ([UIUserActivityRestoring]?)-> Void) -> Bool {
    if let singularAppDelegate = SingularAppDelegate.shared() {
      singularAppDelegate.continueUserActivity(userActivity, restorationHandler:nil)
    }
  return super.application(application, continue:userActivity, 
    restorationHandler: restorationHandler);
}

override func application(_ app: UIApplication, 
  open url: URL, options:[UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    if let singularAppDelegate = SingularAppDelegate.shared() {
      singularAppDelegate.handleOpen(url, options: options)
    }
  return super.application(app, open: url, options: options);
}

Manejo de enlaces Singular

Utilice el mecanismo de manejo de Singular para leer los detalles del enlace de seguimiento que llevó 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;
  // Add your code here to handle the deep link
};
          
Singular.init(config);

Seguimiento de eventos (sin 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.

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 de 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);

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);

Seguimiento de eventos híbrido (avanzado)

Singular recomienda enviar todos los eventos e ingresos a través del SDK de Singular integrado en su aplicación. Sin embargo, Singular puede recopilar 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.

Guías de seguimiento de eventos híbridos

Añadir soporte de atribución de ingresos publicitarios

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 la gestió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 código siguiente:

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, proporcione 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 consintió (optó) en compartir su información.

Utilice Singular.limitDataSharing(true) si el usuario no dio su consentimiento.

Singular utiliza LimitDataSharing enlos "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.

// User has opted into sharing data
Singular.limitDataSharing(false);

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.

Singular.trackingOptIn();

Singular.stopAllTracking();

Singular.resumeAllTracking();

Singular.isAllTrackingStopped();