API de mapeamento do SKAN versão 4

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.

Importante:

Se o app de destino não está configurado para usar a versão 4 do SKAdNetwork, o endpoint retorna ao esquema de mapeamento da versão 3.Confira a documentação do endpoint de mapeamento do SKAN versão 3.

Endpoint

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

Requisição GET

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

Parâmetro	Tipo de dados	Em	Descrição
`sk_network_token`*	String	Caminho	Token específico do parceiro atribuído pela Adjust. Por exemplo: `abcdefklmn`
`app_store_id`*	String	Caminho	O ID da App Store do app. Por exemplo: `1125517808`

Resposta

O endpoint de mapeamento retorna um array de três objetos JSON correspondentes aos três postbacks enviados pelo SKAdNetwork versão 4.Cada objeto é identificado pelo seu correspondente conversion_window.

O endpoint retorna ambas informações de mapeamento fino e bruto para o primeiro postback apenas. O segundo e o terceiro postbacks contém informações de mapeamento bruto .

[
   {
      "data": {
         "fine": [{}],
         "coarse": [{}],
         "settings": {},
      },
      "conversion_window": 1
   },
   {
      "data": {
         "coarse": [{}],
         "settings": {},
      },
      "conversion_window": 2
   }
   {
      "data": {
         "coarse": [{}],
         "settings": {},
      },
      "conversion_window": 3
   }
]

Campos de valores de conversão finos

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.

[
   {
      "data": {
         "fine": [
            {
               "conversion_value":12,
               "events":[
                  {
                     "event_name":"Purchase",
                     "count_min":3,
                     "count_max":10,
                     "revenue_min":3.00,
                     "revenue_max":10.00
                  },
                  {
                     "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âmetro	Tipo de dados	Valor padrão	Descrição
`count_min`	Número	`1`	O evento ou sessão foi gravado não menos que o número de vezes especificado.
`count_max`	Número	Ilimitado	O evento ou sessão foi gravado não mais que o número de vezes especificado.
`revenue_min`	Número	`0`	A receita total foi de pelo menos o valor especificado. Os valores são medidos na `reporting_currency`ou moeda do relatório do app.
`revenue_max`	Número	Ilimitado	A receita total não excedeu o valor especificado. Os valores são medidos na `reporting_currency`ou moeda do relatório do app.

Campos de valores de conversão brutos

Os valores de conversão brutos são usados quando o volume de conversões não é alto o suficiente para atender ao limite de privacidade para fornecer um valor de conversão fino. O CV bruto pode ser baixo, médio ou alto, que age como buckets agregados para valores de CV pré-definidos.

[
   {
      "data": {
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ]
      }
   }
]

Parâmetro	Tipo de dados	Valor padrão	Descrição
`coarse_conversion_value`	String	Indefinido	O nível do valor de conversão bruto. Pode ser um de: `"baixo"` `"médio"` `"alto"`
`event_name`	String	null ou Nulo	O nome do evento mapeado.
`count_min`	Número	`1`	O evento foi gravado não menos do que número de vezes especificado.
`count_max`	Número	Ilimitado	O evento foi gravado não mais do que o número de vezes especificado.
`revenue_min`	Número	`0`	A receita total registrada para um evento foi pelo menos o valor especificado. Os valores são medidos na `reporting_currency`(moeda do relatório do app).
`revenue_max`	Número	Ilimitado	A receita total registrada para um evento não excedeu o total especificado. Os valores são medidos na `reporting_currency`(moeda do relatório do app).

Campos de configurações de resposta

[
   {
      "data": {
         "settings": {
            "lock_window": {
               "time_in_hours": 24
            },
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      }
   }
]

Campo	Tipo de dados	Descrição
`app_store_id`	String	O ID da App Store do app. Corresponde ao parâmetro `app_store_id` enviado na requisição.
`updated_at`	Número	O registro de data e hora Unix da última alteração do mapeamento visível ao parceiro que está fazendo a requisição.
`lock_window`	Objeto	Configurações relacionadas ao Lock window.
`time_in_hours`	Número	A duração do lock window em horas.
`reporting_currency`	String	O 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.

Exemplo de resposta completa

[
   {
      "data": {
         "fine": [
            {
               "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"
                  }
               ]
            }
         ],
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ],
         "settings": {
            "lock_window": {
               "time_in_hours": 24
            },
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      },
      "conversion_window": 1
   },
   {
      "data": {
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ],
         "settings": {
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      },
      "conversion_window": 2
   },
   {
      "data": {
         "coarse": [
            {
               "coarse_conversion_value": "low",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0,
                     "revenue_max": 0.5
                  }
               ]
            },
            {
               "coarse_conversion_value": "medium",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 0.5,
                     "revenue_max": 1.0
                  }
               ]
            },
            {
               "coarse_conversion_value": "high",
               "events": [
                  {
                     "event_name": "PURCHASE",
                     "revenue_min": 1.0,
                     "revenue_max": 50
                  }
               ]
            }
         ],
         "settings": {
            "app_store_id":"1125517808",
            "updated_at":1617234177,
            "reporting_currency":"USD",
         }
      },
      "conversion_window": 3
   }
]

Códigos de erro de reposta

Código de erro	Descrição
400 Bad Request	O ID da Store está faltando ou não está formatado corretamente.
401 Unauthorized	O token de rede está faltando ou não foi reconhecido.
403 Forbidden	O app foi reconhecido, mas os requisitos de compartilhamento de parceiro não foram atendidos para o app solicitado.
404 Not Found	O app solicitado não foi encontrado ou não está verificado para o SKAdNetwork.
422 Unprocessable Entity	O 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 Requests	As solicitações são limitadas por parceiro/app. A Adjust recomenda obter atualizações uma vez ao dia.