Documento

Referência de métodos do SDK do React Native

Esta referência abrangente documenta todos os métodos disponíveis no SDK Singular para rastreamento de aplicativos móveis. O SDK fornece funcionalidade para inicialização, identificação do usuário, rastreamento de eventos, relatórios de receita, atribuição, conformidade com a privacidade de dados e configuração. Cada método é apresentado com uma descrição, assinatura e exemplos práticos de utilização para ajudar os programadores a integrar as capacidades do SDK da Singular nas suas aplicações.

adRevenue

Singular.adRevenue Method

Rastreia eventos de receita de anúncios com informações detalhadas sobre dados de anúncios.

Assinatura

static adRevenue(adData: SingularAdData): void

Exemplo de uso

// Create ad data object 
const adData = new SingularAdData()
     .withAdPlatform("AdMob")
     .withAdType("Rewarded")
     .withAdNetworkName("Google")
     .withCurrency("USD")
     .withRevenue(0.05);

// Track ad revenue event
Singular.adRevenue(adData);

clearGlobalProperties

Singular.clearGlobalProperties Method

Remove todas as propriedades globais previamente definidas.

Assinatura

static clearGlobalProperties(): void

Exemplo de utilização

// Clear all global properties, for example when a user logs out 
Singular.clearGlobalProperties();

createReferrerShortLink

Singular.createReferrerShortLink Method

Cria um link curto com informações do referenciador que pode ser usado para partilha e atribuição.

Assinatura

static createReferrerShortLink(baseLink: string, referrerName: string, referrerId: string, passthroughParams: SerializableObject, completionHandler: (result: string, error: string) => void): void

Exemplo de utilização

Singular.createReferrerShortLink( 
        "https://sample.sng.link/B4tbm/v8fp?_dl=https%3A%2F%2Fabc.com", 
        "John Doe", // Referrer Name 
        "aq239897", // Referrer ID 
        { "channel": "sms", "campaign": "summer_promo" }, // Passthrough parameters 
        (shortLinkURL, error) => { if (error) { 
           console.error("Error creating short link:", error); return; }
           console.log("Generated short link:", shortLinkURL);
          // Share the link with users
     }
);

customRevenue

Singular.customRevenue Method

Rastreia um evento de receita personalizado com um nome de evento, moeda e valor especificados.

Os nomes de eventos de receita personalizados são limitados a 32 caracteres ASCII. Para caracteres não ASCII, o limite é de 32 bytes após a conversão para UTF-8.
Os códigos de moeda devem estar em MAIÚSCULAS e seguir o código de moeda ISO 4217 de três letras

Assinatura

static customRevenue(eventName: string, currency: string, amount: number): void

Exemplo de utilização

// Track a custom revenue event 
Singular.customRevenue("premium_subscription", "USD", 9.99);

customRevenueWithArgs

Singular.customRevenueWithArgs Method

Rastreia um evento de receita personalizado com um nome de evento, moeda, valor e atributos personalizados adicionais especificados.

Os nomes de eventos de receita personalizados são limitados a 32 caracteres ASCII. Para caracteres não ASCII, o limite é de 32 bytes após a conversão para UTF-8.
Os nomes e valores de atributos de eventos estão limitados a 500 caracteres ASCII.
Os códigos de moeda têm de estar em MAIÚSCULAS e respeitar o código de moeda ISO 4217 de três letras

Assinatura

static customRevenueWithArgs(eventName: string, currency: string, amount: number, args: SerializableObject): void

Exemplo de utilização

// Track a custom revenue event with additional parameters 
Singular.customRevenueWithArgs( 
        "in_app_purchase", 
        "USD", 
        5.99, 
        { 
           "product_id": "com.app.gems_pack_small", 
           "quantity": 1, 
           "transaction_id": "T12345678", 
           "receipt_id": "R98765432" 
        }
);

event

Singular.event Method

Rastreia um evento personalizado simples com o SDK da Singular.

