Назад до Огляду платформи
Глосарій
API
Статистичні APIs
Audience APIs

Створюйте та наповнюйте аудиторні групи за допомогою Audience API.

Для створення аудиторної групи використовуйте POST-метод.

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

У GET-запиті вкажіть наступні параметри:

Параметр Опис Примітка
name Назва аудиторної групи Максимальна кількість символів - 256
advertiserId ID рекламодавця, для якого створюється аудиторна група
idType Тип ID користувачів в аудиторній групі
dataLifetime (необов'язковий) Термін зберігання даних у групі (кількість днів)
 Значення від 1 до 180 
Параметр dataLifetime є необов'язковим. Якщо його немає, система автоматично встановить термін зберігання даних 180 днів.

Наприклад,
https://dmpapi.admixer.net/AudienceAPI/AudienceGroup?name=MyAudienceGroup&advertiserId=1234&idType=1&dataLifetime=115
Де

MyAudienceGroup назва аудиторної групи
1234 ID рекламодавця
1 тип ID користувачів
115 термін зберігання даних (115 днів)

Типи ідентифікаторів користувачів
Тип Значення
Cookie 0
IDFA 1
PubID 6
AAID 7
ClientId 8
Email 9
Phone 10
EmailMD5 12
EmailSHA256 13
PhoneMD5 14
PhoneSHA256 15
MultiID 11

В відповідь ви отримаєте 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 секунд.
Оновлено 11 жовтня, 2023