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

Seguir
Avatar
Jared Ornstead
Updated
Documento

SDK Cordova - Referência 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 personalizar o comportamento do SDK, incluindo configurações de rastreamento, opções de atribuição, controles de privacidade e muito mais. Cada propriedade de configuração é apresentada com uma descrição, assinatura e exemplos práticos de uso.

apikey

Propriedade SingularConfig.apikey

Sua chave de API Singular. Esta é uma propriedade obrigatória que deve ser definida durante a inicialização da configuração.

Assinatura

apikey: string

Exemplo de uso

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

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

brandedDomains

Propriedade SingularConfig.brandedDomains

Define os domínios de marca para atribuição web-to-app. Isto permite-lhe especificar domínios personalizados que devem ser controlados para efeitos de atribuição.

Assinatura

brandedDomains: Array<string>

Exemplo de utilização

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

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

clipboardAttribution

Propriedade SingularConfig.clipboardAttribution

Ativa a atribuição da área de transferência para iOS. Quando ativado, o SDK verifica se existem dados de atribuição na área de transferência.

Assinatura

clipboardAttribution: boolean

Exemplo de utilização

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

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

collectOAID

Propriedade SingularConfig.collectOAID

Ativa a recolha de OAID (Identificador de dispositivo anónimo aberto) para Android. É utilizado principalmente para rastreio na China, onde o Google Play Services não está disponível. O valor predefinido é false.

Assinatura

collectOAID: boolean

Exemplo de utilização

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

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

conversionValueUpdatedHandler

Propriedade SingularConfig.conversionValueUpdatedHandler

Define um manipulador de retorno de chamada que é invocado quando o valor de conversão SKAdNetwork é atualizado. Isto é útil para acompanhar as alterações do valor de conversão no iOS.

Assinatura

conversionValueUpdatedHandler: Function

Exemplo de utilização

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

Propriedade SingularConfig.conversionValuesUpdatedHandler

Define um manipulador de chamada de retorno que é invocado quando os valores de conversão da SKAdNetwork 4.0 são actualizados. Esta chamada de retorno recebe o valor fino, o valor grosso e o estado do bloqueio para iOS 16.1+.

Assinatura

conversionValuesUpdatedHandler: Function

Exemplo de utilização

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

Funcionalidade empresarial - Contacte o seu Gestor de Sucesso do Cliente para ativar esta funcionalidade para a sua conta.

Propriedade SingularConfig.customSdid

Define um SDID (Singular Device ID) personalizado. Isso permite que o usuário forneça seu próprio identificador de dispositivo em vez de usar o gerado pela Singular.

Assinatura

customSdid: string

Exemplo 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

Propriedade SingularConfig.customUserId

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

customUserId: string

Exemplo de uso

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

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

deviceAttributionCallbackHandler

Recurso BETA - Define uma função de retorno de chamada a ser chamada quando os dados de atribuição do dispositivo estiverem disponíveis.

Propriedade SingularConfig.deviceAttributionCallbackHandler

Define um manipulador de retorno de chamada que é invocado quando os dados de atribuição do dispositivo estão disponíveis. Isto permite-lhe aceder aos dados de atribuição assim que são resolvidos.

Assinatura

deviceAttributionCallbackHandler: Function

Exemplo 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

Funcionalidade empresarial - Callback que é invocado quando um SDID personalizado é definido.

Propriedade SingularConfig.didSetSdidCallback

Define uma função de chamada de retorno a invocar quando o SDID personalizado é definido. É utilizada em conjunto com a propriedade customSdid.

Assinatura

didSetSdidCallback: Function

Exemplo de utilização

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

Propriedade SingularConfig.enableLogging

Ativa o registo do SDK para fins de depuração. Isso é útil durante o desenvolvimento e a solução de problemas. Recomenda-se desativar o registo em compilações de produção. O valor padrão é false.

Assinatura

enableLogging: boolean

Exemplo de utilização

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

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

enableOdmWithTimeoutInterval

Propriedade SingularConfig.enableOdmWithTimeoutInterval

Ativa a Medição no Dispositivo com um intervalo de tempo limite especificado. Esta funcionalidade permite uma medição centrada na privacidade. O valor predefinido é -1 (desativado).

Assinatura

enableOdmWithTimeoutInterval: number

Exemplo de utilização

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

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

espDomínios

Propriedade SingularConfig.espDomains

Define os domínios ESP (Email Service Provider) para atribuição baseada em correio eletrónico. Isto permite-lhe controlar a atribuição de campanhas de correio eletrónico.

Assinatura

espDomains: Array<string>

Exemplo de utilização

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

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

facebookAppId

Propriedade SingularConfig.facebookAppId

Define a ID do aplicativo do Facebook para integração de atribuição do Facebook. Isso permite uma integração profunda com o sistema de atribuição do Facebook.

