React Native SDK - Referencia de métodos de configuración

Seguir
Avatar
Jared Ornstead
Updated
Documento

Referencia de los métodos de configuración del SDK de React Native

Esta referencia documenta los métodos de configuración disponibles en la clase SingularConfig. Estos métodos utilizan un patrón constructor para crear un objeto de configuración para inicializar el SDK Singular. Cada método devuelve el propio objeto SingularConfig, lo que permite encadenar métodos.

withClipboardAttribution

SingularConfig.withClipboardAttribution Method

Habilita la atribución basada en el portapapeles para mejorar el seguimiento cuando no está disponible la vinculación profunda.

Firma

withClipboardAttribution(): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withClipboardAttribution();

withConversionValueUpdatedHandler

SingularConfig.withConversionValueUpdatedHandler Method

Establece una función manejadora que se llamará cuando se actualice el valor de conversión SKAdNetwork (sólo iOS 14+).

Firma

withConversionValueUpdatedHandler(handler: (value: number) => void): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withConversionValueUpdatedHandler((value) => { 
        console.log("Conversion value updated to:", value); 
        // Perform actions based on the new conversion value 
});

withConversionValuesUpdatedHandler

SingularConfig.withConversionValuesUpdatedHandler Method

Establece una función de control que se llamará cuando se actualicen los valores de conversión de SKAdNetwork 4.0 (sólo iOS 16.1+).

Firma

withConversionValuesUpdatedHandler(handler: (fineValue: number, coarseValue: number, lockWindow: boolean) => void): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withConversionValuesUpdatedHandler((fineValue, coarseValue, lockWindow) => { 
        console.log("Fine value:", fineValue); 
        console.log("Coarse value:", coarseValue); 
        console.log("Lock window:", lockWindow); 
        // Handle updated conversion values 
});

withCustomSdid

SingularConfig.withCustomSdid Method

Función de empresa: Establece un SDID (Singular Device ID) personalizado con controladores de devolución de llamada para cuando se establezca y reciba el ID.

Firma

withCustomSdid(customSdid: string, didSetSdidCallback: (result: string) => void, sdidReceivedCallback: (result: string) => void): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withCustomSdid(
        "custom-device-id-12345", 
        (result) => { console.log("SDID set result:", result); }, 
        (result) => { console.log("SDID received:", result); });

withCustomUserId

SingularConfig.withCustomUserId Method

Establece un identificador de usuario personalizado para la sesión de usuario actual.

Firma

withCustomUserId(customUserId: string): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withCustomUserId("user_123456");

withDeviceAttributionCallbackHandler

SingularConfig.withDeviceAttributionCallbackHandler Method

Función BETA: Establece una función de controlador para recibir datos de atribución de dispositivos cuando estén disponibles.

Firma

withDeviceAttributionCallbackHandler(deviceAttributionCallbackHandler: (attributes: Map<string, any>) => void): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withDeviceAttributionCallbackHandler((attributes) => {
        // Process attribution data 
        console.log("Attributes:", JSON.stringify(Object.fromEntries(attributes)));
        
        // Use attribution data to customize user experience
        if (attributes.get("source") === "facebook") {
          // Show Facebook-specific welcome message
        }
});

withEspDomains

SingularConfig.withEspDomains Method

Establece una lista de dominios ESP (proveedor de servicios de correo electrónico) para la atribución de correo electrónico.

Firma

withEspDomains(domains: [string]): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withEspDomains([ "mailchimp.com", "sendgrid.net", "klaviyo.com" ]);

withFacebookAppId

SingularConfig.withFacebookAppId Method

Establece el ID de la aplicación de Facebook para mejorar la atribución con las campañas de Facebook.

Firma

withFacebookAppId(appId: string): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withFacebookAppId("123456789012345");

withGlobalProperty

SingularConfig.withGlobalProperty Method

Establece una propiedad global que se incluirá en todos los eventos enviados a Singular.

Firma

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

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withGlobalProperty("app_version", "1.2.3", true)
     .withGlobalProperty("user_tier", "premium", false);

withLimitDataSharing

SingularConfig.withLimitDataSharing Method

Configura las limitaciones de uso compartido de datos para el cumplimiento de la privacidad (por ejemplo, CCPA).

Firma

withLimitDataSharing(shouldLimitDataSharing: boolean): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withLimitDataSharing(true);

withLimitedIdentifiersEnabled

