Категории рекламных программ¶

Параметры¶

HTTP метод	Права доступа	URL	Параметры	Примечание
GET	public_data	`https://api.admitad.com/categories/`	offset limit campaign* language order_by***	Возвращает список категорий рекламных программ.*
GET	public_data	`https://api.admitad.com/categories/advcampaign/{id}`/	offset limit language* order_by***	Возвращает список категорий рекламной программы, где id - это идентификатор рекламной программы.*
GET	public_data	`https://api.admitad.com/categories/{id}/`	language****	Возвращает категорию рекламной программы, где id - это идентификатор категории.*

* Возвращает результат в формате JSON.

** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2.

*** Фильтр по рекламным программам. Например campaign=3&campaign=4, где значения - это идентификаторы рекламных программ.

**** Язык ответа. Например language=de, где значения - это двухбуквенный код.

***** Порядок сортировки. Возможные значения:

name

Знак ‘-‘ перед значением означает обратный порядок. Например order_by=-name.

Пример использования¶

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/categories/

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/categories/12/

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/categories/advcampaign/6/

Пример ответа API-сервера в формате JSON:

{
    "results": [
        {
            "name": "Browser",
            "language": "en",
            "parent": {
                "name": "Online Games",
                "language": "en",
                "parent": null,
                "id": 2
            },
            "id": 3
        },
        {
            "name": "Other",
            "language": "en",
            "parent": null,
            "id": 5
        },
        {
            "name": "Client",
            "language": "en",
            "parent": {
                "name": "Online Games",
                "language": "en",
                "parent": null,
                "id": 2
            },
            "id": 4
        }
    ],
    "_meta": {
        "count": 11,
        "limit": 3,
        "offset": 0
    }
}

Описание полей ответа API-сервера¶

Название	Описание
id	Идентификатор категории
name	Название категории
language	Язык ответа
parent	Идентификатор родительской категории