Os nomes de eventos são limitados a 32 caracteres ASCII. Para caracteres não-ASCII, o limite é de 32 bytes depois de convertidos para UTF-8.

Assinatura

static event(eventName: string): void

Exemplo de uso

// Track a simple event 
Singular.event("level_completed");

eventWithArgs

Singular.eventWithArgs Method

Rastreia um evento personalizado com atributos adicionais com o SDK da Singular.

Os nomes de eventos são limitados a 32 caracteres ASCII. Para caracteres não-ASCII, o limite é de 32 bytes depois de convertidos para UTF-8.
Os nomes e valores de atributos de eventos são limitados a 500 caracteres ASCII.

Assinatura

static eventWithArgs(eventName: string, args: SerializableObject): void

Exemplo de utilização

// Track an event with additional parameters 
Singular.eventWithArgs(
        "level_completed", 
        { 
           "level_number": 5, 
           "difficulty": "hard", 
           "time_spent": 120, 
           "score": 9500 
        }
);

getLimitDataSharing

Singular.getLimitDataSharing Method

Obtém o estado atual da limitação da partilha de dados para o utilizador.

Assinatura

static getLimitDataSharing(): boolean

Exemplo de utilização

// Check if data sharing is limited 
const isLimited = Singular.getLimitDataSharing(); 
console.log("Data sharing limitation status:", isLimited);

// Use the status to adjust app behavior
if (isLimited) {
     // Adjust functionality for users with limited data sharing
}

getGlobalProperties

Singular.getGlobalProperties Method

Recupera todas as propriedades globais atualmente definidas.

Assinatura

static getGlobalProperties(): Map<string, string>

Exemplo de uso

// Get all global properties 
const properties = Singular.getGlobalProperties();
        
     // Iterate through properties
     properties.forEach((value, key) => {
        console.log(${key}: ${value});
     });

inAppPurchase

Singular.inAppPurchase Method

Este método requer o uso do pacote In-App Purchase do React Native para gerenciar transações em seu aplicativo.

Rastreia um evento de compra in-app com detalhes da compra.

Os nomes de eventos são limitados a 32 caracteres ASCII. Para caracteres não ASCII, o limite é de 32 bytes depois de convertidos para UTF-8.

Assinatura

static inAppPurchase(eventName: string, purchase: SingularPurchase): void

Exemplo de utilização

// Add the Singular Purchase Class imports
import { 
        Singular, 
        SingularConfig, 
        Events, 
        SingularPurchase, 
        SingularIOSPurchase, 
        SingularAndroidPurchase } from 'singular-react-native';
  
// Create purchase object
let singularPurchase = null;
  
if (Platform.OS === 'ios') {
   singularPurchase = new SingularIOSPurchase(
     product.revenue,
     product.currency,
     purchase.productId,
     purchase.transactionId,
     purchase.transactionReceipt,
   );
  } else if (Platform.OS === 'android'){
   singularPurchase = new SingularAndroidPurchase(
     product.revenue,
     product.currency,
     purchase.transactionReceipt,
     purchase.signatureAndroid,
   );
}
  
// Track in-app purchase
Singular.inAppPurchase('iap_purchase', singularPurchase);

inAppPurchaseWithArgs

Singular.inAppPurchaseWithArgs Method

Esse método requer o uso do pacote de compra no aplicativo do React Native para gerenciar transações no seu aplicativo.

Rastreia um evento de compra in-app com detalhes de compra e atributos personalizados adicionais.

Os nomes de eventos são limitados a 32 caracteres ASCII. Para caracteres não ASCII, o limite é de 32 bytes depois de convertidos para UTF-8.
Os nomes e valores de atributos de eventos estão limitados a 500 caracteres ASCII.

Assinatura

static inAppPurchaseWithArgs(eventName: string, purchase: SingularPurchase, args: SerializableObject): void

Exemplo de uso

// Add the Singular Purchase Class imports
import { 
        Singular, 
        SingularConfig, 
        Events, 
        SingularPurchase, 
        SingularIOSPurchase, 
        SingularAndroidPurchase } from 'singular-react-native';
  
