Referência da API do ponto final SESSION

Referência da API do ponto final SESSION

Caso de uso de servidor para servidor

A API REST da Singular permite a integração direta servidor-a-servidor como alternativa ao SDK. O LAUNCH ou Session Endpoint permite o rastreio de sessões nas suas aplicações. Quando seu aplicativo encaminha dados específicos do dispositivo para seu servidor, que então transmite os dados para os servidores da Singular, a plataforma Singular processa essas informações para: Atribuição de instalação, Atribuição de reengajamento e Métricas de retenção. Esses dados processados preenchem automaticamente seus relatórios, logs de exportação e postbacks configurados, fornecendo análises abrangentes para suas campanhas de marketing.

Enquanto o SDK recolhe automaticamente os dados do dispositivo e da aplicação, a abordagem S2S exige que:

  1. Recolha os pontos de dados necessários da sua aplicação
  2. Encaminhar esses dados para seu servidor
  3. Envie-os para o Singular via API REST
  4. Passar a resposta do Singular de volta para o aplicativo

session-data-flow.png

Pontos principais

  • Flexibilidade: Controlo total sobre a recolha e transmissão de dados
  • Paridade de recursos: Suporta todas as funcionalidades do SDK quando os dados adequados são fornecidos
  • Caminho de integração: Cliente → Seu Servidor → API Singular
  • Processamento em tempo real: Um pedido de cada vez, sem processamento em lote
  • Fluxo de dados sequencial: Os eventos devem ser processados por ordem cronológica
  • Deduplicação de dados: O Singular não deduplica os dados recebidos. Recomenda-se enviar uma (1) solicitação bem-sucedida e salvar os logs para o caso de uma solicitação ser reproduzida novamente.
  • Validação de dados: Os dados no nível do dispositivo são permanentes e não podem ser excluídos após a ingestão. Implemente uma validação completa dos dados antes de enviá-los à Singular para garantir a precisão.

Gerenciamento de sessão

O endpoint LAUNCH é usado para notificar a Singular sobre um evento de abertura de aplicativo para uma nova sessão de usuário.

  • A inicialização da sessão (solicitação de lançamento) é necessária para:
    • Novas instalações de aplicativos
    • Lançamentos de aplicativos a partir do estado terminado
    • O aplicativo retorna do segundo plano para o primeiro plano
  • A sessão deve ser estabelecida antes de qualquer rastreio de eventos
  • Uma ordem de sessão inválida resultará em inconsistências de dados
  • Recomenda-se a implementação de um tempo limite de sessão e o envio da notificação SESSION ao Singular apenas se a aplicação não tiver sido utilizada nos últimos 1 minuto. Se um utilizador colocar a aplicação em segundo plano e, em seguida, colocar a aplicação em primeiro plano no espaço de 1 minuto ou menos, tal não deverá desencadear uma SESSION Singular, mas se colocar a aplicação em primeiro plano num período superior a 1 minuto, deverá desencadear uma SESSION.
  • Para suportar o deep linking, deve ser sempre enviada uma Session para a abertura da aplicação com o openURL no parâmetro 'open_uri'.

Como começar

A documentação do ponto de extremidade Session fornece:

Certifique-se de revisar as opções avançadas da integração Servidor para Servidor (S2S) da Singular, que exigem que o Ponto de extremidade de notificação de sessão inclua parâmetros adicionais. Saiba mais sobre as opções avançadas aqui.

Relatórios de sessões

A integração mais básica com o Singular envolve a notificação do Singular quando ocorre uma sessão de usuário, permitindo que o Singular acione vários processos internos:

  • Se for a primeira sessão do aplicativo no dispositivo específico, o Singular reconhece uma nova instalação e aciona o processo de atribuição de instalação.
  • Se a sessão se qualificar como uma sessão de reengajamento, o Singular aciona o processo de atribuição de reengajamento (saiba mais nas Perguntas frequentes sobre reengajamento).
  • Caso contrário, o Singular marca a sessão como uma sessão, que é usada para rastrear a atividade do usuário e as métricas de retenção.

O tempo de uma solicitação de sessão e as solicitações de eventos subsequentes para os servidores do Singular são críticos:

  1. Uma única sessão deve ser recebida antes de qualquer evento.
    Por exemplo, o SDK do Singular acionará uma sessão na abertura do aplicativo quando um usuário começar a usar o aplicativo e, em seguida, os eventos no aplicativo poderão ser enviados após a sessão. Se o utilizador colocar a aplicação em segundo plano durante um período de tempo prolongado (superior a 1 minuto), a sessão será encerrada. Outra sessão seria enviada quando a aplicação voltasse ao primeiro plano. É recomendável usar eventos do ciclo de vida do aplicativo e um timer para ajudar a gerenciar o gerenciamento de sessões e regular as solicitações de sessão para o Singular.
  2. Os eventos que ocorrem no aplicativo devem ser enviados em tempo real e após sua respectiva sessão.

