SDK do Cordova - Referência dos métodos de configuração

Seguir
Avatar
Jared Ornstead
Updated
Documento

SDK Cordova - Referência de Métodos de Configuração

Este documento fornece uma referência abrangente para todas as opções de configuração disponíveis no SDK Singular para aplicativos Cordova. O objeto SingularConfig permite-lhe personalizar o comportamento do SDK, incluindo definições de rastreio, opções de atribuição, controlos de privacidade e muito mais. Cada método de configuração é apresentado com uma descrição, assinatura e exemplos práticos de uso.

withClipboardAttribution

Método SingularConfig.withClipboardAttribution

Habilita a atribuição da área de transferência para o SDK. Quando ativado, o SDK verificará a área de transferência do dispositivo em busca de links de atribuição durante a inicialização.

Assinatura

withClipboardAttribution(): SingularConfig

Exemplo de utilização

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

withConversionValueUpdatedHandler

Método SingularConfig.withConversionValueUpdatedHandler

Define uma função de retorno de chamada a ser chamada quando o valor de conversão SKAdNetwork é atualizado. Isto é específico do iOS e permite-lhe reagir às alterações do valor de conversão.

Assinatura

withConversionValueUpdatedHandler(conversionValueUpdatedHandler: Function): SingularConfig

Exemplo de utilização

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 SingularConfig.withConversionValuesUpdatedHandler

Define uma função de retorno de chamada a ser chamada quando os valores de conversão da SKAdNetwork 4.0 são actualizados. Isto é específico do iOS 16.1+ e permite-lhe reagir a alterações nos valores finos, grossos e de bloqueio.

Assinatura

withConversionValuesUpdatedHandler(conversionValuesUpdatedHandler: Function): SingularConfig

Exemplo de utilização

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

Método SingularConfig.withCustomSdid

Define um SDID (ID de dispositivo singular) personalizado e retornos de chamada associados. Isto permite-lhe fornecer o seu próprio identificador de dispositivo em vez de utilizar o que é gerado pelo Singular.

Assinatura

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

Exemplo 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

Método SingularConfig.withCustomUserId

Define um ID de usuário personalizado durante a inicialização do SDK. Isto permite-lhe associar os dados Singular ao seu próprio sistema de identificação de utilizadores desde o início.

Assinatura

withCustomUserId(customUserId: string): SingularConfig

Exemplo de uso

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

withDeviceAttributionCallbackHandler

Método SingularConfig.withDeviceAttributionCallbackHandler

Funcionalidade BETA: Define uma função de retorno de chamada a ser chamada quando os dados de atribuição do dispositivo estiverem disponíveis. Isto permite-lhe aceder aos dados de atribuição assim que estiverem disponíveis.

Assinatura

withDeviceAttributionCallbackHandler(deviceAttributionCallbackHandler: Function): SingularConfig

Exemplo 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

Método SingularConfig.withESPDomains

Define os domínios ESP (Email Service Provider) para atribuição de correio eletrónico. Isto permite-lhe especificar quais os domínios de correio eletrónico que devem ser considerados para atribuição.

Assinatura

withESPDomains(espDomains: string[]): SingularConfig

Exemplo de utilização

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

withFacebookAppId

Método SingularConfig.withFacebookAppId

Define a ID do aplicativo do Facebook para atribuição do Facebook. Isso permite que o SDK atribua instalações e eventos de campanhas do Facebook.

Assinatura

withFacebookAppId(facebookAppId: string): SingularConfig

Exemplo de uso

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

withGlobalProperty

Método SingularConfig.withGlobalProperty

Define uma propriedade global durante a inicialização do SDK. Esta propriedade será enviada com todos os eventos monitorizados pelo SDK.

Assinatura

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

Exemplo de uso

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

withLimitDataSharing

Método SingularConfig.withLimitDataSharing

Define o estado de limitação da partilha de dados durante a inicialização do SDK. Utilize este método para limitar a partilha de dados com base no consentimento do utilizador ou em requisitos de privacidade.

Assinatura

withLimitDataSharing(shouldLimitDataSharing: boolean): SingularConfig

Exemplo de utilização

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

