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

Seguir
Avatar
Jared Ornstead
Updated
Documento

SDK de Cordova - Referencia de métodos 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 método de configuración se presenta con una descripción, una firma y ejemplos prácticos de uso.

withClipboardAttribution

SingularConfig.withClipboardAttribution Método

Activa la atribución de portapapeles para el SDK. Cuando está activado, el SDK comprueba el portapapeles del dispositivo en busca de enlaces de atribución durante la inicialización.

Firma

withClipboardAttribution(): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withClipboardAttribution();

withConversionValueUpdatedHandler

Método withConversionValueUpdatedHandler de SingularConfig

Establece una función de devolución de llamada a la que se llamará cuando se actualice el valor de conversión de SKAdNetwork. Esto es específico de iOS y le permite reaccionar ante cambios en el valor de conversión.

Firma

withConversionValueUpdatedHandler(conversionValueUpdatedHandler: Function): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withConversionValueUpdatedHandler(function(conversionValue) {
          console.log("Conversion value updated to:", conversionValue);
     }
);

withConversionValuesUpdatedHandler

Método withConversionValuesUpdatedHandler de SingularConfig

Establece una función de devolución de llamada a la que se llamará cuando se actualicen los valores de conversión de SKAdNetwork 4.0. Esto es específico de iOS 16.1+ y permite reaccionar ante cambios en los valores finos, gruesos y de bloqueo.

Firma

withConversionValuesUpdatedHandler(conversionValuesUpdatedHandler: Function): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withConversionValuesUpdatedHandler(function(conversionValues) {
          console.log("Fine value:", conversionValues.fineValue);
          console.log("Coarse value:", conversionValues.coarseValue);
          console.log("Lock value:", conversionValues.lockValue);
     }
);

withCustomSdid

SingularConfig.withCustomSdid Método

Establece un SDID (identificador de dispositivo singular) personalizado y las llamadas de retorno asociadas. Esto le permite proporcionar su propio identificador de dispositivo en lugar de utilizar el generado por Singular.

Firma

withCustomSdid(customSdid: string, didSetSdidCallback: Function, sdidReceivedCallback: Function): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY", "SDK SECRET")
     .withCustomSdid("custom-device-id-12345",
     function(result) {
          console.log("SDID was set successfully:", result);
     },
     function(error) {
          console.error("Failed to set SDID:", error);
     }
);

withCustomUserId

SingularConfig.withCustomUserId Método

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

withCustomUserId(customUserId: string): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withCustomUserId("user-123456");

withDeviceAttributionCallbackHandler

Método SingularConfig.withDeviceAttributionCallbackHandler

Característica BETA: Establece una función de devolución de llamada que se llamará cuando los datos de atribución del dispositivo estén disponibles. Esto permite acceder a los datos de atribución en cuanto están disponibles.

Firma

withDeviceAttributionCallbackHandler(deviceAttributionCallbackHandler: Function): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
.withDeviceAttributionCallbackHandler(function(attributionData) {
     console.log("Attribution data:", attributionData);
     console.log("Campaign:", attributionData.campaign);
     console.log("Source:", attributionData.source);
});

withESPDomains

SingularConfig.withESPDomains Método

Establece los dominios ESP (proveedor de servicios de correo electrónico) para la atribución de correo electrónico. Esto le permite especificar qué dominios de correo electrónico deben tenerse en cuenta para la atribución.

Firma

withESPDomains(espDomains: string[]): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
.withESPDomains([
    "mailchimp.com",
    "sendgrid.net",
    "campaign-monitor.com"
]);

withFacebookAppId

Método withFacebookAppId de SingularConfig

Establece el ID de la aplicación de Facebook para la atribución de Facebook. Esto permite al SDK atribuir instalaciones y eventos de campañas de Facebook.

Firma

withFacebookAppId(facebookAppId: string): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withFacebookAppId("123456789012345");

withGlobalProperty

Método withGlobalProperty de SingularConfig

Establece una propiedad global durante la inicialización del SDK. Esta propiedad se enviará con todos los eventos rastreados por el SDK.

Firma

withGlobalProperty(key: string, value: string, overrideExisting: boolean): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withGlobalProperty("app_version", "1.2.3", true);

withLimitDataSharing

Método withLimitDataSharing de SingularConfig

Establece el estado de limitación del uso compartido de datos durante la inicialización del SDK. Utilice este método para limitar el uso compartido de datos en función del consentimiento del usuario o de requisitos de privacidad.

Firma

withLimitDataSharing(shouldLimitDataSharing: boolean): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withLimitDataSharing(true);

withLimitedIdentifiersEnabled

Método withLimitedIdentifiersEnabled de SingularConfig

Activa o desactiva el uso de identificadores limitados. Esta opción afecta al modo en que el SDK recopila y utiliza los identificadores de dispositivo para el seguimiento y la atribución.

Firma

withLimitedIdentifiersEnabled(limitedIdentifiersEnabled: boolean): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withLimitedIdentifiersEnabled(true);