SingularConfig.withLimitedIdentifiersEnabled Method

Activa o desactiva el uso de identificadores limitados para la atribución centrada en la privacidad.

Firma

withLimitedIdentifiersEnabled(limitedIdentifiersEnabled: boolean): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withLimitedIdentifiersEnabled(true);

withLogLevel

SingularConfig.withLogLevel Method

Establece el nivel de registro para Singular SDK.

Firma

withLogLevel(level: number): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withLogLevel(3);

withLoggingEnabled

SingularConfig.withLoggingEnabled Method

Activa el registro detallado con fines de depuración.

Firma

withLoggingEnabled(): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withLoggingEnabled();

withManualSkanConversionManagement

SingularConfig.withManualSkanConversionManagement Method

Permite la gestión manual de las conversiones de SKAdNetwork (sólo iOS).

Firma

withManualSkanConversionManagement(): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withManualSkanConversionManagement();

withOAIDCollection

SingularConfig.withOAIDCollection Method

Permite la recopilación de OAID para la atribución en dispositivos Android chinos.

Firma

withOAIDCollection(): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withOAIDCollection();

withPushNotificationsLinkPaths

SingularConfig.withPushNotificationsLinkPaths Method

Configura las rutas en las cargas útiles de notificaciones push en las que se pueden encontrar enlaces Singular.

Firma

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

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withPushNotificationsLinkPaths([ 
        ["data", "singular_link"], 
        ["custom", "tracking_url"] 
        ]);

withSessionTimeoutInSec

SingularConfig.withSessionTimeoutInSec Method

Establece la duración del tiempo de espera de la sesión en segundos.

Firma

withSessionTimeoutInSec(sessionTimeout: number): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withSessionTimeoutInSec(60);

withShortLinkResolveTimeout

SingularConfig.withShortLinkResolveTimeout Method

Establece el tiempo de espera en segundos para resolver enlaces cortos.

Firma

withShortLinkResolveTimeout(shortLinkResolveTimeout: number): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withShortLinkResolveTimeout(10);

withSingularLink

SingularConfig.withSingularLink Method

Configura un controlador para procesar enlaces profundos Singular cuando los usuarios abren la aplicación a través de un enlace de seguimiento.

Firma

withSingularLink(handler: (params: SingularLinkParams) => void): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withSingularLink(singularLinkParams => { 
          const deeplink = singularLinkParams.deeplink; 
          const passthrough = singularLinkParams.passthrough; 
          const isDeferred = singularLinkParams.isDeferred;

          // Add your deep link handling logic here
          if (deeplink && deeplink.includes('product')) {
               // Navigate to product page
               console.log("Navigating to product from deeplink:", deeplink);
          }

          // Use passthrough data if available
          if (passthrough) {
               console.log("Passthrough data:", passthrough);
          }

          // Check if this was a deferred deep link
          if (isDeferred) {
               console.log("This was a deferred deep link");
          }
});

withSkAdNetworkEnabled

SingularConfig.withSkAdNetworkEnabled Method

Activa o desactiva la compatibilidad de SKAdNetwork con la atribución de iOS 14+.

Firma

withSkAdNetworkEnabled(enabled: boolean): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withSkAdNetworkEnabled(true);

withWaitForTrackingAuthorizationWithTimeoutInterval

SingularConfig.withWaitForTrackingAuthorizationWithTimeoutInterval Method

Establece un intervalo de tiempo de espera (en segundos) para esperar la respuesta de autorización de seguimiento del usuario (solo iOS 14+).

Firma

withWaitForTrackingAuthorizationWithTimeoutInterval(interval: number): SingularConfig

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withWaitForTrackingAuthorizationWithTimeoutInterval(30);

Complete Configuration Example

Chaining Multiple Configuration Methods

Ejemplo que muestra cómo encadenar varios métodos de configuración.

Ejemplo de uso

typescript
const config = new SingularConfig("SDK KEY", "SDK SECRET")
     .withWaitForTrackingAuthorizationWithTimeoutInterval(30)
     .withCustomUserId("user_123456")
     .withGlobalProperty("key_1", "value1", true)
     .withLimitDataSharing(false)
     .withFacebookAppId("123456789012345");
     .withSingularLink((params) = {
        // Handle deep link parameters 
        if (params.deeplink) { 
             console.log("Deep link received:", params.deeplink); 
        } 
     })

// Initialize Singular with the configuration
Singular.init(config);