// Create purchase object
let singularPurchase = null;
  
if (Platform.OS === 'ios') {
   singularPurchase = new SingularIOSPurchase(
     product.revenue,
     product.currency,
     purchase.productId,
     purchase.transactionId,
     purchase.transactionReceipt,
   );
  } else if (Platform.OS === 'android'){
   singularPurchase = new SingularAndroidPurchase(
     product.revenue,
     product.currency,
     purchase.transactionReceipt,
     purchase.signatureAndroid,
   );
}
        
// Track in-app purchase with additional attributes
Singular.inAppPurchaseWithArgs(
     "iap_purchase",
     singularPurchase,
     {
        "is_first_purchase": true,
        "subscription_type": "yearly",
        "discount_applied": "holiday_special",
        "previous_subscription": "monthly"
     }
);

init

Singular.init Method

Inicializa o Singular SDK com a configuração fornecida. O parâmetro config é um objeto SingularConfig, que deve ser instanciado com um SDK Key (apiKey) e Secret (secret) válidos utilizando o construtor: new SingularConfig(apikey: string, secret: string).

Assinatura

static init(config: SingularConfig): void

Exemplo de utilização

// Create configuration 
const config = new SingularConfig('SDK KEY', 'SDK SECRET')
     .withCustomUserId("user123")
     .withSessionTimeoutInSec(60)
     .withLimitDataSharing(false)
     .withSingularLink((params) => { 
        // Handle deep link parameters 
        console.log("Deep link received:", params); 
     });

// Initialize Singular SDK
Singular.init(config);

isAllTrackingStopped

Singular.isAllTrackingStopped Method

Verifica se todo o rastreamento foi interrompido no SDK.

Assinatura

static isAllTrackingStopped(): boolean

Exemplo de utilização

// Check if tracking is currently stopped 
const isTrackingStopped = Singular.isAllTrackingStopped();
        
     // Adjust UI based on tracking status
     if (isTrackingStopped) {
        console.log("All tracking is currently stopped");
        // Update UI to reflect tracking status
     } else {
        console.log("Tracking is active");
     }

limitDataSharing

Singular.limitDataSharing Method

Limita a partilha de dados para o utilizador atual, normalmente utilizada para conformidade com a CCPA.

Assinatura

static limitDataSharing(shouldLimitDataSharing: boolean): void

Exemplo de utilização

// To limit data sharing (e.g., when user opts out) 
Singular.limitDataSharing(true);
        
// To enable full data sharing (e.g., when user opts in)
Singular.limitDataSharing(false);

resumeAllTracking

Singular.resumeAllTracking Method

Retoma todas as actividades de seguimento depois de terem sido interrompidas.

Assinatura

static resumeAllTracking(): void

Exemplo de utilização

// Resume tracking when user opts back in 
Singular.resumeAllTracking();
console.log("Tracking has been resumed");
// Update UI to reflect that tracking is now active

revenue

Singular.revenue Method

Rastreia um evento de receita simples com uma moeda e um montante especificados.

Os códigos de moeda devem estar em MAIÚSCULAS e respeitar o código de moeda ISO 4217 de três letras

Assinatura

static revenue(currency: string, amount: number): void

Exemplo de utilização

// Track a simple revenue event 
Singular.revenue("USD", 19.99);

revenueWithArgs

Singular.revenueWithArgs Method

Rastreia um evento de receita com uma moeda, um montante e atributos personalizados adicionais especificados.

Os nomes e valores dos atributos do evento estão limitados a 500 caracteres ASCII.
Os códigos de moeda devem ser em MAIÚSCULAS e respeitar o código de moeda ISO 4217 de três letras

Assinatura

static revenueWithArgs(currency: string, amount: number, args: SerializableObject): void

Exemplo de utilização