withLogLevel

SingularConfig.withLogLevel Método

Establece el nivel de registro del SDK. De este modo, se controla el nivel de detalle de los registros generados por el SDK.

Firma

withLogLevel(level: string): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withLogLevel("verbose");

withLoggingEnabled

SingularConfig.withLoggingEnabled Método

Activa el registro detallado del SDK. Cuando está activado, el SDK genera registros detallados que pueden ayudar a depurar.

Firma

withLoggingEnabled(): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withLoggingEnabled();

withManualSkanConversionManagement

SingularConfig.withManualSkanConversionManagement Método

Activa la gestión manual de los valores de conversión de SKAdNetwork. Cuando se activa, el SDK no actualizará automáticamente los valores de conversión, permitiéndole controlarlos manualmente.

Firma

withManualSkanConversionManagement(): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withManualSkanConversionManagement();

withOAIDCollection

SingularConfig.withOAIDCollection Método

Habilita la recopilación de OAID (Open Anonymous Device Identifier) en dispositivos Android compatibles. Se trata de un identificador alternativo utilizado en algunas regiones, especialmente en China.

Firma

withOAIDCollection(): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withOAIDCollection();

withPushNotificationsLinkPaths

SingularConfig.withPushNotificationsLinkPaths Método

Establece las rutas para buscar enlaces profundos en las cargas útiles de las notificaciones push. Esto ayuda al SDK a encontrar y procesar enlaces de atribución en las notificaciones push.

Firma

withPushNotificationsLinkPaths(pushNotificationsLinkPaths: string[][]): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
.withPushNotificationsLinkPaths([
    ["data", "deeplink"],
    ["notification", "data", "url"],
    ["custom", "link"]
]);

withSessionTimeoutInSec

Método withSessionTimeoutInSec de SingularConfig

Establece el tiempo de espera de la sesión en segundos. Determina cuánto dura una sesión de usuario después de que la aplicación pasa a segundo plano.

Firma

withSessionTimeoutInSec(sessionTimeout: number): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withSessionTimeoutInSec(120); // 2 minutes

withShortLinkResolveTimeout

Método withShortLinkResolveTimeout de SingularConfig

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 antes de continuar con la inicialización.

Firma

withShortLinkResolveTimeout(shortLinkResolveTimeout: number): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withShortLinkResolveTimeout(15); // 130 seconds

withSingularLink

Método withSingularLink de SingularConfig

Establece una función de devolución de llamada para gestionar los enlaces profundos procesados por Singular. Esto permite que su aplicación responda a los enlaces profundos utilizados en la atribución.

Firma

withSingularLink(singularLinkHandler: Function): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
.withSingularLink(function(data) {
    var deeplink = data.deeplink;
    var passthrough = data.passthrough;
    var isDeferred = data.isDeferred;
    
    console.log("Deep link received:", deeplink);
    
    if (deeplink) {
        // Handle the deep link, e.g., navigate to a specific screen
        navigateToScreen(deeplink);
    }
});

withSkAdNetworkEnabled

SingularConfig.withSkAdNetworkEnabled Método

Activa o desactiva la compatibilidad con SKAdNetwork. Esto es específico de iOS y controla si el SDK utilizará SKAdNetwork de Apple para la atribución.

Firma

withSkAdNetworkEnabled(skAdNetworkEnabled: boolean): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withSkAdNetworkEnabled(true);

withWaitForTrackingAuthorizationWithTimeoutInterval

SingularConfig.withWaitForTrackingAuthorizationWithTimeoutInterval Método

Establece el intervalo de tiempo de espera en segundos para la respuesta de autorización de seguimiento del usuario en iOS 14+. Esto determina cuánto tiempo esperará el SDK a la respuesta de solicitud de ATT antes de continuar con la inicialización.

Firma

withWaitForTrackingAuthorizationWithTimeoutInterval(waitForTrackingAuthorizationWithTimeoutInterval: number): SingularConfig

Ejemplo de uso

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withWaitForTrackingAuthorizationWithTimeoutInterval(30); // 30 seconds

Ejemplo de configuración completa

Encadenamiento de varias opciones de configuración

El siguiente ejemplo muestra cómo crear una configuración completa encadenando varios métodos de configuración.

Ejemplo completo

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withWaitForTrackingAuthorizationWithTimeoutInterval(30)    
     .withCustomUserId("user-123456")
     .withGlobalProperty("key_1", "value1", true)     
     .withLimitDataSharing(false)
     .withFacebookAppId("123456789012345"); 
     .withSingularLink(function(data) {
          var deeplink = data.deeplink;
          var passthrough = data.passthrough;
          var isDeferred = data.isDeferred;
          console.log("Deep link received:", deeplink);

          if (deeplink) {
               // Handle the deep link
               navigateToScreen(deeplink);
          }
     })
    
// Initialize the SDK
cordova.plugins.SingularCordovaSdk.init(singularConfig);