withLimitedIdentifiersEnabled

Método SingularConfig.withLimitedIdentifiersEnabled

Ativa ou desactiva a utilização de identificadores limitados. Esta opção afecta a forma como o SDK recolhe e utiliza identificadores de dispositivos para rastreio e atribuição.

Assinatura

withLimitedIdentifiersEnabled(limitedIdentifiersEnabled: boolean): SingularConfig

Exemplo de utilização

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

withLogLevel

Método SingularConfig.withLogLevel

Define o nível de registo para o SDK. Isto controla a verbosidade dos registos gerados pelo SDK.

Assinatura

withLogLevel(level: string): SingularConfig

Exemplo de utilização

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

withLoggingEnabled

Método SingularConfig.withLoggingEnabled

Ativa o registo detalhado para o SDK. Quando ativado, o SDK produzirá registos detalhados que podem ajudar na depuração.

Assinatura

withLoggingEnabled(): SingularConfig

Exemplo de utilização

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

withManualSkanConversionManagement

Método SingularConfig.withManualSkanConversionManagement

Permite a gestão manual dos valores de conversão SKAdNetwork. Quando ativado, o SDK não actualizará automaticamente os valores de conversão, permitindo-lhe controlá-los manualmente.

Assinatura

withManualSkanConversionManagement(): SingularConfig

Exemplo de utilização

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

withOAIDCollection

Método SingularConfig.withOAIDCollection

Permite a recolha de OAID (Open Anonymous Device Identifier) em dispositivos Android suportados. Trata-se de um identificador alternativo utilizado em algumas regiões, nomeadamente na China.

Assinatura

withOAIDCollection(): SingularConfig

Exemplo de utilização

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

withPushNotificationsLinkPaths

Método SingularConfig.withPushNotificationsLinkPaths

Define os caminhos para procurar links profundos em cargas de notificação push. Isso ajuda o SDK a encontrar e processar links de atribuição em notificações push.

Assinatura

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

Exemplo 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 SingularConfig.withSessionTimeoutInSec

Define o tempo limite da sessão em segundos. Isto determina quanto tempo dura uma sessão de utilizador depois de a aplicação passar para segundo plano.

Assinatura

withSessionTimeoutInSec(sessionTimeout: number): SingularConfig

Exemplo de utilização

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

withShortLinkResolveTimeout

Método SingularConfig.withShortLinkResolveTimeout

Define o tempo limite em segundos para a resolução de links curtos. Determina quanto tempo o SDK aguardará pela resolução de uma ligação curta antes de continuar com a inicialização.

Assinatura

withShortLinkResolveTimeout(shortLinkResolveTimeout: number): SingularConfig

Exemplo de uso

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

withSingularLink

Método SingularConfig.withSingularLink

Define uma função de retorno de chamada para lidar com deep links processados pelo Singular. Isso permite que seu aplicativo responda a deep links usados na atribuição.

Assinatura

withSingularLink(singularLinkHandler: Function): SingularConfig

Exemplo 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

Método SingularConfig.withSkAdNetworkEnabled

Habilita ou desabilita o suporte a SKAdNetwork. Isto é específico do iOS e controla se o SDK irá utilizar a SKAdNetwork da Apple para atribuição.

Assinatura

withSkAdNetworkEnabled(skAdNetworkEnabled: boolean): SingularConfig

Exemplo de utilização

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

withWaitForTrackingAuthorizationWithTimeoutInterval

Método SingularConfig.withWaitForTrackingAuthorizationWithTimeoutInterval

Define o intervalo de tempo limite em segundos para aguardar a resposta de autorização de rastreamento do usuário no iOS 14+. Isso determina quanto tempo o SDK aguardará a resposta do prompt ATT antes de continuar com a inicialização.

Assinatura

withWaitForTrackingAuthorizationWithTimeoutInterval(waitForTrackingAuthorizationWithTimeoutInterval: number): SingularConfig

Exemplo de uso

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

Exemplo de configuração completa

Encadeamento de várias opções de configuração

O exemplo a seguir demonstra como criar uma configuração abrangente encadeando vários métodos de configuração.

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