Singular SDK está disponible como complemento para Segment, denominado Destino " Device-Mode". Las instrucciones siguientes ilustran cómo añadir el Destino Singular en Segment.
Guía para | Equipos de ingeniería |
Requisitos previos | Este artículo asume que ya tienes el SDK de Segment iOS o Android Analytics integrado en tu aplicación. |
Para usar esta integración, debes estar usando el SDK de Mobile Analytics de Segment para: iOS (Native Obj-C o Swift), Android (Java o Kotlin) ¡Esta integración NO es compatible con ningún otro framework, incluyendo Unity, Factual Engine, React Native, o Xamarin, etc!
- Instalación Básica Atribución
- Soporte SkAdNetwork 3 (SKAN 3.0)
- Atribución de anuncios de búsqueda de Apple
- Seguimiento personalizado de eventos en la aplicación
- Seguimiento de ingresos
- ID de usuario personalizado
- Soporte SkAdNetwork 4 (SKAN 4.0)
- Instalación de META Atribución de referencia
- Enlaces profundos
- Soporte limitado para compartir datos
Si necesita soporte para otros Frameworks o desea la "Funcionalidad Completa" ofrecida por Singular SDK, debe implementar Singular SDK independientemente de Segment. Consulte las opciones de SDK y Frameworks AQUÍ.
Cómo empezar
- En la aplicación web de Segment, haga clic en "Catálogo" en el menú "Conexiones".
- Busque "Singular" en el catálogo, selecciónelo y haga clic en el botón "Añadir destino".
- Seleccione las fuentes a las que desea conectar el destino y haga clic en "Siguiente".
- Asigne un nombre al destino y haga clic en "Crear destino".
- Obtenga su "SDK KEY" de Singular, que encontrará en el panel de control de Singular, en "Developer Tools > SDK Integration > SDK Keys", y añádala al segmento "Connection Settings", en "API Key" y "Secret".
Importante: Asegúrese de utilizar la clave SDK de Singular para el valor de la clave API en Segment. Si utiliza una clave incorrecta, Singular no recibirá ningún dato.
Configuración adicional
Para utilizar las funciones nativas de esta integración, deberá incluir la biblioteca de Singular añadiendo estas líneas a la configuración de dependencias:
- Añada AdServices. framework en Vincular binario con bibliotecas y márquelo como Opcional (sólo disponible para dispositivos con iOS 14.3 y superior). Esto es necesario para admitir la atribución de anuncios de búsqueda de Apple.
- Añada el pod de integración de Singular Segment al podfile de su aplicación de la siguiente manera:
pod 'Segment-Singular'
- Importe Singular Library en su archivo:
#import <Segment-Singular/SEGSingularIntegrationFactory.h>
- Por último, registre el Singular con el Segment SDK
SEGAnalyticsConfiguration *configuration = [SEGAnalyticsConfiguration configurationWithWriteKey:@”<SEGMENT_WRITE_KEY>”]; // Enable this to record certain application events automatically!
configuration.trackApplicationLifecycleEvents = YES;
// Enable this to record screen views automatically!
configuration.recordScreenViews = YES;
// Add any of your Device-mode destinations.
configuration use:[SingularIntegrationFactory instance]];
[SEGAnalytics setupWithConfiguration:configuration];let configuration = AnalyticsConfiguration(writeKey: "<SEGMENT_WRITE_KEY>")
// Enable this to record certain application events automatically!
configuration.trackApplicationLifecycleEvents = true
// Enable this to record screen views automatically!
configuration.recordScreenViews = true
// Add any of your Device-mode destinations. configuration.use(SingularIntegrationFactory.instance())
Analytics.setup(with: configuration) - [ OPCIONAL] Implementar soporte SKAN
El SDK de Singular puede controlar tu integración con SKAdnetwork. Para más detalles sobre cómo funciona, consulta iOS SDK: Añadir soporte SKAdNetwork.
Para que Singular controle su integración SKAdNetwork, añada el siguiente código antes de la inicialización del SDK de Segment:
[SingularIntegation setSKANOptions:YES isManualSkanConversionManagementMode: NO withWaitForTrackingAuthorizationWithTimeoutInterval:@0 withConversionValueUpdatedHandler:^(NSInteger conversionValue) { NSLog(@"Your SKAN handler %ld",conversionValue); }];
SingularIntegation.setSKANOptions(
true,
isManualSkanConversionManagementMode: false,
withWaitForTrackingAuthorizationWithTimeoutInterval: NSNumber(value: 0), withConversionValueUpdatedHandler: { conversionValue in print(String(format: "Your SKAN handler %ld", conversionValue)) })
Segment Analytics para Android
- Añade la dependencia de integración de Singular Segment al archivo build.gradle de tu aplicación:
compile 'net.singular.segment.integration:singular_segment_sdk:+'
- Añada los permisos requeridos al archivo AndroidManifest.xml. Incluya los siguientes permisos:
<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" />
- Después de añadir la dependencia, debe importar la integración
import net.singular.segment.integration.SingularIntegration;
- Por último, añada código para inicializar el SDK de Singular
Añade .trackApplicationLifecycleEvents() para enviar a Singular los eventos de aplicación abierta, aplicación actualizada y aplicación instalada.
static final String SEGMENT_WRITE_KEY = "<YOUR_KEY>"; @Override protected void onCreate(Bundle savedInstanceState) {
Analytics analytics = new Analytics.Builder(this , SEGMENT_WRITE_KEY) .use(SingularIntegration.FACTORY .logLevel(Analytics.LogLevel.VERBOSE) .recordScreenViews() .trackApplicationLifecycleEvents() .build(); Analytics.setSingletonInstance(analytics); }
Instalar atribución
Habilite el seguimiento automático de los eventos del ciclo de vida (aplicación abierta, aplicación instalada, aplicación actualizada) mediante los parámetros de configuración de inicialización(iOS, Android) para realizar un seguimiento de las instalaciones y las sesiones en Singular. La "sesión" de Singular será enviada automáticamente por la integración siempre que incluya los eventos anteriores.
Seguimiento de eventos personalizados
Si no está familiarizado con las especificaciones de Segment, eche un vistazo para entender lo que hace el método Track.
Utilice la función de seguimiento de Segmento para que los eventos se traduzcan y se envíen a Singular:
[[SEGAnalytics sharedAnalytics] track:@"simple event"];
Analytics.with(this).track("event_name");
Segment incluye todas las propiedades del evento como parámetros de devolución de llamada en el evento Singular.
Los eventos estarán disponibles en informes y exportaciones a nivel de usuario.
Seguimiento de ingresos
Singular recibirá el seguimiento de ingresos cuando se envíe un evento que contenga la propiedad de ingresos (incluido el valor cero). Puede pasar opcionalmente la moneda (como un código de moneda ISO 4217 ). La moneda por defecto es USD.
[[SEGAnalytics sharedAnalytics] track:@"segment revenue event" properties:@{@"currency": @"USD", @"revenue":@20}];
Analytics.with(this).track("purchase", new Properties().putRevenue(2.5).putValue("currency","USD"));
Nota: Pase la divisa como un código de divisa ISO 4217 de tres letras, por ejemplo, "USD", "EUR", "INR".
ID de usuario personalizado
Puede enviar su ID de usuario de segmento a Singular utilizando el método Segment identify.
Nota: Si utiliza la solución Cross-Device de Singular, debe recopilar el mismo 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, una vez establecido, persistirá hasta que se desactive mediante el método de restablecimiento de segmento o hasta que se desinstale la aplicación. Cerrar o reiniciar la aplicación no anula el ID de usuario.
Siga estos pasos para configurar para: iOS, Android.
[[SEGAnalytics sharedAnalytics] identify:@"segment custom user id"];
Analytics.with(context).identify("myUserId");
Para desactivar el ID de usuario personalizado, llame al método de restablecimiento.
[[SEGAnalytics sharedAnalytics] reset];