API de eventos de servidor para servidor

Introdução

Esta API permite que você envie eventos que ocorrem dentro ou fora do aplicativo móvel, mas que não são enviados através do SDK da AppsFlyer. Por exemplo, se você tiver uma interface móvel e na web, você pode gravar todos os eventos de ambos os meios na AppsFlyer.

É importante prestar atenção extra para que a ID do aplicativo no iOS contenha a "id" principal antes da ID, caso contrário, a solicitação termina com HTTPS 200 OK, mas o evento não é registrado.

Método: POST

Cabeçalho – "autenticação"= {dev-key}

A chave do desenvolvedor é encontrada no Painel >> Configurações do aplicativo >> Chave do desenvolvedor

{
  "appsflyer_id": {AppsFlyer Device ID }, // e.g. 1415211453000-6513894
  "idfa":{idfa},
  "customer_user_id": {customer_user_id}, // Customer User ID optional parameter
  "eventName": {The event name}, // e.g. "af_purchase"
  "eventValue": {A JSON containing a rich in-app event value - must be stringfied},
  "{

    \"af_revenue\":\"6\",
    \"af_content_type\":\"wallets\",
    \"af_content_id\":\"15854\"

  }",
  "eventCurrency": {Event currency}, // e.g "USD"
  "ip": {device IP},
  "eventTime": {Event timestamp in UTC +0}, // e.g "2014-05-15 12:17:00.000"
  "af_events_api" :"true"
}

{
	"appsflyer_id": {AppsFlyer Device id}, // e.g. 1415211453000-6513894 
	"advertising_id": {advertising_id},
	"customer_user_id": {customer_user_id}, // Customer User ID optional parameter ---
	"eventName": {The event name}, // e.g "af_purchase
	"eventValue": {A JSON containing a rich in-app event value - must be stringified} 
	"{	
		\"af_revenue\":\"6\",
		\"af_content_type\":\"wallets\",
		\"af_content_id\":\"15854\"
	}"

	"eventCurrency": {Event currency}, // e.g "USD"
	"ip": {device IP},
	"eventTime": {Event timestamp in UTC +0}, // e.g "2014-05-15 12:17:00.000"
	"af_events_api" :"true"
}

Parâmetros

1. Parâmetros obrigatórios: appsflyer_id (AppsFlyer Device id), eventName, eventValue e af_events_api
2. Parâmetros altamente recomendados: idfa para iOS e advertising_id para Android.
   Se você quiser mapear seus eventos in-app de usuários orgânicos com parceiros externos, esses parâmetros são OBRIGATÓRIOS. Além disso, alguns recursos, como Públicos, contam com a ID do dispositivo para segmentar seus usuários e atualizar as redes.
3. Opcional – eventValue pode ser com um valor vazio, ou seja, "eventValue":"", (nenhum espaço é necessário)
4. Opcional – O endereço IP (ip) deve ser o IP do dispositivo móvel (durante a ocorrência do evento)
5. Opcional – O campo ID de usuário do cliente (customer_user_id) é um parâmetro identificador de usuário, mapeado para o campo ID de usuário do cliente nos relatórios brutos. A API do SDK do ID de usuário do cliente anexa esse valor automaticamente a todos os eventos in-app com origem no SDK. Certifique-se de incluir esse campo em TODOS os seus eventos S2S para desfrutar da mesma funcionalidade.

Preparação de dados para parâmetros

A lógica do back-end é necessária para obter certos valores para os parâmetros mencionados acima. Confira abaixo o fluxo recomendado para obter esses valores:

Mapeamento da ID da AppsFlyer com a ID de usuário cliente

A ID da AppsFlyer é um parâmetro obrigatório ao enviar eventos in-app de servidor para servidor. Para facilitar que você saiba qual usuário executou qual evento, implemente o fluxo abaixo:

1. Defina a ID de usuário cliente quando o usuário instalar o aplicativo.
2. Baixe o relatório de dados brutos de instalações por meio dos dados de exportação ou da API de pull
3. Obtenha o ID da AppsFlyer combinando o ID de usuário cliente em seus sistemas internos com o ID de usuário cliente no relatório de dados brutos.
   Observação: você pode obter o ID da AppsFlyer de seus usuários do SDK da AppsFlyer integrado em seus aplicativos (Android/iOS)
4. Mapeie a ID da AppsFlyer para a ID de usuário cliente em seu sistema interno (importante para uso futuro)