Ponto de extremidade da API de sessão

Método HTTP e ponto de extremidade da sessão

GET https://s2s.singular.net/api/v1/launch

Parâmetros necessários

A tabela a seguir lista os parâmetros necessários que este endpoint suporta. Todos os parâmetros listados são parâmetros de consulta.

GET /api/v1/launch?param1=value1&param2=value2

 

  • Todos os parâmetros necessários têm de ser incluídos nos pedidos de API de SESSÃO
  • Os parâmetros devem seguir o formato e os tipos de dados especificados
Parâmetros necessários
Chave da API
Parâmetro Descrição
a
string

O parâmetro a especifica a Chave SDK Singular.

Recupere a Chave SDK na IU do Singular, em Ferramentas de Desenvolvedor no Menu Principal.

Nota: Não use a chave da API de relatório, pois isso resultará em dados rejeitados.

 

Exemplo de valor:
sdkKey_afdadsf7asf56
Parâmetros do identificador do dispositivo
Parâmetro Descrição do parâmetro
idfa

Plataformas suportadas:

  • iOS
string

O parâmetro idfa especifica o Identificador para Anunciantes (IDFA), que ajuda os anunciantes a rastrear e atribuir acções do utilizador (por exemplo, cliques em anúncios, instalações de aplicações) a campanhas específicas, permitindo uma segmentação precisa dos anúncios e a otimização das campanhas.

A partir do iOS 14.5, os utilizadores devem aderir através da estrutura App Tracking Transparency (ATT) para que as aplicações possam aceder ao IDFA. Se os utilizadores não optarem por aderir ao IDFA, este não estará disponível, o que resulta na limitação das capacidades de rastreio.

  • Se o IDFA não estiver disponível, omita o parâmetro do pedido.
  • Não passe NULL ou uma cadeia de caracteres vazia no pedido.
  • Como obter o identificador IDFA

 

Exemplo de valor:
DFC5A647-9043-4699-B2A5-76F03A97064B
Parâmetro Descrição do parâmetro
idfv

Plataformas suportadas:

  • iOS
string

O parâmetro idfv especifica o Identificador para Fornecedores (IDFV), um identificador único atribuído pela Apple a um dispositivo, que é específico de um determinado fornecedor ou programador. Permanece consistente em todas as aplicações do mesmo fornecedor num determinado dispositivo, permitindo ao fornecedor seguir o comportamento e as interações do utilizador no seu ecossistema de aplicações sem identificar o utilizador pessoalmente.

 

Exemplo de valor:
21DB6612-09B3-4ECC-84AC-B353B0AF1334
Parâmetro Descrição do parâmetro
aifa

Plataformas suportadas:

  • Android
    (Dispositivos Google Play)
string

O parâmetro aifa especifica o Google Advertising Identifier (GAID), também conhecido como AIFA no singular ou Android Advertising ID (AAID). Este identificador é um identificador único, redefinível pelo utilizador, atribuído a dispositivos Android. Ajuda os anunciantes e os programadores de aplicações a rastrear e atribuir acções do utilizador (por exemplo, cliques em anúncios, instalações de aplicações) em aplicações a campanhas específicas, permitindo uma segmentação precisa dos anúncios e a otimização das campanhas, mantendo a privacidade do utilizador.

  • Se a AIFA não estiver disponível, omita o parâmetro do pedido.
  • Apenas necessário em dispositivos Google Play.
  • Omitir o parâmetro em dispositivos não-Google Play.
  • Não passe NULL ou uma cadeia de caracteres vazia no pedido.
  • Como recuperar o identificador AIFA

 

Exemplo de valor:
8ecd7512-2864-440c-93f3-a3cabe62525b
Parâmetro Descrição do parâmetro
asid

Plataformas suportadas:

  • Android
    (Dispositivos Google Play)
string

O parâmetro asid especifica o ID do conjunto de aplicações do Android. O ASID fornece uma forma de os programadores acompanharem os utilizadores nas suas próprias aplicações de uma forma consciente da privacidade. É particularmente útil para análises e prevenção de fraudes, mas não pode ser utilizado para fins publicitários, como anúncios personalizados ou medições.

  • O ASID é necessário em todos os pedidos para dispositivos Google Play, independentemente da presença de GAID/AIFA.
  • Omitir o parâmetro em dispositivos não-Google Play.
  • Não passe NULL ou uma cadeia de caracteres vazia no pedido.
  • Como recuperar o identificador ASID

 

