How can we help?

API de lista de aplicativos para ad networks

  • Atualizado

Em resumo: As ad networks podem recuperar metadados dos aplicativos associados à conta de parceiro integrada.

API para obter a lista de aplicativos

As seções a seguir incluem as informações necessárias para usar a API.

Get app list basics

Categoria Item A descrição
Solicitação Método HTTP BAIXAR
Caminho https://hq1.appsflyer.com/api/mng/apps
Cabeçalho de autorização 
 Tempo de Resultados Retorno em JSON
Limite de solicitação
  • 20 solicitações/minuto
  • 100 solicitações/dia
Limite de registros 1,000 registros/solicitação. Se for necessário retornar mais de 1,000 registros, use solicitações de paginação subsequentes, descritas neste artigo.

Solicitação de API

A solicitação da API consiste no método, no caminho, no parâmetro obrigatório capabilities e nos parâmetros opcionais de paginação. O token está contido no cabeçalho de autorização. 

Mensuração

GET https://hq1.appsflyer.com/api/mng/apps?capabilities={capabilities} 

Parâmetros obrigatórios para obter a lista de aplicativos

Parâmetro de consulta A descrição
capacidades

Para obter a lista e o número de aplicativos para os quais você tem permissões/recursos de integração, defina o parâmetro capabilities como uma das opções listadas. 

Opção Tipo de valor esperado A descrição
protect_360 Permissão de relatório Obter relatórios de dados brutos do Protect360 para ad networks
cost  integração O aplicativo está habilitado para obter dados de custo pela API InCost

Exemplo: lista de aplicativos para os quais você tem permissão da API de relatórios de dados brutos do Protect360:capabilities=protect_360

Mecanismo de paginação

Um mecanismo de paginação, sempre operacional, é implementado. 

Princípios de paginação: 

  • Retorna até 1.000 registros por solicitação (página).
  • Os JSONs de resposta contêm as seguintes chaves relacionadas à paginação:
    • meta.total_items: O número de registros a serem retornados por todas as páginas combinadas. Isso representa o número de aplicativos para os quais você recebeu as capacidades consultadas.
    • Os links de paginação (mostrados no JSON a seguir) têm as seguintes chaves:
      • links.prev: Se houve uma solicitação anterior: a solicitação usada para gerar a página anterior.
      • links.self: A solicitação atual: a solicitação usada para gerar o JSON atual (página)
      • links.next: A solicitação necessária para obter a próxima página. Se não houver a próxima chave, esta é a última página. 

 Use um dos seguintes métodos de controle de paginação:

  • [Melhores práticas] Use os links no JSON: se a chave links.next existir, use-a para criar uma solicitação para obter a próxima página. Continue fazendo isso até receber um JSON sem uma chave links.next.
  • Implemente programaticamente os parâmetros limit e offset em conjunto com a chave total_items.

Exemplo de JSON de links de paginação

  • O exemplo a seguir contém o resultado da primeira solicitação, consistindo na resposta à segunda solicitação, que contém dois registros na seção de dados (não exibida). 
  • O número total de registros a serem retornados é 6.
  • A chave links.next contém a solicitação que retorna a próxima página — registros 5 e 6. 
{                                                                                         
    "data": {[...]},   
    "meta": {
        "total_items": 6
    },
    "links": {
        "prev": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=0&limit=2",
        "self": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=2&limit=2",
        "next": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=4&limit=2"
    }
}

Parâmetros do mecanismo de paginação (opcional)

Parâmetro de consulta Visão geral
limit

Número de registros retornados por chamada

  • Máximo: 1.000
  • Se você não enviarlimit, ele será definido automaticamente como 1.000.
  • Exemplo: limit=2
  • Obrigatoriedade: Não
offset

O primeiro registro a ser retornado na chamada. Os números dos registros começam em 0. 

  • Se você não enviar offset, ele será automaticamente definido como 0.
  • Exemplo: offset=2
  • Obrigatoriedade: Não
 

Resposta JSON

Chave Visão geral
id ID do aplicativo, por exemplo: id123456789, com.myapp.com
Tipo Sempre retornar app 
coluna Nome do aplicativo
plataforma as integrações de SDK do iOS e Android
símbolos monetários Código de moeda específico do aplicativo, conforme definido pelo anunciante
time_zone Fuso horário específico do aplicativo, conforme definido pelo anunciante
total_items Número de aplicativos para os quais a ad network tem a opção de recursos solicitados
links

Mecanismo de paginação (explicado na seção de parâmetros)

  • prev: a chamada usada para gerar a página anterior
  • self: a chamada usada para gerar a página atual
  • next: a chamada usada para gerar a próxima página

Exemplo de curl e resposta para obter a lista de aplicativos

Solicitação Curl

Este exemplo inclui uma chamada completa, inclusive parâmetros de paginação opcionais. 


curl --location --request GET 'https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&limit=1000&offset=0' \
-H 'Authorization: Bearer {API V2.0 token available to the admin in the dashboard.}' 

Resposta JSON

{
    "data": [
        {
            "id": "com.appsflyer.xpend_qa1",
            "type": "app",
            "attributes": {
                "name": "com.appsflyer.xpend_qa1",
                "platform": "android",
                "currency": "USD",
                "time_zone": "UTC"
            }
        },
        {
            "id": "com.abc.app",
            "type": "app",
            "attributes": {
                "name": "com.abc.app",
                "platform": "android",
                "currency": "USD",
                "time_zone": "UTC",
                "enable_retargetting": true
            }
        },
        {
            "id": "com.xyz.app",
            "type": "app",
            "attributes": {
                "name": "com.xyz.app",
                "platform": "android",
                "currency": "JPY",
                "time_zone": "UTC"
            }
        }
    ],
    "meta": {
        "total_items": 3
    },
    "links": {
        "self": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=0&limit=1000"
           }
}

Códigos de resposta HTTP

Código  Mensagem Observações/solução de problemas
200 OK Dados válidos retornados
200 OK

Sintoma: Nenhum dado é retornado

Ação: Certifique-se de que o token de autenticação esteja no cabeçalho Bearer.

400 Pedido incorreto
  • Veja a mensagem contida no JSON
  • JSON vazio: funcionalidade especificada ilegal
401 Não autorizado

Mensagem: O token de autorização está malformado

Certifique-se de que você tem o token correto; o token deve ter mais de 700 caracteres.

404 Não encontrado
  • Resolva quaisquer problemas relacionados à network ou ao firewall. 
  • Certifique-se de que os endereços IP da AppsFlyer estejam na lista de permissões
  • Certifique-se de usar o token emitido mais recentemente.
  • Nenhum dado encontrado: o tipo de permissão/integração (recursos) solicitado é válido, mas nenhum aplicativo com permissão foi encontrado. 
429 Pedidos em excesso Limite de taxa de requisições excedido

This article was translated using AI and may contain errors. For the most accurate information, please refer to the English version using the language selector.


Share article: