SDK de Cordova - Referencia de métodos de configuración

Seguir
Avatar
Jared Ornstead
Updated
Documento

SDK de Cordova - Referencia de configuración

Este documento proporciona una referencia completa de todas las opciones de configuración disponibles en el SDK de Singular para aplicaciones Cordova. El objeto SingularConfig permite personalizar el comportamiento del SDK, incluidos los ajustes de seguimiento, las opciones de atribución, los controles de privacidad y mucho más. Cada propiedad de configuración se presenta con una descripción, una firma y ejemplos prácticos de uso.

apikey

Propiedad SingularConfig.apikey

Su clave de API de Singular. Se trata de una propiedad obligatoria que debe establecerse durante la inicialización de la configuración.

Firma

apikey: string

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('YOUR_API_KEY', 'YOUR_SECRET');

brandedDomains

Propiedad SingularConfig.brandedDomains

Establece los dominios de marca para la atribución web-to-app. Permite especificar dominios personalizados que deben rastrearse a efectos de atribución.

Firma

brandedDomains: Array<string>

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET');
config.withBrandedDomains(['yourcompany.com', 'go.yourcompany.com']);

clipboardAttribution

Propiedad SingularConfig.clipboardAttribution

Activa la atribución de portapapeles para iOS. Cuando está activada, el SDK comprueba si hay datos de atribución en el portapapeles.

Firma

clipboardAttribution: boolean

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withClipboardAttribution();

collectOAID

Propiedad collectOAID de SingularConfig

Habilita la recopilación de OAID (Open Anonymous Device Identifier) para Android. Esto se utiliza principalmente para el seguimiento en China, donde Google Play Services no está disponible. El valor predeterminado es false.

Firma

collectOAID: boolean

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withOAIDCollection();

conversionValueUpdatedHandler

Propiedad conversionValueUpdatedHandler de SingularConfig

Establece un controlador de devolución de llamada que se invoca cuando se actualiza el valor de conversión de SKAdNetwork. Esto es útil para realizar un seguimiento de los cambios del valor de conversión en iOS.

Firma

conversionValueUpdatedHandler: Function

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withConversionValueUpdatedHandler(function(conversionValue) {
    console.log('Conversion value updated:', conversionValue);
  });

conversionValuesUpdatedHandler

Propiedad conversionValuesUpdatedHandler de SingularConfig

Establece un controlador de devolución de llamada que se invoca cuando se actualizan los valores de conversión de SKAdNetwork 4.0. Esta devolución de llamada recibe el valor fino, el valor grueso y el estado de bloqueo para iOS 16.1+.

Firma

conversionValuesUpdatedHandler: Function

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withConversionValuesUpdatedHandler(function(values) {
    console.log('Conversion values updated:', values);
  });

customSdid

Función para empresas: póngase en contacto con su gestor de éxito de clientes para activar esta función para su cuenta.

Propiedad singularConfig.customSdid

Establece un SDID (identificador de dispositivo de Singular) personalizado. Esto le permite proporcionar su propio identificador de dispositivo en lugar de utilizar el generado por Singular.

Firma

customSdid: string

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withCustomSdid(
    'custom-device-id-12345',
    function(sdid) {
      console.log('SDID was set:', sdid);
    },
    function(sdid) {
      console.log('SDID received:', sdid);
    }
  );

customUserId

Propiedad SingularConfig.customUserId

Establece un identificador de usuario personalizado durante la inicialización del SDK. Esto le permite asociar los datos de Singular con su propio sistema de identificación de usuarios desde el principio.

Firma

customUserId: string

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withCustomUserId('user123456');

deviceAttributionCallbackHandler

Característica BETA: establece una función de devolución de llamada a la que se llamará cuando estén disponibles los datos de atribución del dispositivo.

Propiedad deviceAttributionCallbackHandler de SingularConfig

Establece una función de devolución de llamada que se invoca cuando están disponibles los datos de atribución del dispositivo. Esto permite acceder a los datos de atribución en cuanto se resuelven.

Firma

deviceAttributionCallbackHandler: Function

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withDeviceAttributionCallbackHandler(function(attributes) {
    console.log('Attribution data received:', attributes);
    var campaign = attributes.campaign;
    var source = attributes.source;
  });

