Назад к Обзору платформы
Глоссарий
API
Статистические API
Аудиторные API

Создавайте и наполняйте аудиторные группы с помощью Audience API.

Для создания аудиторной группы используйте POST-метод

https://dmpapi.admixer.net/AudienceAPI/AudienceGroup

В GET-запросе укажите следующие параметры:

Параметр Описание Примечание
name Название аудиторной группы Максимальное количество символов – 256
advertiserId ID рекламодателя, для которого создается аудиторная группа
idType Тип идентификаторов пользователей в аудиторной группе
dataLifetime (необязательный) Срок хранения данных в группе (количество дней) Значение от 1 до 180
Параметр dataLifetime необязательный. При его отсутствии система автоматически установит срок хранения данных 180 дней.

Например,

https://dmpapi.admixer.net/AudienceAPI/AudienceGroup?name=MyAudienceGroup&advertiserId=1234&idType=1&dataLifetime=115

где

MyAudienceGroup название аудиторной группы
1234 ID рекламодателя
1 тип идентификаторов пользователей
115 срок хранения данных (115 дней)

Типы идентификаторов пользователей

Тип Значение
Cookie 0
IDFA 1
PubID 6
AAID 7
ClientId 8
Email 9
Phone 10
EmailMD5 12
EmailSHA256 13
PhoneMD5 14
PhoneSHA256 15

В ответ вы получите JSON с ID созданной аудиторной группы и сообщением об успешном завершении.

Показать пример JSON-ответа с ID созданной аудиторной группы
{
    "data": 123456,
    "message": "Audience group was created successfully"
}

Если вы хотите получить список всех активных аудиторных групп, используйте POST-метод

https://dmpapi.admixer.net/AudienceAPI/AudienceGroups

Показать пример JSON-ответа со списком всех активных аудиторных групп
{
"id": 100123,
"name": "Group1",
"advertiserId": 10123,
"idType": 0,
"userIds": 245
}, {
"id": 100177,
"name": "Group2",
"advertiserId": 10124,
"idType": 0,
"userIds": 365
}

В JSON-ответе вы получаете такие данные:

id ID аудиторной группы
name название аудиторной группы
advertiserId ID рекламодателя, которому принадлежит группа
idType тип идентификаторов в группе
userIds количество уникальных пользовательских идентификаторов в группе

Чтобы получить список аудиторных групп определенного рекламодателя, укажите в GET-запросе ID этого рекламодателя. Например,

https://dmpapi.admixer.net/AudienceAPI/AudienceGroups?advertiserId=12345

где 12345 – ID рекламодателя.

Получить пример JSON-ответа со списком аудиторных групп определенного рекламодателя
[ { 
"id": 321,
"name": "Audience Group 1",
"advertiserId": 12345,
"idType": 0,
"userIds": 23412
},
{ 
"id": 322,
"name": "Audience Group 2",
"advertiserId": 12345,
"idType": 0,
"userIds": 52622
},
{
 "id": 323,
"name": "Audience Group 3",
"advertiserId": 12345,
"idType": 0,
"userIds": 28066
} ]
Интервал между запросами должен быть не менее 30 секунд
Обновлено 01 февраля, 2023