A Singular pode receber dados de eventos do Segment por meio das APIs REST de servidor para servidor (S2S) da Singular para atividade móvel iOS e Android. Isso é chamado de Destination "Cloud-Mode". As instruções abaixo ilustram como adicionar o Singular Destination no Segment.
Guia para | Equipes de engenharia |
Pré-requisitos | Este artigo pressupõe que você já tenha o SDK do Segment Analytics para iOS ou Android integrado ao seu aplicativo. |
Para usar essa integração, você deve estar usando os SDKs do Segment Mobile Analytics. Essa integração NÃO é compatível com dados de eventos não móveis. Não há suporte para eventos de servidor ou da Web.
- Atribuição de instalação básica
- Atribuição de anúncios de pesquisa da Apple
- Rastreamento de eventos personalizados no aplicativo
- Rastreamento de receita
- ID de usuário personalizado
- Suporte a SkAdNetwork
- Atribuição de referenciador da instalação META
- Links profundos
- Suporte limitado ao compartilhamento de dados
Se você precisar de suporte S2S para a "Funcionalidade completa de recursos" oferecida pela Singular, deverá implementar as APIs REST S2S da Singular independentemente do Segment. Consulte o Guia de integração de servidor para servidor (S2S) AQUI.
Primeiros passos
- No aplicativo da Web do Segment, clique em "Catalog" (Catálogo) no menu "Connections" (Conexões).
- Pesquise "Singular" no Catálogo, selecione-o e clique no botão "Add Destination" (Adicionar destino).
- Selecione as origens às quais conectar o destino e clique em "Next" (Avançar).
- Nomeie o destino e clique em "Create destination" (Criar destino)
- Obtenha sua "SDK KEY" do Singular, encontrada no painel do Singular em " Developer Tools > SDK Integration > SDK Keys", e adicione-a às "Connection Settings" do segmento, em "API Key".
Observação: para a integração "Cloud-Mode", você SOMENTE inserirá o valor da API Key (SDK Key).
Deixe o "Secret" em branco.
Importante: certifique-se de usar a chave SDK singular para o valor da chave de API no Segment. Se a chave errada for usada, a Singular não receberá nenhum dado.
Configuração adicional
Suporte à atribuição do Apple Search Ads
Observação: se você estiver usando o Device-Based Destination, não há necessidade de implementar o código abaixo, pois os dados já são coletados automaticamente.
Para obter dados de atribuição na Singular, você deve incluir a dependência analytics-ios-iads-attribution e a versão 3.6.0 ou superior do SDK do Analytics.
Para instalá-lo, basta adicionar a seguinte linha ao seu Podfile:
pod "Analytics"
pod "Analytics-iAds-Attribution"
Em seguida, importe o cabeçalho e inicialize a configuração:
#import <Analytics-iAds-Attribution/SEGADTracker.h>
// Initialize the configuration as you would normally.
SEGAnalyticsConfiguration *configuration = [SEGAnalyticsConfiguration
configurationWithWriteKey:@"YOUR_WRITE_KEY"];
...
// Configure the client with the iAD middleware to attach iAd properties.
configuration.middlewares = @[ [SEGADTracker middleware] ];
[SEGAnalytics setupWithConfiguration:configuration];
import Analytics-iAds-Attribution
// Initialize the configuration as you would normally.
var configuration = SEGAnalyticsConfiguration(writeKey: "WriteKey")
...
// Configure the client with the iAD middleware to attach iAd properties.
configuration.middlewares = [SEGADTracker.middleware()]
SEGAnalytics.setup(with: configuration)
Quando as informações do iAd estão disponíveis, as informações de atribuição são transformadas no contexto do Segment dessa maneira:
[analytics track:@"Application Installed",
properties: nil,
options: @{
@"context" : @{
@"campaign" : @{
@"provider" : @"Apple",
@"click_date" : attributionInfo[@"iad-click-date"],
@"conversion_date" : attributionInfo[@"iad-conversion-date"],
@"source" : @"iAd",
@"name" : attributionInfo[@"iad-campaign-name"],
@"content" : attributionInfo[@"iad-keyword"],
@"ad_creative" : attributionInfo[@"iad-org-name"],
@"ad_group" : attributionInfo[@"iad-adgroup-name"],
@"id" : attributionInfo[@"iad-campaign-id"],
@"ad_group_id" : attributionInfo[@"iad-adgroup-id"]
}
}
}];
A Singular mapeou explicitamente o evento de ciclo de vida Application Installed para fornecer as informações do iAd.
Atribuição de instalação
Ative o rastreamento automático de eventos de ciclo de vida (Application Opened, Application Installed, Application Updated) usando parâmetros de configuração de inicialização(iOS, Android) para rastrear instalações e sessões no Singular. A "sessão" do Singular será enviada automaticamente pela integração, desde que você inclua os eventos acima.
Rastreamento de evento personalizado
Se você não estiver familiarizado com as especificações do Segment, dê uma olhada para entender o que o método Track faz.
Use a função de rastreamento do Segment para que os eventos sejam traduzidos e enviados para a Singular:
[[SEGAnalytics sharedAnalytics] track:@"simple event"];
Analytics.with(this).track("event_name");
O Segment inclui todas as propriedades do evento como parâmetros de retorno de chamada no evento do Singular.
Os eventos estarão disponíveis em relatórios e exportações no nível do usuário.
Rastreamento de receita
A Singular receberá o rastreamento de receita quando um evento contendo a propriedade revenue for enviado (incluindo o valor zero). Opcionalmente, você pode passar a moeda (como um código de moeda ISO 4217 ). A moeda padrão é USD.
[[SEGAnalytics sharedAnalytics] track:@"segment revenue event" properties:@{@"currency": @"USD", @"revenue":@20}];
Analytics.with(this).track("purchase", new Properties().putRevenue(2.5).putValue("currency","USD"));
Observação: passe a moeda como um código de moeda ISO 4217 de três letras, por exemplo, "USD", "EUR", "INR".
ID de usuário personalizado
Você pode enviar seu ID de usuário do segmento para a Singular usando o método de identificação do segmento.
Observação: se você usar a solução Cross-Device da Singular, deverá coletar o mesmo UserID em todas as plataformas.
- O ID do usuário pode ser qualquer identificador e não deve expor PII (informações de identificação pessoal). Por exemplo, você não deve usar o endereço de e-mail, o nome de usuário ou o número de telefone de um usuário. A Singular recomenda o uso de um valor hash exclusivo apenas para seus dados primários.
- O valor do ID de usuário passado para a Singular também deve ser o mesmo ID de usuário interno que você captura em todas as plataformas (Web/Mobile/PC/Console/Offline).
- A Singular incluirá o ID de usuário nas exportações em nível de usuário, ETL e postbacks de BI interno (se configurado). O ID do usuário é um dado primário e a Singular não o compartilha com outras partes.
- O valor do ID de usuário, quando definido, persistirá até que seja redefinido usando o método de redefinição de segmento ou até que o aplicativo seja desinstalado. Fechar ou reiniciar o aplicativo não desativa a ID do usuário.
Siga as etapas aqui para configurar para: iOS, Android.
[[SEGAnalytics sharedAnalytics] identify:@"segment custom user id"];
Analytics.with(context).identify("myUserId");
Para cancelar a definição do ID de usuário personalizado, chame o método de redefinição.
[[SEGAnalytics sharedAnalytics] reset];