// Track a revenue event with additional parameters 
Singular.revenueWithArgs(
     "EUR", 
     9.99, 
     { 
        "subscription_type": "monthly", 
        "is_promotional": false, 
        "user_tier": "premium", 
        "payment_method": "credit_card" 
     }
);

setCustomUserId

Singular.setCustomUserId Method

Define uma ID de utilizador personalizada para o utilizador atual a ser utilizada com o SDK da Singular.

Assinatura

static setCustomUserId(customUserId: string): void

Exemplo de uso

// Set the custom user ID after user logs in 
Singular.setCustomUserId("user_123456");

setDeviceCustomUserId

Singular.setDeviceCustomUserId Method

Recurso empresarial: Associa um ID de usuário personalizado ao dispositivo atual para rastreamento entre plataformas.

Assinatura

static setDeviceCustomUserId(customUserId: string): void

Exemplo de utilização

// Set a device-level custom user ID 
Singular.setDeviceCustomUserId("device_user_987654");

setGlobalProperty

Singular.setGlobalProperty Method

Define uma propriedade global que será enviada com todos os eventos subsequentes.

Assinatura

static setGlobalProperty(key: string, value: string, overrideExisting: boolean): boolean

Exemplo de utilização

// Set a global property that will be included with all events 
const wasSet = Singular.setGlobalProperty("user_tier", "premium", true);
        
// Set another global property without overriding if it exists
Singular.setGlobalProperty("app_version", "2.1.3", false);
        
if (wasSet) {
     console.log("Global property was set successfully");
}

setUninstallToken

Singular.setUninstallToken Method

Define o token do dispositivo para rastreio de desinstalação através de notificações push.

Assinatura

static setUninstallToken(token: string): void

Exemplo de utilização

// Set the device token for uninstall tracking 
// This is typically obtained from the platform's push notification service 
const deviceToken = "a1b2c3d4e5f6g7h8i9j0..."; // FCM or APNS token 
Singular.setUninstallToken(deviceToken);

skanGetConversionValue

Singular.skanGetConversionValue Method

Obtém o valor atual de conversão de SKAdNetwork (apenas iOS).

Assinatura

static skanGetConversionValue(): number | null

Exemplo de utilização

// Get the current SKAdNetwork conversion value 
const conversionValue = Singular.skanGetConversionValue();
        
if (conversionValue !== null) {
     console.log("Current conversion value:", conversionValue);
} else {
     console.log("Conversion value not available");
}

skanRegisterAppForAdNetworkAttribution

Singular.skanRegisterAppForAdNetworkAttribution Method

Regista a aplicação para atribuição de SKAdNetwork (apenas iOS).

Assinatura

static skanRegisterAppForAdNetworkAttribution(): void

Exemplo de utilização

// Register app for SKAdNetwork attribution 
// This is typically called early in the app lifecycle 
Singular.skanRegisterAppForAdNetworkAttribution();

skanUpdateConversionValue

Singular.skanUpdateConversionValue Method

Atualiza o valor de conversão de SKAdNetwork (apenas iOS).

Assinatura

static skanUpdateConversionValue(conversionValue: number): boolean

Exemplo de utilização

// Update the SKAdNetwork conversion value 
// Value must be between 0-63 
const wasUpdated = Singular.skanUpdateConversionValue(12);

     if (wasUpdated) {
        console.log("Conversion value was updated successfully");
     } else {
        console.log("Failed to update conversion value");
     }

skanUpdateConversionValues

Singular.skanUpdateConversionValues Method

Actualiza os valores de conversão SKAdNetwork 4.0, incluindo fino, grosso e janela de bloqueio (apenas iOS 16.1+).

Assinatura

static skanUpdateConversionValues(conversionValue: number, coarse: number, lock: boolean): void

Exemplo de utilização

// Update SKAdNetwork 4.0 conversion values 
// Fine value: 0-63 
// Coarse value: 0-2 (Low, Medium, High) 
// Lock: whether to lock the postback window 
Singular.skanUpdateConversionValues(45, 2, false);
        
