# Retag
# Доступные уровни программ для площадки <span id="alailable-levels-for-ad-spaces" />

## Параметры <span id="available-levels-parameters" />

| HTTP- метод | Права доступа                                                                                   | URL                                                         | Параметры | Примечание                                                       |
| ----------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | --------- | ---------------------------------------------------------------- |
| GET         | [webmaster\_retag](/article/ru/308#webmaster-retag) | https://api.admitad.com/retag/website/{website\_id}/levels/ | limit\*   | Возвращает список уровней программ для установки ReTag для сайта |
|             |                                                                                                 |                                                             | offset\*  |                                                                  |

\* Задаёт пропуск и количество возвращаемых записей. Например, [limit\=5\&offset\=2](/article/ru/310)

## Пример использования <span id="available-levels-example" />

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

```
curl -L -H 'Authorization: Bearer access_token' -X GET  
https://api.admitad.com/retag/website/22/levels/
```

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

```
{  
    "_meta": {  
        "count": 5,  
        "limit": 20,  
        "offset": 0  
    },  
    "results": [  
        {  
            "advcampaign": {  
                "id": 6,  
                "name": "AdvCamp 1"  
            },  
            "id": 78,  
            "level": "Level 1. Main page"  
        },  
        {  
            "advcampaign": {  
                "id": 6,  
                "name": "AdvCamp 1"  
            },  
            "id": 81,  
            "level": "Level 2. Categories page"  
        },  
        {  
            "advcampaign": {  
                "id": 6,  
                "name": "AdvCamp 1"  
            },  
            "id": 82,  
            "level": "Level 3. Product page"  
        },  
        {  
            "advcampaign": {  
                "id": 6,  
                "name": "AdvCamp 1"  
            },  
            "id": 83,  
            "level": "Level 5. Page \"Thank you\""  
        },  
        {  
            "advcampaign": {  
                "id": 8,  
                "name": "AdvCamp 3"  
            },  
            "id": 84,  
            "level": "Level 1. Main page"  
        }  
    ]  
}
```

[Описание полей ответа API-сервера](#availible-program-api-description)

# Доступные уровни программы <span id="available-program-levels" />

## Параметры <span id="availible-program-parameters" />

| HTTP- метод | Права доступа                                                                                   | URL                                                                 | Параметры | Примечание                                              |
| ----------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | --------- | ------------------------------------------------------- |
| GET         | [webmaster\_retag](/article/ru/308#webmaster-retag) | https://api.admitad.com/retag/advcampaign/{advcampaign\_id}/levels/ | limit\*   | Возвращает список уровней программы для установки ReTag |
|             |                                                                                                 |                                                                     | offset\*  |                                                         |

\* Задаёт пропуск и количество возвращаемых записей. Например, [limit\=5\&offset\=2](/article/ru/310)

## Пример использования <span id="availible-program-example" />

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

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

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

```
{  
    "_meta": {  
        "count": 4,  
        "limit": 20,  
        "offset": 0  
    },  
    "results": [  
        {  
            "advcampaign": {  
                "id": 6,  
                "name": "AdvCamp 1"  
            },  
            "id": 78,  
            "level": "Level 1. Main page"  
        },  
        {  
            "advcampaign": {  
                "id": 6,  
                "name": "AdvCamp 1"  
            },  
            "id": 81,  
            "level": "Level 2. Categories page"  
        },  
        {  
            "advcampaign": {  
                "id": 6,  
                "name": "AdvCamp 1"  
            },  
            "id": 82,  
            "level": "Level 3. Product page"  
        },  
        {  
            "advcampaign": {  
                "id": 6,  
                "name": "AdvCamp 1"  
            },  
            "id": 83,  
            "level": "Level 5. Page \"Thank you\""  
        }  
    ]  
}
```

## Описание полей ответа API-сервера <span id="availible-program-api-description" />

| Название    | Описание                                                      |
| ----------- | ------------------------------------------------------------- |
| id          | Идентификатор уровня (уникальный для уровня каждой программы) |
| name        | Название уровня                                               |
| advcampaign | Информация о программе                                        |

# Список тегов retag <span id="list-retag-tags" />

## Параметры <span id="retag-tags-parameters" />

| HTTP метод | Права доступа                                                                                      | URL                                 | Параметры      | Примечание                                                    |
| ---------- | -------------------------------------------------------------------------------------------------- | ----------------------------------- | -------------- | ------------------------------------------------------------- |
| GET        | [webmaster\_retag](/article/ru/308#webmaster-retag) | https://api.admitad.com/retag/      | limit\*\*      | Возвращает список кодов оптимизации\*                         |
|            |                                                                                                    |                                     | offset\*\*     |                                                               |
|            |                                                                                                    |                                     | website\*\*\*  |                                                               |
|            |                                                                                                    |                                     | active\*\*\*\* |                                                               |
| GET        | [webmaster\_retag](/article/ru/308#webmaster-retag)    | https://api.admitad.com/retag/{id}/ |                | Возвращает код оптимизации, где id — это идентификатор кода\* |

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

\*\* Задаёт пропуск и количество возвращаемых записей. Например, [limit\=5\&offset\=2](/article/ru/310)

\*\*\* Фильтр площадкам веб-мастера. Например, \&website\=12, где значение — это идентификатор площадки.

\*\*\*\* Фильтр по активным / не активным ретаг кодам. Например, \&active\=0, только не активные \&active\=1, только активные.

## Пример использования <span id="retag-tags-example" />

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

```
curl -L -H 'Authorization: Bearer access_token' -X GET  
https://api.admitad.com/retag/?limit=2  

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

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

```
{  
    "_meta": {  
        "count": 8,  
        "limit": 2,  
        "offset": 0  
    },  
    "results": [  
        {  
            "active": false,  
            "comment": "Test",  
            "id": 11,  
            "level": {  
                "campaign": {  
                    "id": 6,  
                    "name": "AdvCamp 1"  
                },  
                "id": 78,  
                "name": "Level 1. Main page"  
            },  
            "script": "<script>console.log('test script')</script>",  
            "status": 1,  
            "website": {  
                "id": 22,  
                "name": "site1_of_webmaster1"  
            }  
        },  
        {  
            "active": true,  
            "comment": "Test script #2",  
            "id": 15,  
            "level": {  
                "campaign": {  
                    "id": 6,  
                    "name": "AdvCamp 1"  
                },  
                "id": 78,  
                "name": "Level 1. Main pageа"  
            },  
            "script": "<script>console.log(\"loaded\")</script>",  
            "status": 2,  
            "website": {  
                "id": 22,  
                "name": "site1_of_webmaster1"  
            }  
        }  
    ]  
}
```

## Описание полей ответа API-сервера <span id="retag-tags-api-description" />

| Название | Описание                                                                                                                      |
| -------- | ----------------------------------------------------------------------------------------------------------------------------- |
| id       | Идентификатор тега                                                                                                            |
| website  | Площадка тега                                                                                                                 |
| comment  | Комментарий к тегу                                                                                                            |
| level    | [Уровень программы](#available-program-levels)                                                                                |
| script   | Тег                                                                                                                           |
| active   | Состояние активации (true — активен, false — не активен)                                                                      |
| status   | Состояние модерации (0 — одобрен, 1 — отклонен, 2 — на модерации, 3 — активен, 4 — остановлен, 5 — остановлен рекламодателем) |

# Создание тегов retag <span id="create-retag-tags" />

## Параметры <span id="create-tags-parameters" />

| HTTP- метод | Права доступа                                                                                                  | URL                                   | Параметры                                                  | Примечание                                                                                                              |
| ----------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| POST        | [manage\_webmaster\_retag](/article/ru/308#manage-webmaster-retag) | https://api.admitad.com/retag/create/ | [Список параметров для запроса](#create-tags-request-list) | Формат данных запроса [application/x-www-form-urlencoded](http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1)\* |
|             |                                                                                                                |                                       |                                                            | Возвращает созданный код оптимизации\*                                                                                  |

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

## Список параметров для запроса  <span id="create-tags-request-list" />

| Название | Тип     | Обязательный | Ограничения параметров | Допустимые значения                                                                                                                        |
| -------- | ------- | ------------ | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| website  | integer | ✔            |                        | [Список площадок веб-мастера](/article/ru/328#list-of-publisher-ad-spaces) |
| level    | integer | ✔            |                        | [Доступные уровни программ](#available-program-levels)                                                                                     |
| active   | integer |              |                        | 0 — inactive, 1 — active                                                                                                                   |
| script   | string  | ✔            |                        | «Тело» тега                                                                                                                                |
| comment  | string  |              |                        | Комментарий                                                                                                                                |

## Пример использования <span id="create-tags-example" />

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

```
curl -L -H 'Authorization: Bearer access_token' -X POST  
https://api.admitad.com/retag/create/ -d  
'website=22&level=78&active=1&comment=test&script=test'
```

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

```
{  
    "active": true,  
    "comment": "test",  
    "id": 17,  
    "level": {  
        "campaign": {  
            "id": 6,  
            "name": "AdvCamp 1"  
        },  
        "id": 78,  
        "name": "Level 1. Main page"  
    },  
    "script": "test",  
    "status": 2,  
    "website": {  
        "id": 22,  
        "name": "site1_of_webmaster1"  
    }  
}
```

[Описание полей ответа API-сервера](#retag-tags-api-description)

# Редактирование тегов retag <span id="edit-retag-tags" />

## Параметры <span id="edit-tags-parameters" />

| HTTP- метод | Права доступа                                                                                                     | URL                                        | Параметры                                                  | Примечание                                                                                                              |
| ----------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| POST        | [manage\_webmaster\_retag](/article/ru/308#manage-webmaster-retag) | https://api.admitad.com/retag/update/{id}/ | [Список параметров для запроса](#create-tags-request-list) | Формат данных запроса [application/x-www-form-urlencoded](http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1)\* |
|             |                                                                                                                   |                                            |                                                            | Возвращает созданный код оптимизации\*                                                                                  |

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

## Пример использования <span id="edit-tags-example" />

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

```
curl -L -H 'Authorization: Bearer access_token' -X POST  
https://api.admitad.com/retag/update/17/ -d  
'level=82&comment=test_1&script=test_1&active=1'
```

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

```
{  
    "active": true,  
    "comment": "test_1",  
    "id": 17,  
    "level": {  
        "campaign": {  
            "id": 6,  
            "name": "AdvCamp 1"  
        },  
        "id": 82,  
        "name": "Level 3. Product page"  
    },  
    "script": "test_1",  
    "status": 2,  
    "website": {  
        "id": 22,  
        "name": "site1_of_webmaster1"  
    }  
}
```

[Описание полей ответа API-сервера](#retag-tags-api-description)

# Удаление тегов retag  <span id="delete-retag-tags" />

## Параметры <span id="delete-tags-parameters" />

| HTTP- метод | Права доступа                                                                                                  | URL                                        | Параметры                                                  | Примечание                                                           |
| ----------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | ---------------------------------------------------------- | -------------------------------------------------------------------- |
| POST        | [manage\_webmaster\_retag](/article/ru/308#manage-webmaster-retag) | https://api.admitad.com/retag/delete/{id}/ | [Список параметров для запроса](#create-tags-request-list) | Возвращает результат операции, где id — это идентификатор площадки\* |

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

## Пример использования <span id="delete-tags-example" />

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

```
curl -L -H 'Authorization: Bearer access_token' -X POST  

https://api.admitad.com/retag/delete/17/
```

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

```
{  
    "message": "The tag record was deleted successfully",  
    "success": "Deleted"  
}
```