React Native SDK - Referência de métodos de configuração

Seguir
Avatar
Jared Ornstead
Updated
Documento de referência

Referência de métodos de configuração do SDK do React Native

Esta referência documenta os métodos de configuração disponíveis na classe SingularConfig. Esses métodos usam um padrão builder para criar um objeto de configuração para inicializar o Singular SDK. Cada método retorna o próprio objeto SingularConfig, permitindo o encadeamento de métodos.

withClipboardAttribution

SingularConfig.withClipboardAttribution Method

Habilita a atribuição baseada na área de transferência para melhorar o rastreamento quando o deep linking não está disponível.

Assinatura

withClipboardAttribution(): SingularConfig

Exemplo de uso

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

withConversionValueUpdatedHandler

SingularConfig.withConversionValueUpdatedHandler Method

Define uma função de handler a ser chamada quando o valor de conversão SKAdNetwork é atualizado (apenas iOS 14+).

Assinatura

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

Exemplo de utilização

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

Define uma função de tratamento a ser chamada quando os valores de conversão SKAdNetwork 4.0 são actualizados (apenas iOS 16.1+).

Assinatura

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

Exemplo de utilização

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

Funcionalidade empresarial: Define um SDID (Singular Device ID) personalizado com manipuladores de retorno de chamada para quando o ID é definido e recebido.

Assinatura

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

Exemplo de utilização

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

Define um identificador de utilizador personalizado para a sessão de utilizador atual.

Assinatura

withCustomUserId(customUserId: string): SingularConfig

Exemplo de utilização

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

withDeviceAttributionCallbackHandler

SingularConfig.withDeviceAttributionCallbackHandler Method

Funcionalidade BETA: Define uma função de tratamento para receber dados de atribuição de dispositivos quando estes estiverem disponíveis.

Assinatura

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

Exemplo de utilização

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

Define uma lista de domínios ESP (Fornecedor de Serviços de Correio Eletrónico) para atribuição de correio eletrónico.

Assinatura

withEspDomains(domains: [string]): SingularConfig

Exemplo de uso

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

withFacebookAppId

SingularConfig.withFacebookAppId Method

Define a ID de aplicativo do Facebook para atribuição aprimorada com campanhas do Facebook.

Assinatura

withFacebookAppId(appId: string): SingularConfig

Exemplo de uso

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

withGlobalProperty

SingularConfig.withGlobalProperty Method

Define uma propriedade global que será incluída em todos os eventos enviados para o Singular.

Assinatura

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

Exemplo 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 as limitações de compartilhamento de dados para conformidade com a privacidade (por exemplo, CCPA).

Assinatura

withLimitDataSharing(shouldLimitDataSharing: boolean): SingularConfig

Exemplo de uso

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

withLimitedIdentifiersEnabled

SingularConfig.withLimitedIdentifiersEnabled Method

Ativa ou desactiva a utilização de identificadores limitados para atribuição centrada na privacidade.

Assinatura

withLimitedIdentifiersEnabled(limitedIdentifiersEnabled: boolean): SingularConfig

Exemplo de utilização

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

withLogLevel

SingularConfig.withLogLevel Method

Define o nível de registo para o SDK Singular.

Assinatura

withLogLevel(level: number): SingularConfig

Exemplo de uso

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

withLoggingEnabled

SingularConfig.withLoggingEnabled Method

Ativa o registo detalhado para fins de depuração.

Assinatura

withLoggingEnabled(): SingularConfig

Exemplo de utilização

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

withManualSkanConversionManagement

SingularConfig.withManualSkanConversionManagement Method

Permite a gestão manual das conversões de SKAdNetwork (apenas iOS).

Assinatura

withManualSkanConversionManagement(): SingularConfig

Exemplo de utilização

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

withOAIDCollection

SingularConfig.withOAIDCollection Method

Permite a recolha de OAID para atribuição em dispositivos Android chineses.

Assinatura

withOAIDCollection(): SingularConfig

Exemplo de uso

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

withPushNotificationsLinkPaths

SingularConfig.withPushNotificationsLinkPaths Method

Configura os caminhos em cargas de notificação push onde os links Singular podem ser encontrados.

Assinatura

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

Exemplo de uso

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

withSessionTimeoutInSec

SingularConfig.withSessionTimeoutInSec Method

Define a duração do tempo limite da sessão em segundos.

Assinatura

withSessionTimeoutInSec(sessionTimeout: number): SingularConfig

Exemplo de uso

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

withShortLinkResolveTimeout

SingularConfig.withShortLinkResolveTimeout Method

Define o tempo limite em segundos para a resolução de ligações curtas.

Assinatura

withShortLinkResolveTimeout(shortLinkResolveTimeout: number): SingularConfig

Exemplo de uso

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

withSingularLink

SingularConfig.withSingularLink Method

Configura um manipulador para processar links profundos Singular quando os usuários abrem o aplicativo por meio de um link de rastreamento.

Assinatura

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

Exemplo de utilização

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

Ativa ou desativa o suporte de SKAdNetwork para atribuição de iOS 14+.

Assinatura

withSkAdNetworkEnabled(enabled: boolean): SingularConfig

Exemplo de uso

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

withWaitForTrackingAuthorizationWithTimeoutInterval

SingularConfig.withWaitForTrackingAuthorizationWithTimeoutInterval Method

Define um intervalo de tempo limite (em segundos) para aguardar a resposta de autorização de rastreio do utilizador (apenas iOS 14+).

Assinatura

withWaitForTrackingAuthorizationWithTimeoutInterval(interval: number): SingularConfig

Exemplo de uso

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

Complete Configuration Example

Chaining Multiple Configuration Methods

Exemplo que mostra como encadear vários métodos de configuração.

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