// Example with named constants for clarity
const FINE_VALUE = 45;
const COARSE_VALUE_HIGH = 2;
const LOCK_WINDOW = false;
Singular.skanUpdateConversionValues(FINE_VALUE, COARSE_VALUE_HIGH, LOCK_WINDOW);

stopAllTracking

Singular.stopAllTracking Method

Interrompe todas as atividades de rastreamento no SDK.

Assinatura

static stopAllTracking(): void

Exemplo de utilização

// Stop all tracking when user opts out 
Singular.stopAllTracking();
console.log("All tracking has been stopped");
// Update UI to reflect that tracking is now disabled

trackingOptIn

Singular.trackingOptIn Method

Permite que o utilizador seja rastreado para fins de análise e atribuição.

Assinatura

static trackingOptIn(): void

Exemplo de utilização

// Call when user has consented to tracking 
Singular.trackingOptIn();
console.log("User has opted into tracking");

trackingUnder13

Singular.trackingUnder13 Method

Marca o utilizador como tendo menos de 13 anos de idade, limitando a recolha de dados em conformidade com a COPPA.

Assinatura

static trackingUnder13(): void

Exemplo de utilização

// If user is determined to be under 13 years old 
Singular.trackingUnder13();
console.log("User marked as under 13, GDPR_UNDER_13 flag applied");

unsetCustomUserId

Singular.unsetCustomUserId Method

Remove o ID de utilizador personalizado definido anteriormente do acompanhamento Singular.

Assinatura

static unsetCustomUserId(): void

Exemplo de uso

// Remove the custom user ID when user logs out 
Singular.unsetCustomUserId();
console.log("Custom user ID has been removed");

unsetGlobalProperty

Singular.unsetGlobalProperty Method

Remove uma propriedade global definida anteriormente.

Assinatura

static unsetGlobalProperty(key: string): void

Exemplo de uso

// Remove a global property that is no longer needed 
Singular.unsetGlobalProperty("temporary_campaign_id");
console.log("Global property has been removed");

SDK do React Native - Referência de métodos do SDK

Referência de métodos do SDK do React Native

adRevenue

Singular.adRevenue Method

Assinatura

Exemplo de uso

clearGlobalProperties

Singular.clearGlobalProperties Method

Assinatura

Exemplo de utilização

createReferrerShortLink

Singular.createReferrerShortLink Method

Assinatura

Exemplo de utilização

customRevenue

Singular.customRevenue Method

Assinatura

Exemplo de utilização

customRevenueWithArgs

Singular.customRevenueWithArgs Method

Assinatura

Exemplo de utilização

event

Singular.event Method

Assinatura

Exemplo de uso

eventWithArgs

Singular.eventWithArgs Method

Assinatura

Exemplo de utilização

getLimitDataSharing

Singular.getLimitDataSharing Method

Assinatura

Exemplo de utilização

getGlobalProperties

Singular.getGlobalProperties Method

Assinatura

Exemplo de uso

inAppPurchase

Singular.inAppPurchase Method

Assinatura

Exemplo de utilização

inAppPurchaseWithArgs

Singular.inAppPurchaseWithArgs Method

Assinatura

Exemplo de uso

init

Singular.init Method

Assinatura

Exemplo de utilização

isAllTrackingStopped

Singular.isAllTrackingStopped Method

Assinatura

Exemplo de utilização

limitDataSharing

Singular.limitDataSharing Method

Assinatura

Exemplo de utilização

resumeAllTracking

Singular.resumeAllTracking Method

Assinatura

Exemplo de utilização

revenue

Singular.revenue Method

Assinatura

Exemplo de utilização

revenueWithArgs

Singular.revenueWithArgs Method

Assinatura

Exemplo de utilização

setCustomUserId

Singular.setCustomUserId Method

Assinatura

Exemplo de uso

setDeviceCustomUserId

Singular.setDeviceCustomUserId Method

Assinatura

Exemplo de utilização

setGlobalProperty

Singular.setGlobalProperty Method