Exemplo de valor:
edee92a2-7b2f-45f4-a509-840f170fc6d9
Parâmetro Descrição do parâmetro
amid

Plataformas suportadas:

  • Android
    (Dispositivos Amazon sem Google Play Services)
string

O parâmetro amid especifica que a ID de publicidade é um identificador exclusivo e redefinível pelo utilizador que ajuda a proteger a privacidade do utilizador. Se recolher informações sobre o comportamento de um utilizador para apresentar anúncios baseados em interesses ou para gerar análises, tem de utilizar a ID de publicidade; não pode ser utilizado qualquer outro identificador ou método de rastreio. Os utilizadores podem redefinir a ID de publicidade ou optar por não utilizar anúncios baseados em interesses.

  • O AMID é necessário em todos os pedidos de dispositivos Amazon sem o Google Play Services.
  • Omitir o parâmetro se o AMID não estiver disponível.
  • Não passe NULL ou uma cadeia de caracteres vazia no pedido.
  • Como recuperar o identificador AMID

 

Exemplo de valor:
df07c7dc-cea7-4a89-b328-810ff5acb15d
Parâmetro Descrição do parâmetro
oaid

Plataformas suportadas:

  • Android
    (Dispositivos fabricados na China sem Google Play Services)
string

O parâmetro oaid especifica o Open Advertising Identifier (OAID). O OAID é um identificador único e anónimo utilizado para fins publicitários em dispositivos Android, especialmente os fabricados na China. Foi introduzido pela Mobile Security Alliance (MSA) como alternativa ao GAID (Advertising ID) da Google para dispositivos em que o Google Play Services não está disponível ou não é suportado, como no mercado chinês.

O OAID é utilizado principalmente para atribuição de publicidade e seguimento de utilizadores em ambientes onde o Google Play Services é restrito, permitindo aos anunciantes e programadores seguir o comportamento dos utilizadores mantendo o anonimato.

O OAID está disponível na maioria dos dispositivos Android fabricados na China, incluindo os de marcas como a Huawei, a Xiaomi e outras. Pode ser acedido através do MSA SDK ou dos Huawei Mobile Services (HMS).

  • O OAID é necessário em dispositivos Android fabricados na China sem o Google Play Services.
  • Omitir o parâmetro se o OAID não estiver disponível.
  • Não passe NULL ou uma cadeia de caracteres vazia no pedido.
  • Como recuperar o identificador OAID

 

Exemplo de valor:
01234567-89abc-defe-dcba-987654321012
Parâmetro Descrição do parâmetro
andi

Plataformas suportadas:

  • Android
    (Dispositivos não Google Play)
string

O parâmetro andi especifica o ID do Android, que é um identificador único de 64 bits gerado pelo sistema operativo Android quando um dispositivo é configurado pela primeira vez. Foi concebido para ser persistente ao longo da vida útil do dispositivo, mas pode ser reposto em determinadas condições, como uma reposição de fábrica.

O ID Android é único para cada dispositivo e, a partir do Android 8.0 (Oreo), tem um âmbito por aplicação e por utilizador. Isto significa que diferentes aplicações no mesmo dispositivo receberão diferentes IDs Android, a menos que partilhem a mesma chave de assinatura.

A ID Android mantém-se constante, a menos que o dispositivo seja reiniciado de fábrica ou se uma aplicação for desinstalada e reinstalada após uma atualização OTA (over-the-air).

  • A utilização da ANDI é proibida em dispositivos Google Play. Utilizar os identificadores AIFA e ASID acima referidos.
  • O ANDI só pode ser enviado à Singular se não existirem outros identificadores disponíveis e se a aplicação não estiver alojada na Google Play Store.
  • Omitir o parâmetro se estiverem disponíveis outros identificadores.
  • Não passe NULL ou uma cadeia de caracteres vazia no pedido.
  • Como recuperar o identificador ANDI

 

Exemplo de valor:
fc8d449516de0dfb
Parâmetro Descrição do parâmetro
sdid

Plataformas suportadas:

  • PC
  • Xbox
  • Playstation
  • Nintendo
  • MetaQuest
  • CTV
string

O parâmetro sdid especifica o ID de dispositivo único. Este valor é um UUIDv4 gerado no lado do cliente que representa uma instalação de aplicação única. Este é o único identificador de dispositivo utilizado para aplicações de PC e consola.

 

Exemplo de valor:
40009df0-d618-4d81-9da1-cbb3337b8dec
Parâmetro Descrição do parâmetro
sing

Plataformas suportadas:

  • Restrito para casos de uso especiais
  • Contacte o seu engenheiro de soluções ou CSM para obter mais informações
string