Após mapear a ID da AppsFlyer com sua ID de usuário cliente interna, você pode facilmente saber qual usuário executou qual evento. Você pode então obter a ID da AppsFlyer e outros valores (valor do evento, moeda do evento, hora do evento etc.) e enviar o evento in-app de servidor para servidor.

Cronometrar os eventos

Eventos de servidor para servidor podem ser enviados em tempo real ou com um carimbo de data hora do evento.

Você pode usar o parâmetro opcional eventTime para especificar a hora da ocorrência do evento (no fuso horário UTC +0). Se o parâmetro não for incluído na mensagem, o AppsFlyer usa o carimbo de data e hora da mensagem HTTPS recebida.

O formato de eventTime é: "aaaa-MM-dd HH:mm:ss.SSS" (por exemplo, "2014-05-15 12:17:00.000")

Ao enviar eventos com carimbos de data e hora, e para que esses eventos sejam registrados com seus carimbos em tempo real (quando realmente ocorreram), todos eles devem ser enviados para a AppsFlyer até as 2 h (UTC+0) do dia seguinte.

Eventos com carimbos de data e hora anteriores, os quais não são enviados até as 2 horas são registrados com a hora em que são enviados.

Eventos de tempo: linha do tempo visual

Códigos de retorno de serviço

200

OK quando a solicitação foi processada pelo sistema da Appsflyer.

401

não autorizado quando a chave fornecida no cabeçalho de autenticação não é a chave de desenvolvedor para esse aplicativo.

400

Solicitação incorreta quando a solicitação falhou em pelo menos um dos critérios de validação

500

Erro interno do servidor indica um erro no servidor

Se seus servidores forem protegidos por um firewall, você precisará fazer uma lista de respostas seguras recebidas dos intervalos de endereço IP da AWS para receber as mensagens de retorno.

Exemplo de corpo de solicitação

{
  "appsflyer_id": "1415211453000-6513894",
	"advertising_id": "38412345-8cf0-aa78-b23e-10b96e40000d",
	"eventName": "af_purchase",
	"eventValue": 
	"{
		\"af_revenue\": \"6\",
		\"af_content_type\": \"wallets\",
		\"af_content_id\": \"15854\",
		\"af_quantity\" :\"1\"
   }",
	"eventCurrency": "USD",
	"ip": "1.2.3.4",
	"eventTime": "2014-05-15 12:17:00.000",
	"af_events_api" :"true"
}

Neste caso, o AppsFlyer recebe um evento no aplicativo S2S que representa um evento de compra com receita, bem como propriedades adicionais, tais como tipo de conteúdo, etc.

Casos especiais

{
  "appsflyer_id": "1415211453000-6513894",
	"advertising_id": "38412345-8cf0-aa78-b23e-10b96e40000d",
	"eventName": "cancel_purchase",
	"eventValue": 
	"{
		\"af_revenue\": \"-6\",
		\"af_content_type\": \"wallets\",
		\"af_content_id\": \"15854\",
		\"af_quantity\" :\"1\"
   }",
	"eventCurrency": "USD",
	"ip": "1.2.3.4",
	"eventTime": "2014-05-15 12:17:00.000",
	"af_events_api" :"true"
}

Em seguida, o AppsFlyer é capaz, de acordo com a configuração do anunciante, de enviar esses eventos avançados no aplicativo para fontes de mídia para fins de direcionamento avançado, otimização e criação de público.

Buscar a ID do dispositivo AppsFlyer

appsflyer_id é um parâmetro obrigatório em mensagens de evento de servidor para servidor. O AppsFlyer usa esse parâmetro para atribuir o evento ao dispositivo original e à fonte de mídia atribuída.

Existem várias maneiras de obter essa ID.

1. A partir do dispositivo móvel usando a API do SDK da AppsFlyer (Android / iOS)
2. Por meio das APIs Pull ou Push (clique no link para obter mais informações sobre a API Push ou a API Pull)
3. Exportar o relatório deinstalação de dados brutos

Diferença entre orgânico e não orgânico

Ao enviar eventos in-app S2S, a AppsFlyer automaticamente associa dados adicionais aos eventos. Os dados adicionais vêm do evento de instalação que precede os eventos in-app. 

O que isso significa é que alguns dados que a AppsFlyer associa a eventos in-app S2S não orgânicos não estão associados a eventos in-app S2S orgânicos.