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

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

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

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

Параметр Опис Примітка
name Назва сегмента, унікальна в розрізі сегментної групи Максимальна кількість символів - 256
groupId ID сегментної групи, в якій створюється сегмент
idType Тип ідентифікаторів користувачів у сегменті

Наприклад,

https://dmpapi.admixer.net/AudienceAPI/Segment?name=NewSegment&groupId=1234&idType=6

де

NewSegment Назва нового сегмента
1234 ID сегментної групи, в якій створюється сегмент
6 тип ідентифікаторів користувачів у цьому сегменті (у цьому випадку тип PubID)

Типи ідентифікаторів користувачів

Тип Значення
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": 3546,
    "message": "Segment was created successfully"
}

Якщо ви хочете отримати список усіх наявних сегментів, використовуйте POST-метод

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

Показати приклад JSON-відповіді зі списком усіх наявних сегментів
{
"groupId": 1234,
"groupName": "MySegmentGroup",
"groupCpmPrice": 5.00,
"id": 5678,
"name": "NewSegment",
"idType": 6,
"userIds": 5
}

де

groupId ID сегментної групи
groupName назва сегментної групи
groupCpmPrice її CPM у валюті провайдера
id ID сегмента
name назва сегмента
idType тип ідентифікаторів у сегменті
userIds кількість унікальних користувацьких ідентифікаторів у сегменті

Щоб отримати список сегментів однієї або декількох сегментних груп, вкажіть у GET-запиті ID цієї групи/цих груп через масив. Наприклад,

https://dmpapi.admixer.net/AudienceAPI/Segments?groupIds=[‘1234’] (з однієї сегментної групи)

https://dmpapi.admixer.net/AudienceAPI/Segments?groupIds=[‘1234’, ‘1235’] (з декількох сегментних груп)

Показати приклад JSON-відповіді зі списком сегментів однієї або декількох сегментних груп
[ {
            "groupId": 1234,
            "groupName": "Look-alike",
            "groupCpmPrice": 0.0,
            "id": 311,
            "name": "Segment 1",
            "idType": 0,
            "userIds": 56
    },
    {
            "groupId": 1235,
            "groupName": "Created segments",
            "groupCpmPrice": 0.02000000,
            "id": 297,
            "name": "Segment 2",
            "idType": 0,
            "userIds": 321
    },
    {
            "groupId": 1235,
            "groupName": "Created segments",
            "groupCpmPrice": 0.02000000,
            "id": 303,
            "name": "Segment 3",
            "idType": 0,
            "userIds": 122
    } ]
Інтервал між запитами має бути не менше 30 секунд
Оновлено 25 жовтня, 2023