O parâmetro sing é restrito a clientes Enterprise e especifica um identificador definido pelo cliente. Apenas utilizado em utilizações especiais em que todos os outros identificadores não estão disponíveis. Este identificador deve ser ativado pelo Engenheiro de Soluções Singular numa base App-by-App.

 

Exemplo de valor:
da534a95-1b1b-47d4-94b6-07955ec85177
Parâmetros do dispositivo
Parâmetro Descrição
p
string

O parâmetro p especifica a plataforma da aplicação.

A lista seguinte contém os valores de parâmetros sensíveis a maiúsculas e minúsculas permitidos:

  • Android
  • iOS
  • PC
  • Xbox
  • Playstation
  • Nintendo
  • MetaQuest
  • CTV

 

Exemplo de valor:
Android
Parâmetro Descrição
ip
string

O parâmetro ip especifica o endereço IP público (IPV4) do dispositivo. O IPV6 não é suportado.

 

Exemplo de valor:
172.58.29.235
Parâmetro Descrição
ve
string

O parâmetro ve especifica a versão do sistema operativo do dispositivo no momento da sessão.

 

Exemplo de valor:
9.2
Parâmetro Descrição do parâmetro
ma

Plataformas suportadas:

  • Android
  • iOS
string

O parâmetro ma especifica a marca do hardware do dispositivo, normalmente o nome virado para o consumidor. Este parâmetro deve ser utilizado com o parâmetro model.

Como obter a marca do dispositivo

 

Exemplos:
Samsung, LG, Apple
Parâmetro Descrição do parâmetro
mo

Plataformas suportadas:

  • Android
  • iOS
string

O parâmetro mo especifica o modelo do hardware do dispositivo. Este parâmetro deve ser utilizado com o parâmetro make.

Como obter o modelo do dispositivo

 

Exemplos:
iPhone 4S, Galaxy SIII
Parâmetro Descrição
lc

Plataformas suportadas:

  • Android
  • iOS
string

O parâmetro lc especifica a etiqueta de localidade IETF para o dispositivo, utilizando o código de duas letras do idioma e do país, separados por um sublinhado.

Como recuperar a localidade do dispositivo

 

Exemplo de valor:
en_US
Parâmetro Descrição do parâmetro
bd

Plataformas suportadas:

  • Android
  • iOS
string

O parâmetro bd especifica a construção do dispositivo, codificada por URL.

Como obter a compilação do dispositivo

 

Exemplo de valor:
Build%2F13D15
Parâmetros da aplicação
Parâmetro Descrição
i
string

O parâmetro i especifica o identificador da aplicação.

Este é o Nome do Pacote para Android ou o ID do Pacote para iOS ou da sua aplicação. valores de parâmetro sensíveis a maiúsculas e minúsculas :

  • Nome do pacote para Android
  • ID do pacote para iOS
  • O seu identificador designado para PC, Xbox, Playstation, Nintendo, MetaQuest ou CTV

 

Exemplo de valor:
com.singular.app
Parâmetro Descrição
app_v
string

O parâmetro app_v indica a versão da aplicação.

 

Exemplos:
1.2.3
Parâmetro Descrição
install
string

O parâmetro install especifica se esta sessão representa a primeira sessão após uma instalação ou reinstalação. Passe"true" se a sessão foi a primeira após a instalação da aplicação ou"false" se a aplicação já estiver instalada e esta for uma sessão subsequente ou uma aplicação aberta. Este parâmetro é necessário para as capacidades de controlo de Reinstalação.

 

Exemplos:
true
Parâmetro Descrição
install_time

Plataformas suportadas:

  • Android
  • iOS
int

O parâmetro install_time especifica a hora da primeira instalação da aplicação como hora UNIX. Para recuperar esse valor, use o link na plataforma.

 

Exemplo de valor:
1510040127
Parâmetro Descrição do parâmetro
update_time

Plataformas suportadas:

  • Android
  • iOS
int

O parâmetro update_time especifica a hora da última atualização da aplicação como hora UNIX. Para recuperar esse valor, use o link na plataforma.

 

Exemplo de valor:
1510040127
Parâmetro Descrição do parâmetro
att_authorization_status

Plataformas suportadas:

  • iOS
int

O parâmetro att_authorization_status especifica o código de estado App Tracking Transparency (ATT). A partir do iOS 14.5, o prompt App Tracking Transparency (ATT) é necessário para aceder ao identificador IDFA.

Nota: Mesmo que não implemente a solicitação ATT, exigimos que passe o estado de autorização ATT com o valor'0', indicando "indeterminado".

Os valores suportados são:

  • 0 - Indeterminado.
  • 1 - Restrito, o utilizador desactivou o seguimento de aplicações.
  • 2 - Negado, o utilizador negou a autorização.
  • 3 - Autorizado, o utilizador concedeu autorização.

 

