Войти

Добро пожаловать в Центр поддержки

Получите помощь с интеграцией и запущенными кампаниями.

Добро пожаловать в Центр поддержки. Получите помощь с интеграцией и запущенными кампаниями.

Подробнее об API

Criteo API доступен по этой ссылке: https://api.criteo.com/marketing

Endpoints

Аутентификация

Тип

Endpoint

Цель

Параметры

Заметки

POST

/oauth2/token

Вызвать токен, который позволит вам отправлять запросы в API

  • client_id (обязательный параметр)
  • client_secret (обязательный параметр)
  • grant_type (обязательный параметр)

Срок действия токена составляет 300 секунд

 

Управление рекламодателями

Тип

Endpoint

Цель

Параметры

GET

/portfolio

Вызов ваших advertiser_Id(s)

Нет

GET

/advertiser/{advertiser_Id}/campaigns

Выгрузка кампаний и категорий для определенного рекламодателя

advertiser_Id (обязательный параметр): string

GET

/advertiser/{advertiser_Id}/categories

Выгрузка кампаний и категорий для определенного рекламодателя

Фильтр по статусу категорий

advertiser_Id (обязательный параметр): int

enabledOnly: bool

GET

/advertiser/{advertiser_Id}/categories/{categoryHashCode}

Выгрузка определенных категорий для конкретного рекламодателя

advertiser_id: int(необязательный параметр)

categoryHashCode (обязательный параметр)

 


Управление рекламными кампаниями

Тип

Endpoint

Цель

Параметры

GET

/campaigns/

Выгрузка кампаний для вашего портфолио

advertiser_Ids: string

campaignIds

campaignstatus: string

bidtype: string

GET

/campaigns/{campaignId}

Выгрузка кампании и категорий в рамках кампании

campaignId (mandatory): int

GET

campaigns/{campaignId}/categories

Выгрузка кампании и категорий в рамках кампании

Фильтр по статусу категорий

campaignId (mandatory): int

enabledOnly: string

GET

/campaigns/{campaignId}/categories/{categoryHashCode}

Выгрузка определенных категорий кампаний вашего портфолио

campaignId (mandatory): int

categoryHashCodes (mandatory): int

GET

/campaigns/bids

Выгрузка ставок вашего портфолио

advertiser_Ids: string

campaignIds

categoryHashCodes:string

bidtype: string

campaignStatus: string

pendingChanges: bool

PUT

/campaigns/bids

Изменение ставок для вашей кампании или категорий кампании

bidChanges (mandatoy): string

 

Построение отчетности по кампании

Тип

Endpoint

Цель

Параметры

Заметки

POST

/statistics

Выгрузка отчетов о показателях кампании

statsQuery (обязательный параметр)

Подробная информация об этой точке вызова приведена в разделе специальной документации

 

Управление бюджетом

Тип

Endpoint

Цель

Параметры

GET

/budgets

Выгрузка бюджетов вашего портфолио

advertiser_Ids: string

budgetIds: string

onlyActiveCampaigns:bool

 

Управление категориями

Тип

Endpoint

Цель

Параметры

GET

/categories

Получить категории из вашего портфолио

campaign_Ids: : string

advertiser_Ids: string

categoryHashCodes: string

enabledOnly: bool

PUT

/categories

Активные или деактивированные категории

categoriesPerCatalog (обязательный параметр)

 

Управление аудиторией

Тип

Endpoint

Цель

Параметры

Заметки

GET

/audiences

Получить список аудиторий

advertiser_Id : int

Если ID рекламодателя не указан, система вернется к вашему портфолио

POST

 /audiences/userlist/ 

Создать аудиторию

advertiser_Id : int

name: string

description:string

ID аудитории – следующий идентификатор (добавляется каждый раз при создании аудитории)

PUT

/audiences/{audienceId} 

Изменить метаданные аудитории

name: string

description: string

 

PATCH

/audiences/userlist/{audienceId}

Добавить/удалить пользователей из аудитории

operation: string (ADD or REMOVE) 

schema: string (email или madid)

identifiers: list of string

Ограничено до 50 000 идентификаторов на запрос.

Идентификаторы могут передаваться как

Email адреса: Текстовый формат, MD5 или SHA256 of MD5

MADID: IDFA или AAID

Примечание: API не принимает cookie IDs из DMP

DELETE 

/audiences/userlist/{audienceId}/users

Удалить всех пользователей из аудитории

   

DELETE 

/audiences/{audienceId}

Удалить аудиторию

   

 

Параметры

Параметр

Использование

Подробная информация

client_id

Вызов токена

