Definindo um ID de usuário

Envie seu ID de usuário interno para a Singular para permitir o rastreamento entre dispositivos e relatórios de dados no nível do usuário. Esse identificador vincula a atividade do usuário entre sessões e dispositivos para uma análise de atribuição abrangente.

Requisitos de ID de usuário

Privacidade e práticas recomendadas

Siga estas diretrizes ao implementar o rastreamento de ID de usuário para garantir a conformidade com a privacidade e a medição adequada entre dispositivos.

• Sem PII: A ID de utilizador não deve expor informações de identificação pessoal (PII), tais como endereços de correio eletrónico, nomes de utilizador ou números de telefone. Use um valor com hash exclusivo para seus dados primários.
• Consistência entre plataformas: O valor da ID de utilizador deve ser o mesmo identificador interno que capta em todas as plataformas (Web/Mobile/PC/Console/Offline) para uma medição precisa entre dispositivos.
• Dados de primeira parte: A Singular inclui o ID de utilizador em exportações ao nível do utilizador, ETL e postbacks de BI interno (se configurado). O ID de utilizador é um dado primário e não é partilhado com terceiros.
• Persistência: O ID de utilizador persiste até ser explicitamente desativado utilizando unsetCustomUserId() ou até a aplicação ser desinstalada. Fechar ou reiniciar a aplicação não apaga o ID de utilizador.

Descrição geral da implementação

Quando definir o ID de utilizador

Utilize setCustomUserId() para definir o identificador de utilizador e unsetCustomUserId() para o limpar durante o fim de sessão. Escolha a abordagem de implementação com base no momento em que o ID de utilizador fica disponível no seu fluxo de aplicações.

Se você já sabe a ID de usuário quando o aplicativo é aberto (por exemplo, o usuário tem login persistente), configure-a usando withCustomUserId() antes de inicializar o SDK Singular. Isso garante que o Singular receba a ID de usuário da primeira sessão. No entanto, a ID de utilizador normalmente não está disponível até que o utilizador se registe ou inicie sessão, caso em que deve chamar setCustomUserId() após a conclusão do fluxo de registo ou autenticação.

Métodos do SDK

Definir ID de usuário personalizada

Envie sua ID de usuário interna para a Singular para rastreamento entre dispositivos e relatórios no nível do usuário. Chame este método imediatamente após a autenticação bem-sucedida para garantir que todos os eventos subsequentes sejam associados ao usuário.

// Set the user ID after login or registration
cordova.plugins.SingularCordovaSdk.setCustomUserId('user_123456');

Assinatura do método:

setCustomUserId(customUserId: string): void

Exemplo: Definir ID do usuário após o login

Chame setCustomUserId() imediatamente após o utilizador concluir a autenticação com êxito para garantir que todos os eventos subsequentes são associados ao seu ID de utilizador.

function handleUserLogin(email, password) {
  // Your authentication logic
  authenticateUser(email, password)
    .then(function(response) {
      if (response.success) {
        // Set the user ID in Singular after successful login
        cordova.plugins.SingularCordovaSdk.setCustomUserId(response.userId);
        
        console.log('User ID set:', response.userId);
        
        // Navigate to home screen
        navigateToHome();
      }
    })
    .catch(function(error) {
      console.error('Login failed:', error);
    });
}

Anular a definição do ID de utilizador personalizado

Limpar o ID de utilizador quando um utilizador termina a sessão para garantir um acompanhamento preciso da sessão em dispositivos com vários utilizadores. Isto evita que os eventos subsequentes sejam incorretamente atribuídos ao utilizador que terminou a sessão.

// Unset the user ID on logout
cordova.plugins.SingularCordovaSdk.unsetCustomUserId();

Assinatura do método:

unsetCustomUserId(): void

Exemplo: Anular a definição do ID de utilizador no fim da sessão

Chame unsetCustomUserId() durante o fluxo de logout para limpar o ID do usuário e evitar a atribuição incorreta de eventos subsequentes.

function handleUserLogout() {
  // Clear app data and user session
  clearUserSession()
    .then(function() {
      // Unset the user ID in Singular
      cordova.plugins.SingularCordovaSdk.unsetCustomUserId();
      
      console.log('User ID cleared');
      
      // Navigate to login screen
      navigateToLogin();
    })
    .catch(function(error) {
      console.error('Logout failed:', error);
    });
}

Definir ID de utilizador durante a inicialização

Se o ID de utilizador estiver disponível quando a aplicação for iniciada (por exemplo, o utilizador já tiver iniciado sessão com uma sessão persistente), configure-o durante a inicialização do SDK utilizando withCustomUserId(). Isto garante que a primeira sessão inclui o ID de utilizador.

document.addEventListener('deviceready', initializeApp, false);

function initializeApp() {
  // Check if user is already logged in (e.g., from local storage)
  var userId = localStorage.getItem('user_id');
  
  // Create configuration
  var config = new cordova.plugins.SingularCordovaSdk.SingularConfig(
    'YOUR_SDK_KEY',
    'YOUR_SDK_SECRET'
  );
  
  // If user ID exists, set it during initialization
  if (userId) {
    config.withCustomUserId(userId);
  }
  
  // Initialize SDK
  cordova.plugins.SingularCordovaSdk.init(config);
  console.log('Singular SDK initialized');
}

Assinatura do método de configuração:

withCustomUserId(customUserId: string): SingularConfig