Exemplos:
3
Parâmetros de fraude
Parâmetro Descrição
install_source

Plataformas suportadas:

  • Android
  • PC
string

O parâmetro install_source especifica o nome do pacote da fonte de instalação no Android. Os valores recomendados para a fonte de instalação no PC são a loja de instalação.

Os nomes de lojas de instalação suportados para PC incluem:

  • steam
  • epic
  • microsoftstore
  • humblestore
  • gog
  • auto-distribuído

 

Exemplo para Android (Google Play Store):

com.vending.android
Parâmetro Descrição
install_receipt

Plataformas suportadas:

  • iOS
string

O parâmetro install_receipt especifica o recibo recebido da instalação. Saiba como recuperá-lo em Recibo de instalação do iOS

 

Exemplo de uma cadeia de recibos codificada em base64 do iOS:
MIJF9wYJKoZIhvcNAQcCoIJF6DCCReQCAQExCzAJBgUrDgMCGgUAMII1mAYJKoZIhvcNAQcBoII1iQSCNYUxgjWBMAoCAQgCAQEEAhYAMAoCARQCAQEEAgwAMAsCAQECAQEEAwIBADALAgELAgEBBAMCAQAwCwIBDwIBAQQDAgEAMAsCARACAQEEAwIBADALAgEZAgEBBAMCAQMwDAIBAwIBAQQEDAIyNTAMAgEKAgEBBAQWAjQrMAwCAQ4CAQEEBAICAM8wDQIBDQIBAQQFAgMCIuAwDQIBEwIBAQQFDAMxLjAwDgIBCQIBAQQGAgRQMjU1
Parâmetros de Deeplinking
Parâmetro Descrição do parâmetro
openuri

Plataformas suportadas:

  • Android
  • iOS
URL-encoded string

O parâmetro openuri especifica se o aplicativo foi aberto por meio de qualquer link profundo, iOS Universal Link ou Android App Link e você deve fornecer o valor de URL aberto codificado por URL.

Abrir URL:
myapp://home/page?queryparam1=value1&queryparam2=value2

 

Exemplo de valor:
myapp%3A%2F%2Fhome%2Fpage%3Fqueryparam1%3Dvalue1%26queryparam2%3Dvalue2
Parâmetro Descrição do parâmetro
ddl_enabled

Plataformas suportadas:

  • Android
  • iOS
string

O parâmetro ddl_enabled especifica se o aplicativo está habilitado para suportar Deferred deep links. Passe"true" se o servidor espera que um URL de link profundo diferido seja retornado ou"false" caso contrário.

 

Exemplo de valor:
true

 

Resposta de exemplo:
{
  "deferred_deeplink": "myapp://deferred-deeplink",
  "status": "ok",
  "deferred_passthrough": "passthroughvalue"
}
Parâmetro Descrição do parâmetro
singular_link_resolve_required

Plataformas suportadas:

  • Android
  • iOS
string

O parâmetro singular_link_resolve_required é utilizado para resolver uma ligação curta Singular. Deve ser enviado com um valor no 'openuri' que seja uma ligação curta Singular. Passe'true' se o servidor espera que a ligação curta expandida (ligação longa) seja devolvida ou'false' caso contrário. Consulte Tratamento de links curtos.

 

Exemplo de valor:
true

 

Resposta de exemplo:
{
  "status":"ok",
  "resolved_singular_link":"https://myapp.sng.link/A59c0/nha7?_dl=myapp%3A%2F%2Fdeeplink&_ddl=myapp%3A%2F%2Fdeferred-deeplink&_p=passthroughvalue"
}
Parâmetros avançados de atribuição
Parâmetro Descrição do parâmetro
install_ref

Plataformas suportadas:

  • Android
    (Dispositivos Google Play)
JSON URL-encoded string

O parâmetro install_ref especifica se o Google Install Referrer Information. O referenciador de instalação contém informações sobre quem enviou um usuário para a Google Play Store. Quando o referenciador de instalação está disponível para o Singular, ele fornece a maneira mais precisa de atribuir instalações. Recupere esse valor e passe-o para o Singular na primeira chamada de notificação de sessão.

{
   "installBeginTimestampSeconds":"1568939453",
   "referrer":"utm_source=google-play&utm_medium=organic",
   "clickTimestampSeconds":"0",
   "referrer_source":"service",
   "current_device_time":"1568944524"
}

Ele é necessário para alguns recursos importantes do Singular, como receber dados do Facebook em nossas Exportações de nível de usuário, compartilhá-los com Destinos de dados e enviar postbacks.

O Google Play recolhe informações de referenciador quando um utilizador chega à loja. Se o utilizador instalar posteriormente a aplicação para a qual foi direcionado, o Google Play disponibiliza as informações à aplicação. Para mais informações, consulte a documentação do Google para programadores.

 

