Estamos sempre publicando atualizações em nossa documentação, mas pode ser que elas ainda não estejam disponíveis em seu idioma. Para ter acesso às informações mais atualizadas, use a ​​versão em inglês.

API de mapeamento do SKAN versão 3

O endpoint de mapeamento retorna informações sobre o mapeamento de valores de conversão de um anunciante. Os parceiros de rede podem obter essas informações a qualquer momento fazendo a requisição GET ao endpoint.

Endpoint

https://app.adjust.com/skadnetwork/{sk_network_token}/mapping/{app_store_id}

Requisição GET

Retorna informações de mapeamento como objeto JSON. Cada requisição GET deve conter os seguintes parâmetros.

ParâmetroTipo de dadosEmDescrição
sk_network_token*StringCaminhoToken específico do parceiro atribuído pela Adjust.

Exemplo: abcdefklmn
app_store_id*StringCaminhoO ID da App Store do app.

Exemplo: 1125517808

Resposta

O endpoint de mapeamento retorna um objeto JSON contendo metadados relacionados ao app e array dos valores de conversão mapeados. Cada valor é descrito separadamente.

{
   "app_store_id":"1125517808",
   "updated_at":1617234177,
   "cut_off_period":1,
   "reporting_currency":"USD",
   "conversion_values":[
      {
         "conversion_value":7,
         "events":[
            "..."
         ]
      },
      {
         "conversion_value":10,
         "events":[
            "..."
         ]
      },
      {
         "conversion_value":12,
         "events":[
            "..."
         ]
      }
   ]
}

Parâmetros de metadados de resposta

CampoTipo de dadosDescrição
app_store_idStringO ID da App Store do app. Corresponde ao parâmetro app_store_id enviado na requisição.
updated_atNúmeroO registro de data e hora Unix da última alteração do mapeamento visível ao parceiro que está fazendo a requisição.
cut_off_periodNúmeroA configuração do corte dos valores de conversão do app. Valor é exibido em horas.
reporting_currencyStringO código de moeda ISO 4217 da moeda de relatório do app. Aplica-se a todos os valores de receita definidos no esquema de mapeamento.

Campos de valores de conversão de resposta

Observação:
O endpoint de mapeamento retorna informações de mapeamento para valores de conversão que tem pelo menos um evento de parceiro após as configurações de compartilhamento e o linking de eventos terem sido aplicados. Confira em Comportamento da API para mais informações.

O endpoint de mapeamento retorna um detalhamento de cada valor de conversão mapeado e seus detalhes associados.

{
   "app_store_id":"1125517808",
   "updated_at":1617234177,
   "cut_off_period":1,
   "reporting_currency":"USD",
   "conversion_values":[
      {
         "conversion_value":12,
         "events":[
            {
               "event_name": "Purchase",
               "count_min": 3,
               "count_max": 10,
               "revenue_min": 3.000,
               "revenue_max": 10.000
            },
            { "event_name": "Registration" }
         ]
      }
   ]
}

A contagem de eventos e os intervalos de receita são parâmetros opcionais que são retornados dependendo de como o anunciante configurou o acesso do parceiro. Os seguintes detalhes podem ser mapeados:

  • Sessão
  • Contagem de sessões
  • Evento
  • Contagem de eventos
  • Receita de eventos
  • IAP
  • Receita de anúncios
  • Receita total
Observação:
Para ver as informações sobre receita, os anunciantes devem habilitar o compartilhamento de receita com o parceiro que está fazendo a requisição.

Os parâmetros de contagem e intervalo de receita são todos opcionais como definido a seguir:

ParâmetroTipo de dadosValor padrãoDescrição
count_minNúmero1O evento ou sessão foi gravado não menos que o número de vezes especificado.
count_maxNúmeroIlimitadoO evento ou sessão foi gravado não mais que o número de vezes especificado.
revenue_minNúmero0A receita total foi de pelo menos o valor especificado. Os valores são medidos na reporting_currencyou moeda do relatório do app.
revenue_maxNúmeroIlimitadoA receita total não excedeu o valor especificado. Os valores são medidos na reporting_currencyou moeda do relatório do app.

Exemplo de resposta completa

{
   "app_store_id":"1125517808",
   "updated_at":1617234177,
   "cut_off_period":1,
   "reporting_currency":"USD",
   "conversion_values":[
      {
         "conversion_value":7,
         "events":[
            {
               "event_name":"Registration"
            }
         ]
      },
      {
         "conversion_value":10,
         "events":[
            {
               "event_name":"TutorialComplete"
            }
         ]
      },
      {
         "conversion_value":12,
         "events":[
            {
               "event_name":"Purchase",
               "count_min":3,
               "count_max":10,
               "revenue_min":3.00,
               "revenue_max":10.00
            },
            {
               "event_name":"Registration"
            }
         ]
      }
   ]
}

Códigos de erro de reposta

Código de erroDescrição
400 Bad RequestO ID da Store está faltando ou não está formatado corretamente.
401 UnauthorizedO token de rede está faltando ou não foi reconhecido.
403 ForbiddenO app foi reconhecido, mas os requisitos de compartilhamento de parceiro não foram atendidos para o app solicitado.
404 Not FoundO app solicitado não foi encontrado ou não está verificado para o SKAdNetwork.
422 Unprocessable EntityO app solicitado foi reconhecido e verificado pela Adjust, mas a funcionalidade de gerenciamento de valores de conversão não foi ativada para o app.
429 Too Many RequestsAs solicitações são limitadas por parceiro/app. A Adjust recomenda obter atualizações uma vez ao dia.