didSetSdidCallback

Función de empresa - Callback que se invoca cuando se establece un SDID personalizado.

Propiedad didSetSdidCallback de SingularConfig

Establece una función de devolución de llamada que se invocará cuando se establezca el SDID personalizado. Se utiliza junto con la propiedad customSdid.

Firma

didSetSdidCallback: Function

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withCustomSdid(
    'custom-device-id',
    function(result) {
      console.log('SDID was set:', result);
    },
    function(result) {
      console.log('SDID received:', result);
    }
  );

enableLogging

Propiedad enableLogging de SingularConfig

Habilita el registro del SDK con fines de depuración. Esto es útil durante el desarrollo y la resolución de problemas. Se recomienda desactivar el registro en las compilaciones de producción. El valor por defecto es false.

Firma

enableLogging: boolean

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withLoggingEnabled();

enableOdmWithTimeoutInterval

Propiedad enableOdmWithTimeoutInterval de SingularConfig

Habilita la medición en el dispositivo con un intervalo de tiempo de espera especificado. Esta función permite realizar mediciones centradas en la privacidad. El valor predeterminado es -1 (desactivado).

Firma

enableOdmWithTimeoutInterval: number

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withEnableOdmWithTimeoutInterval(30);

espDomains

Propiedad espDomains de SingularConfig

Establece los dominios ESP (proveedor de servicios de correo electrónico) para la atribución basada en correo electrónico. Esto permite realizar un seguimiento de la atribución de las campañas de correo electrónico.

Firma

espDomains: Array<string>

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withESPDomains(['email.example.com', 'mail.company.com']);

facebookAppId

Propiedad SingularConfig.facebookAppId

Establece el ID de la aplicación de Facebook para la integración de la atribución de Facebook. Esto permite una integración profunda con el sistema de atribución de Facebook.

Firma

facebookAppId: string

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withFacebookAppId('1234567890123456');

globalProperties

Propiedad SingularConfig.globalProperties

Establece propiedades globales durante la inicialización que se enviarán con todos los eventos posteriores. Esto es útil para realizar un seguimiento de los atributos persistentes del usuario o del estado de la aplicación.

Firma

globalProperties: Object

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withGlobalProperty('user_tier', 'premium', true)
  .withGlobalProperty('region', 'north_america', true);

limitAdvertisingIdentifiers

Propiedad limitAdvertisingIdentifiers de SingularConfig

Controla si se deben limitar los identificadores publicitarios (IDFA/GAID). Utilícela para cumplir con las preferencias y normativas de privacidad. El valor predeterminado es false.

Firma

limitAdvertisingIdentifiers: boolean

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withLimitAdvertisingIdentifiers(true);

limitDataSharing

Propiedad limitDataSharing de SingularConfig

Establece el estado de limitación de compartición de datos durante la inicialización. Utilícela para cumplir la normativa sobre privacidad limitando los datos que se comparten con terceros. El valor predeterminado es null.

Firma

limitDataSharing: boolean

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withLimitDataSharing(true);

logLevel

Propiedad SingularConfig.logLevel

Establece el nivel de registro del SDK para un control más detallado de la salida de registro. Permite especificar la verbosidad de los registros del SDK.

Firma

logLevel: number

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withLogLevel(3); // Set appropriate log level

manualSkanConversionManagement

Propiedad manualSkanConversionManagement de SingularConfig

Activa la gestión manual de valores de conversión de SKAdNetwork. Cuando está activada, debe actualizar manualmente los valores de conversión en lugar de confiar en las actualizaciones automáticas. El valor por defecto es false.

Firma

manualSkanConversionManagement: boolean

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withManualSkanConversionManagement();

pushNotificationsLinkPaths

Propiedad pushNotificationsLinkPaths de SingularConfig

Configura rutas personalizadas para extraer enlaces profundos de las cargas útiles de notificaciones push. Permite especificar en qué parte de la carga útil de la notificación se encuentra el enlace profundo.

Firma