Exemplo de valor:
%7B%22installBeginTimestampSeconds%22%3A%221568939453%22%2C%22referrer%22%3A%22utm_source%3Dgoogle-play%26amp%3Butm_medium%3Dorganic%22%2C%22clickTimestampSeconds%22%3A%220%22%2C%22referrer_source%22%3A%22service%22%2C%22current_device_time%22%3A%221568944524%22%7D
Parâmetro Descrição do parâmetro
meta_ref

Plataformas suportadas:

  • Android
    (Dispositivos Google Play)
JSON URL-encoded string

O parâmetro meta_ref especifica o "Meta Referrer", que é uma solução de medição específica do Android introduzida pelo Facebook para permitir aos anunciantes o acesso a dados de atribuição granulares ao nível do utilizador para instalações de aplicações Android (consulte as políticas de dados do Facebook). É composta pela implementação das tecnologias "Google Play Install Referrer" (consulte "Passar Google Install Referrer") e "Meta Install Referrer" para a medição da instalação da aplicação. Leia mais sobre o Meta Referrer nas Perguntas frequentes sobre o tópico.

{
  "install_referrer": {
    "utm_source":"apps.facebook.com",
    "utm_campaign": "fb4a",
    "utm_content": {
      "source":{
        "data":"c7e6b890bf18a059c2185650bdb1af3dced7...",
        "nonce":"24859720343e2381daee9f39ae61"
        },
      "app":533744218636280,
      "t":1731181327
      },
    "is_ct":1,
    "actual_timestamp":1731181444,
  }
}

 

Exemplo de valor:
%7B%22install_referrer%22%3A%7B%22utm_source%22%3A%22apps.facebook.com%22%2C%22utm_campaign%22%3A%22fb4a%22%2C%22utm_content%22%3A%7B%22source%22%3A%7B%22data%22%3A%22c7e6b890bf18a059c2185650bdb1af3dced7...%22%2C%22nonce%22%3A%2224859720343e2381daee9f39ae61%22%7D%2C%22app%22%3A533744218636280%2C%22t%22%3A1731181327%7D%2C%22is_ct%22%3A1%2C%22actual_timestamp%22%3A1731181444%2C%7D%7D
Parâmetro Descrição do parâmetro
attribution_token

Plataformas suportadas:

  • iOS
string

O parâmetro attribution_token especifica o token de atribuição do Apple Search Ads recuperado no iOS 14.3+ através da estrutura AdServices.

Recupere o token de atribuição usando attributionToken() assim que o aplicativo for inicializado pela primeira vez após uma instalação ou reinstalação.

 

Exemplo de valor:
KztLg%2FIkNsWDMuBMOU%2BySnkPU5myJb4OFmeaMUE%2BTqQJP1HWL%2FBdpQKNHSnghf0uQpWDsdNcoWHHlXzrRta22Aww4QsUdPGKLwAAAVADAAAAwgAAAIAOMB3LOGJVmcso4G42C3bF8API7suoQgqrM9xfbMKtjpn0anD4Xca2Ma8fMa%2FZLBqWalHYmm58zs4bH1XUDtBcSex1d80D4AhnnPoSYFukr%2ACfLCEnT2lHurPb5cPPQ17ewCd3ctuuZYGHuvV66AkU1ExJUguciTXTNEgY%2Fc19rQAAAB%2BF8udKcAQxkREhEtyGQGRUFydziffiLHBN7bXKSHPFAAAAnwGYh9H%2BPP4rEQGnbnTiQUnkfqgfKQAAAIYCCLjE6nnxqwDQPb4%2FF0Wve%2FVnSwwUxYGsi2a3V5dioUgCzty2kAG8kUsNjk0rU0Z0UrOhvCR%2FGfLXQv7HsMIZlbeKoHast6%2BXfiFsA2x244gztybPDecoGAvsmOeBKxjJqPDGqYxIpBgGaggGg1wonia%2BhxqjcLpEKG%2F%2F%2FEOZb3Jdf%2FaN%2FQABBEkLAAA%3D

Corpo da solicitação

Não forneça um corpo de pedido ao chamar este método. O pedido deve ser enviado utilizando o método GET com parâmetros de consulta.

 

Exemplos de pedidos

Os seguintes exemplos de código podem não representar todos os parâmetros suportados. Ao implementar o pedido, certifique-se de que inclui todos os parâmetros necessários, conforme listado acima, e valide se os valores corretos estão a ser passados antes de enviar dados de uma instância de produção. Aconselha-se a utilização de um parâmetro `i` único (identificador da aplicação) para desenvolvimento e teste.

 

PYTHON CURL HTTP JAVA

PYTHON