Ваш e-mail (совпадает с вашим логином в Criteo Management Center)

client_secret

Вызов токена

Ваш пароль (логин совпадает с вашим логином в Criteo Management Center)

grant_type

Вызов токена

Всегда идентичен "client_credentials"

advertiser_Id

Получение данных определенного рекламодателя

Получено из /portfolio

Получено из /advertisers

Получено из /audience

Получено из /audiences/userlist/ 

advertiser_Ids

Вызов данных определенных рекламодателей

Получено из /budget

Получено из /campaigns

Получено из /campaigns/bids

Получено из /categories

Получено из /statistics

Вы можете вызывать несколько advertiser_Ids, просто разделяя их запятыми, например: 1,2,3

enabledOnly

Список фильтров по категориям

Получено из /categories

Получено из /advertiser/{advertiser_id}/categories

Получено из /campaigns/{campaignid}/categories

активировано

Обновить статус категории

Получено из /categories

categoryHashCode

Вызов данных определенной категории

Обновление статуса определенной категории

Получено из /advertiser/{advertiser_id}/categories/{categoriesHashCode}

categoryHashCodes

Вызов данных определенных категорий

Обновление ставки для определенных категорий кампаний

Получено из /categories

Получено из /campaigns/bids

Получено из /advertiser/{advertiserid}/categories/{categoriesHashCode}

Вы можете вызывать несколько categoryhashcodes, просто разделяя их запятыми, например: 1,2,3

budgetIds

Вызов данных по определенному бюджету

Получено из /budgets

onlyactiveCampaigns

Фильтровать кампании по статусу

Получено из /budgets

campaignID

Получение данных по определенной кампании

Обновление ставки для определенной кампании

Получено из /campaigns/{campaignid}

Получено из /campaigns/{campaignid}/categories

Получено из /campaigns/{campaignid}/categories/{categoriesHashCode}

Получено из /campaigns/bids

campaignIds

Получение данных по определенным кампаниям

Получено из /campaigns

Получено из /campaigns/bids

Получено из /categories

Вы можете вызывать несколько campaignids, просто разделяя их запятыми, например: 1,2,3

bidType

Фильтр по типу ставок

Получено из /campaigns

Получено из /campaigns/bids

bidValue

Обновление ставки для определенных категорий кампаний

Получено из /campaigns/bids

campaignStatus

Фильтр по статусу кампании

Получено из /campaigns

Получено из /campaigns/bids

pendingChanges

Отфильтровать кампанию с учетом готовящихся или установленных изменений

Получено из /campaigns/bids

catalogId

Обновить статус категории

Получено из /categories

audienceId

Обновить определенную аудиторию

Получено из /audiences/ 

Имя

Обновить название аудитории

Получено из /audiences/userlist/

Получено из /audiences/{audience_id}

description

Обновить описание аудитории

Получено из /audiences/userlist/

Получено из /audiences/{audience_id}

operation

Действия с аудиторией

Получено из /audiences/userlist/{audience_id}

Значение должно быть выбрано из указанных ниже: ADD / REMOVE

schema

Тип данных аудитории

Получено из /audiences/userlist/{audience_id}

identifiers

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

Получено из /audiences/{audience_id}

reportType

Экспорт отчета по статистике

Получено из /statistics

Значение должно быть выбрано из указанных ниже: Отчет по кампании / Отчет Facebook DPA / Отчет Transaction ID

ignoreXDevice

Экспорт отчета по статистике

Получено из /statistics

startDate

Экспорт отчета по статистике

Получено из /statistics

endDate

Экспорт отчета по статистике

Получено из /statistics

параметры

Экспорт отчета по статистике

Получено из /statistics

Максимум 3 параметра

метрики

Экспорт отчета по статистике

Получено из /statistics

Метрики необходимо выбрать из интерфейса Центра управления в интерфейсе личного кабинета

формат

Экспорт отчета по статистике

Получено из /statistics

Значение должно быть выбрано из указанных ниже: XML, JSON, CSV, EXCEL, HTML

валюта

Экспорт отчета по статистике

Получено из /statistics

Значение должно соответствовать формату кода валюты ISO

Часовой пояс

Экспорт отчета по статистике

Получено из /statistics

Значение должно быть выбрано из указанных ниже: GMT / PST / JST


Коды ответов

Код ответа

Причина

200

Успешно

400

Неверный запрос, проверьте синтаксис

401

Аутентификация не завершена

403

Доступ запрещен

429

Лимит запросов превышен, не более 200 запросов в минуту для каждого клиента

500

Неизвестная ошибка

Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 0 из 0
На базе технологии Zendesk