pushNotificationsLinkPaths: Array<Array<string>>

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withPushNotificationsLinkPaths([
    ['data', 'deeplink'],
    ['notification', 'data', 'url'],
    ['custom', 'link']
  ]);

sdidReceivedCallback

Función de empresa - Callback que se invoca cuando se recibe el SDID.

Propiedad SingularConfig.sdidReceivedCallback

Establece una función callback que se invocará cuando se reciba el SDID del servidor. Se utiliza junto con la propiedad customSdid.

Firma

sdidReceivedCallback: Function

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withCustomSdid(
    'custom-device-id',
    function(result) { console.log('SDID set:', result); },
    function(result) { console.log('SDID received:', result); }
  );

secreto

Propiedad SingularConfig.secret

Su secreto de Singular SDK. Se trata de una propiedad obligatoria que debe establecerse durante la inicialización de la configuración.

Firma

secret: string

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('YOUR_API_KEY', 'YOUR_SECRET');

sessionTimeout

Propiedad SingularConfig.sessionTimeout

Establece el tiempo de espera de la sesión en segundos. Determina cuánto tiempo dura una sesión de usuario después de que la aplicación pase a segundo plano. El valor por defecto es -1 (utiliza un tiempo de espera por defecto de 60 segundos).

Firma

sessionTimeout: number

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withSessionTimeoutInSec(120); // 2 minutes

shortLinkResolveTimeout

Propiedad SingularConfig.shortLinkResolveTimeout

Establece el tiempo de espera en segundos para la resolución de enlaces cortos. Determina cuánto tiempo esperará el SDK a que se resuelva un enlace corto. El valor predeterminado es 10 segundos.

Firma

shortLinkResolveTimeout: number

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withShortLinkResolveTimeout(15);

singularLinkHandler

Propiedad SingularConfig.singularLinkHandler

Establece un manejador de callback para Singular Links (enlaces profundos). Esta llamada de retorno se invoca cuando la aplicación se abre a través de un Singular Link, lo que permite gestionar la lógica de los enlaces profundos.

Firma

singularLinkHandler: Function

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withSingularLink(function(singularLinkParams) {
    console.log('Deep link opened:', singularLinkParams);
    var deeplink = singularLinkParams.deeplink;
    var passthrough = singularLinkParams.passthrough;
    // Handle navigation based on deep link data
  });

skAdNetworkEnabled

Propiedad SingularConfig.skAdNetworkEnabled

Activa o desactiva la compatibilidad de SKAdNetwork con iOS. Si está activada, el SDK gestionará automáticamente la atribución de SKAdNetwork. El valor por defecto es true.

Firma

skAdNetworkEnabled: boolean

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withSkAdNetworkEnabled(true);

waitForTrackingAuthorizationWithTimeoutInterval

Propiedad singularConfig.waitForTrackingAuthorizationWithTimeoutInterval

Establece el intervalo de tiempo de espera para la autorización ATT (App Tracking Transparency) de iOS antes de inicializar el SDK. Esto es útil para iOS 14+ para garantizar que el permiso de seguimiento se solicita antes de la inicialización del SDK. El valor predeterminado es 0 (sin espera).

Firma

waitForTrackingAuthorizationWithTimeoutInterval: number

Ejemplo de uso

JavaScript 
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

var config = new SingularConfig('API_KEY', 'SECRET')
  .withWaitForTrackingAuthorizationWithTimeoutInterval(60); // Wait up to 60 seconds

Ejemplo de configuración completa

Aquí hay un ejemplo completo que muestra cómo configurar el SDK Singular con múltiples opciones:

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

// Create configuration with API key and secret
var config = new SingularConfig('YOUR_API_KEY', 'YOUR_SECRET')
  .withCustomUserId('user123456')
  .withSessionTimeoutInSec(120)
  .withLoggingEnabled()
  .withSingularLink(function(params) {
    console.log('Deep link:', params.deeplink);
  })
  .withConversionValueUpdatedHandler(function(value) {
    console.log('Conversion value:', value);
  })
  .withGlobalProperty('user_tier', 'premium', true)
  .withGlobalProperty('app_version', '2.1.0', true)
  .withShortLinkResolveTimeout(15);

// Initialize the SDK
Singular.init(config);