import requests

params = {
    'a': 'sdk_key_here',
    'p': 'Android',
    'i': 'com.singular.app',
    'ip': '10.1.2.3',
    've': '9.2',
    'ma': 'samsung',
    'mo': 'SM-G935F',
    'lc': 'en_US',
    'aifa': '8ecd7512-2864-440c-93f3-a3cabe62525b',
    'asid': 'edee92a2-7b2f-45f4-a509-840f170fc6d9',
    'install': 'true',
    'n': 'MyCoolAppName',
    'bd': 'Build/13D15',
    'app_v': '1.2.3',
    'openuri': 'myapp://home/page?queryparam1=value1',
    'ddl_enabled': 'true',
    'install_source': 'com.android.vending',
    'install_time': 1510040127,
    'update_time': 1510090877
}

response = requests.get('https://s2s.singular.net/api/v1/launch', params=params)
print(response.json())

 

Parâmetros opcionais

A tabela seguinte lista os parâmetros opcionais que este ponto final suporta. Todos os parâmetros listados são parâmetros de consulta.

Parâmetros opcionais
Parâmetros de carimbo de data/hora
Parâmetro Descrição
utime
int

O parâmetro utime especifica a hora da sessão em tempo UNIX de 10 dígitos.

 

Exemplo de valor:

1483228800
Parâmetro Descrição
umilisec
int

O parâmetro umilisec especifica o tempo da sessão em milissegundos, em hora UNIX de 13 dígitos.

 

Exemplo de valor:

1483228800000
Parâmetros do dispositivo e da rede
Parâmetro Descrição
global_properties
JSON URL-encoded string

O parâmetro global_properties aceita um objeto JSON codificado por URL que contém até 5 pares de valores chave. Cada chave e valor pode ter um comprimento máximo de 200 caracteres.

{"key1":"value1","key2":"value2"}

O objeto JSON tem de ser:

  • Convertido numa cadeia de caracteres JSON e codificado por URL

 

Exemplo de valor:

%7B%22key1%22%3A%22value1%22%2C%22key2%22%3A%22value2%22%7D
Parâmetro Descrição
use_ip
string

O parâmetro use_ip diz ao Singular para extrair o endereço IP da solicitação HTTP em vez do parâmetro 'ip'. Passe'true' para usar esse recurso.

  • O uso desse parâmetro impede que o Singular faça a geolocalização do dispositivo com base no endereço IP. Pode fornecer o código de duas letras do país do utilizador no parâmetro opcional 'country'.
  • Este parâmetro é mutuamente exclusivo do parâmetro "ip". NÃO o utilize com o parâmetro "ip".
  • Para evitar a rejeição de dados, é necessário fornecer o parâmetro "ip" ou o parâmetro "use_ip" no pedido.

 

Exemplo de valor:

true
Parâmetro Descrição
country
string

O parâmetro country deve conter o código de país de duas letras ISO 3166-1 alfa-2 do utilizador no momento da execução da sessão. Este parâmetro só é necessário quando:

  • O parâmetro "ip" não está disponível
  • Se o parâmetro "ip" estiver disponível, o país será automaticamente determinado a partir do endereço IP e o parâmetro "country" não é necessário.

 

Exemplo Valor:

US
Parâmetro Descrição
ua
URL-encoded string

O parâmetro ua especifica o User Agent (agente do utilizador) do dispositivo.

Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148

O valor tem de ser codificado por URL.

 

Exemplo de valor:

Mozilla%2F5.0%20(iPhone%3B%20CPU%20iPhone%20OS%2014_0%20like%20Mac%20OS%20X)%20AppleWebKit%2F605.1.15%20(KHTML%2C%20like%20Gecko)%20Mobile%2F15E148
Parâmetro Descrição
c

Plataformas suportadas:

  • iOS
  • Android
string

O parâmetro c especifica o tipo de ligação de rede"wifi" ou"carrier".

 

Exemplo de valor:

wifi
Parâmetro Descrição do parâmetro
cn

Plataformas suportadas:

  • iOS
  • Android
string

O parâmetro cn especifica o nome da Operadora do provedor de internet.

 

Exemplo de valor:

Comcast
Desinstalar o suporte de rastreio
Parâmetro Descrição
apns_token

Plataformas suportadas:

  • iOS
string

O parâmetro apns_token especifica o Token de Dispositivo do Serviço de Notificação Push da Apple (APNS).

    • Necessário para o rastreamento de desinstalação do iOS
    • Certifique-se de que passa o Token APNS como uma cadeia de caracteres codificada em hexadecimal
    • Como recuperar o Token APNS

 

Exemplo de valor:

b0adf7c9730763f88e1a048e28c68a9f806ed032fb522debff5bfba010a9b052
Parâmetro Descrição do parâmetro
fcm

