Чем мы можем помочь?

API списка приложений для владельцев приложений

  • Обновлено

Краткий обзор: Получение активных и ожидающих приложений, связанных с вашим аккаунтом AppsFlyer.

mceclip0.png

Если вы рекламная сеть, используйте API списка приложений для рекламных сетей.

Дополнительные материалы: Список API для рекламодателей

API для получения списка приложений

Следующие разделы содержат информацию, необходимую для использования API. 

Основные сведения о получении списка приложений

Основные сведения о списке API

Категория Элемент Description(Описание)
Запрос HTTP-метод УСТАНОВИТЬ
Путь https://hq1.appsflyer.com/api/mng/apps
Заголовок авторизации 
 Ответ Результаты Возвращает в формате JSON
Лимит запросов
  • 20 запросов/мин
  • 100 запросов/день
Лимит записей 1,000 записей/запрос. Если нужно вернуть более 1,000 записей, используйте последующие запросы с пагинацией, описанные в этой статье.

Запрос API

API-запрос состоит из метода, пути, обязательного параметра capabilities и необязательных параметров пагинации. Токен содержится в заголовке авторизации. 

Аудитории

GET https://hq1.appsflyer.com/api/mng/apps

Обязательные параметры для получения списка приложений:

Параметр запроса Description(Описание)
   Для этого API нет обязательных параметров запроса


Механизм пагинации

Механизм пагинации реализован и действует всегда. 

Принципы пагинации: 

  • Возвращает до 1,000 записей на запрос (страницу).
  • JSON-ответы содержат следующие ключи, связанные с пагинацией:
    • meta.total_items: количество записей, возвращаемых на всех страницах вместе. Это число приложений, для которых вам были предоставлены запрашиваемые capabilities .
    • Ссылки пагинации (показанные в JSON ниже) имеют следующие ключи:
      • links.prev: если был предыдущий запрос, то это запрос, использованный для формирования предыдущей страницы.
      • links.self: текущий запрос — запрос, использованный для формирования текущего JSON (страницы)
      • links.next: запрос, необходимый для получения следующей страницы. Если ключа next нет, это последняя страница. 

 Используйте один из следующих методов управления пагинацией:

  • [Практические рекомендации] Используйте links в JSON: если ключ links.next существует, используйте его, чтобы создать запрос для получения следующей страницы. Продолжайте, пока не получите JSON без ключа links.next key.
  • Программно реализуйте параметры limit и offset вместе с ключом total_items.

Пример JSON со ссылками пагинации

  • В примере ниже показан результат второго запроса, содержащий две записи в разделе data (не показано). 
  • Общее количество возвращаемых записей — 6.
  • Ключ links.next содержит запрос, который возвращает вторую страницу — записи 5 и 6. 
{                                                                                         
    "data": {[...]},   
    "meta": {
        "total_items": 6
    },
    "links": {
        "prev": "https://hq1.appsflyer.com/api/mng/apps?offset=0&limit=2",
        "self": "https://hq1.appsflyer.com/api/mng/apps?offset=2&limit=2",
        "next": "https://hq1.appsflyer.com/api/mng/apps?offset=4&limit=2"
    }
}

Параметры механизма пагинации (необязательные):

Параметр запроса Description(Описание)
ограничение

Количество записей, возвращаемых за один вызов

  • Maximum: 1,000
  • Если вы не отправляетеlimit, он автоматически устанавливается на 1,000.
  • Пример: limit=2
  • Обязательно: нет
offset

Первая запись, возвращаемая в этом вызове. Нумерация записей начинается с 0. 

  • Если вы не передаете offset, ему автоматически присваивается значение 0.
  • Пример: offset=2
  • Обязательно: нет

Ответ JSON

Ключ Description(Описание)
id ID приложения, например: id123456789, com.myapp.com
type Всегда возвращайте app 
Имя камп. ID приложения
platform iOS или Android
currency (валюта) Код валюты для приложения 
time_zone Часовой пояс приложения
total_items Количество приложений в аккаунте
ссылки

Механизм пагинации (описан в разделе параметров)

  • prev: вызов, используемый для генерации предыдущей страницы
  • self: вызов, используемый для генерации текущей страницы
  • next: вызов, используемый для генерации следующей страницы

Пример cURL-запроса для получения списка приложений и ответ

Запрос cURL

В этом примере приведен полный вызов, включая необязательные параметры пагинации. 

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

Ответ 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.def.app",
            "type": "app",
            "attributes": {
                "name": "com.def.app",
                "platform": "android",
                "currency": "JPY",
                "time_zone": "UTC"
            }
        }
    ],
    "meta": {
        "total_items": 6
    },
    "links": {
        "self": "https://hq1.appsflyer.com/api/mng/apps?offset=0&limit=1000"
           }
}

Коды ответа HTTP

Код  Сообщение Примечания/устранение неполадок
200 OK Возвращаются действительные данные
200 OK

Симптом: данные не возвращаются

Действие: убедитесь, что токен аутентификации указан в заголовке Bearer.

400 Неверный запрос См. сообщение, содержащееся в JSON
401 Не авторизовано

Сообщение: токен авторизации имеет неверный формат

Убедитесь, что у вас правильный токен; токен должен содержать не менее 700 символов.

404 Не найдено
  • Устраните все проблемы, связанные с сетью или брандмауэром. 
  • Убедитесь, что IP-адреса AppsFlyer внесены в список разрешённых
  • Убедитесь, что вы используете последний выданный токен.
  • Данные не найдены: приложения не найдены. 
429 Слишком много запросов Превышено ограничение скорости запросов