Assinatura

facebookAppId: string

Exemplo de uso

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

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

globalProperties

Propriedade SingularConfig.globalProperties

Define propriedades globais durante a inicialização que serão enviadas com todos os eventos subsequentes. Isto é útil para rastrear atributos persistentes do utilizador ou o estado da aplicação.

Assinatura

globalProperties: Object

Exemplo 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

Propriedade SingularConfig.limitAdvertisingIdentifiers

Controla se os identificadores de publicidade (IDFA/GAID) devem ser limitados. Utilize esta propriedade para cumprir as preferências e os regulamentos em matéria de privacidade. O valor predefinido é false.

Assinatura

limitAdvertisingIdentifiers: boolean

Exemplo de utilização

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

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

limitDataSharing

Propriedade SingularConfig.limitDataSharing

Define o estado de limitação da partilha de dados durante a inicialização. Utilize esta propriedade para cumprir os regulamentos de privacidade, limitando os dados que são partilhados com terceiros. O valor padrão é null.

Assinatura

limitDataSharing: boolean

Exemplo de utilização

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

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

logLevel

SingularConfig.logLevel Propriedade

Define o nível de registo do SDK para um controlo mais pormenorizado da saída do registo, o que lhe permite especificar a verbosidade dos registos do SDK.

Assinatura

logLevel: number

Exemplo de utilização

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

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

manualSkanConversionManagement

Propriedade SingularConfig.manualSkanConversionManagement

Ativa a gestão manual do valor de conversão SKAdNetwork. Quando activada, é necessário atualizar manualmente os valores de conversão em vez de depender de actualizações automáticas. O valor predefinido é false.

Assinatura

manualSkanConversionManagement: boolean

Exemplo de utilização

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

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

pushNotificationsLinkPaths

Propriedade SingularConfig.pushNotificationsLinkPaths

Configura caminhos personalizados para extrair links profundos de cargas de notificação push. Isto permite-lhe especificar em que parte da carga útil da notificação se encontra o deep link.

Assinatura

pushNotificationsLinkPaths: Array<Array<string>>

Exemplo 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

Caraterística da empresa - Callback que é invocado quando o SDID é recebido.

Propriedade SingularConfig.sdidReceivedCallback

Define uma função de chamada de retorno a invocar quando o SDID é recebido do servidor. Esta propriedade é utilizada em conjunto com a propriedade customSdid.

Assinatura

sdidReceivedCallback: Function

Exemplo de utilização

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

secret

Propriedade SingularConfig.secret

Seu segredo do Singular SDK. Esta é uma propriedade obrigatória que deve ser definida durante a inicialização da configuração.

Assinatura

secret: string

Exemplo de uso

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

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

sessionTimeout

Propriedade SingularConfig.sessionTimeout

Define o tempo limite da sessão em segundos. Determina o tempo de duração de uma sessão de utilizador depois de a aplicação passar para segundo plano. O valor padrão é -1 (usa o tempo limite padrão de 60 segundos).

Assinatura

sessionTimeout: number

Exemplo de utilização

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

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

shortLinkResolveTimeout

Propriedade SingularConfig.shortLinkResolveTimeout

Define o tempo limite em segundos para a resolução de links curtos. Isso determina quanto tempo o SDK aguardará a resolução de um link curto. O valor padrão é 10 segundos.

Assinatura

shortLinkResolveTimeout: number

Exemplo de uso

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

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

singularLinkHandler

Propriedade SingularConfig.singularLinkHandler

Define um manipulador de retorno de chamada para Singular Links (links profundos). Esta chamada de retorno é invocada quando a aplicação é aberta através de um Singular Link, permitindo-lhe lidar com a lógica de ligação profunda.

Assinatura

singularLinkHandler: Function

Exemplo de utilização

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

Propriedade SingularConfig.skAdNetworkEnabled

Ativa ou desativa o suporte a SKAdNetwork para iOS. Quando ativado, o SDK tratará automaticamente da atribuição de SKAdNetwork. O valor predefinido é true.

Assinatura

skAdNetworkEnabled: boolean

Exemplo de utilização

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

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

waitForTrackingAuthorizationWithTimeoutInterval

Propriedade SingularConfig.waitForTrackingAuthorizationWithTimeoutInterval

Define o intervalo de tempo limite para aguardar a autorização do iOS ATT (App Tracking Transparency) antes de inicializar o SDK. Isso é útil para o iOS 14+ para garantir que a permissão de rastreamento seja solicitada antes da inicialização do SDK. O valor padrão é 0 (sem espera).

Assinatura

waitForTrackingAuthorizationWithTimeoutInterval: number

Exemplo 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

Exemplo de configuração completa

Aqui está um exemplo abrangente que mostra como configurar o SDK Singular com várias opções:

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