Plataformas suportadas:

  • Android
string

O parâmetro fcm especifica o Token de dispositivo do Firebase Cloud Messaging.

  • Necessário para o rastreamento de desinstalação do Android
  • Como recuperar o token FCM
  • Em seguida, passe o token do dispositivo no parâmetro fcm ao relatar a sessão para o Singular, como no exemplo a seguir:

 

Exemplo Valor:

bk3RNwTe3H0CI2k_HHwgIpoDKCIZvvD...MExUdFQ3P1
Privacidade de dados
Parâmetro Descrição
data_sharing_options
JSON URL-encoded string

O parâmetro data_sharing_options especifica o consentimento do utilizador final para partilhar informações. Se for definido, este valor deve ser mantido e transmitido em todos os pedidos subsequentes de "SESSION" e "EVENT" para o utilizador.

  • Para indicar que o utilizador consentiu (optou por participar) na partilha das suas informações, passe "false":
    {"limit_data_sharing":false}
  • Se o utilizador recusou, passe "true":
    {"limit_data_sharing":true}

O valor tem de ser uma cadeia de caracteres JSON codificada por URL.

 

Exemplo de valor:

%7B%22limit_data_sharing%22%3Atrue%7D
Parâmetro Descrição do parâmetro
dnt

Plataformas suportadas:

  • Android
  • iOS
int

O parâmetro dnt especifica o estado do Do Not Track. Passa 1 se a opção "Do Not Track" estiver activada ou 0 se a opção "Do Not Track" estiver desactivada.

 

Exemplo de valor:
0
Parâmetro Descrição do parâmetro
dntoff

Plataformas suportadas:

  • iOS
  • Android
int

O parâmetro dntoff especifica se Do Not Track está desligado. Passe 0 se "não rastrear" estiver ativado ou 1 se "não rastrear" estiver desativado.

 

Exemplo de valor:
1
Suporte a vários dispositivos
Parâmetro Descrição
custom_user_id
string

O parâmetro custom_user_id especifica o seu ID de utilizador interno.

 

Exemplo de valor:

123456789abcd
Suporte iOS SkAdNetwork
Parâmetro Descrição
skan_conversion_value

Plataformas suportadas:

  • iOS
int

O parâmetro skan_conversion_value especifica o valor de conversão mais recente da SKAdNetwork no momento desta notificação de sessão(saiba mais sobre a implementação da SKAdNetwork).

 

Exemplo de valor:

7
Parâmetro Descrição do parâmetro
skan_first_call_timestamp

Plataformas suportadas:

  • iOS
int

O parâmetro skan_first_call_timestamp especifica o carimbo de data/hora Unix da primeira chamada à API SkAdNetwork subjacente(saiba mais sobre a implementação da SKAdNetwork).

 

Exemplo de valor:

1483228800
Parâmetro Descrição do parâmetro
skan_last_call_timestamp

Plataformas suportadas:

  • iOS
int

O parâmetro skan_last_call_timestamp especifica o carimbo de data/hora Unix da última chamada à API SkAdNetwork subjacente no momento desta notificação de sessão(saiba mais sobre a implementação da SKAdNetwork).

 

Exemplo de valor:

1483228800

Teste de sessão

Depois de fazer a integração servidor a servidor, é essencial verificar se a Singular recebe os dados antes de colocar em funcionamento uma instância do produto. Consulte o nosso guia de testes para obter mais detalhes. Em um nível alto, as seguintes etapas devem ser seguidas:

  1. Obtenha a ID de publicidade do seu dispositivo de teste e adicione a ID no Singular SDK Console.
  2. Abra o Singular SDK Console e adicione o identificador do dispositivo para iniciar a captura de dados.
  3. Substitua o identificador do aplicativo por um identificador de aplicativo de desenvolvimento(com.singular.app.dev) para manter os dados e eventos de teste separados dos dados de produção.
  4. Criar ou abrir a aplicação a partir de um estado terminado
  5. Valide se a abertura da aplicação é enviada para o seu servidor com todos os pontos de dados Singular necessários
  6. Valide se o seu servidor dispara a Notificação de Sessão para o ponto de extremidade Singular'launch' com todos os pontos de dados necessários.
  7. Após alguns segundos, o evento de sessão deve ser exibido no Console do SDK do Singular.
    s2s_session.png
  8. Repita o teste para validar se o App Open aciona a Session a partir de cada entrada de aplicativo ou operação "Foreground".
Verificações importantes

Confirme que o evento de sessão ocorre na abertura da aplicação ou em primeiro plano e antes de o evento ser recebido.

Se vir a Session na Consola SDK, concluiu um teste de ponta a ponta do tratamento da SESSION!