Работа с пользовательскими таргетингами

Работа с пользовательскими таргетингами

Использование программного интерфейса позволяет осуществлять следующие операции с пользовательскими таргетингами в системе AdRiver:

  • добавление нового пользовательского таргетинга;
  • просмотр списка всех пользовательских таргетингов;
  • изменение пользовательского таргетинга;
  • просмотр данных пользовательского таргетинга.

При работе с пользовательскими таргетингами в системе AdRiver через программный интерфейс используются следующие параметры:

Более подробную информацию о добавлении и настройке пользовательских таргетингов можно получить из документации на сайте.

1. Добавление нового пользовательского таргетинга для сайта

В теле запроса указываются значения всех параметров пользовательского таргетинга для сайта.

Примечание: При работе с пользовательскими таргетингами в системе AdRiver через программный интерфейс следует использовать формат application/json .

Пример запроса на добавление пользовательского таргетинга с символьными значениями для сайта:

Примечания к коду:

  • 179042 — Идентификатор сайта, для которого добавляется таргетинг.

В случае успешного создания пользовательского таргетинга для сайта будет возвращено его представление, в котором содержатся все параметры созданного пользовательского таргетинга:

Примечания к коду:

  • “system” : “0” — Добавленный таргетинг не системный.
  • Образование — Название добавленного таргетинга.
  • “values” — Массив значений добавленного таргетинга.
  • 3FC4435C-BF87-11E1-BF8E-8DFAF5422389 — Идентификатор добавленного таргетинга.

В случае ошибки, например, если пользователь не прошел авторизацию, выдается ответ следующего вида:

Также ошибка выдается при попытке добавления пользовательского таргетинга для несуществующего сайта:

2. Добавление нового пользовательского таргетинга для пользователя

Имеется также возможность добавления пользовательского таргетинга для пользователя. Такой таргетинг в дальнейшем может быть связан с несколькими сайтами этого пользователя с помощью соответствующего запроса (см. п.3). Пример запроса на добавление пользовательского таргетинга с целочисленными значениями для пользователя:

В случае успешного создания пользовательского таргетинга для пользователя будет возвращено его представление, в котором содержатся все параметры созданного пользовательского таргетинга:

Примечания к коду:

  • “system” : “0” — Добавленный таргетинг не системный.
  • ID пользователя — Название добавленного таргетинга.
  • “values” — Массив значений добавленного таргетинга.
  • 99DAD784-D00D-11E1-84F7-EB9DFDA2427D — Идентификатор добавленного таргетинга.

В случае ошибки, например, при попытке добавления нового пользовательского таргетинга с уже существующим номером позиции (занятым ранее созданным другим пользовательским таргетингом), выдается ответ следующего вида:

3. Добавление связи между пользовательским таргетингом и сайтом данного пользователя

Для добавления связи между созданным ранее таргетингом для пользователя (см. п.2.) и сайтом этого пользователя следует выполнить следующий запрос:

Примечания к коду:

  • 178863 — Идентификатор сайта, с которым связывается таргетинг.
  • F0254572-D254-11E1-BB33-B9ADEC20ED3D — Идентификатор пользовательского таргетинга для связи с сайтом.

В случае успешного создания связи между пользовательским таргетингом и сайтом выдается ответ вида:

4. Удаление связи между пользовательским таргетингом и сайтом данного пользователя

Если необходимо удалить ранее созданную связь между пользовательским таргетингом и сайтом данного пользователя, следует воспользоваться таким запросом:

5. Получение списка пользовательских таргетингов данного сайта пользователя

Нижеследующий запрос позволяет получить список всех пользовательских таргетингов данного сайта (в примере – сайта 178863).

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

Примечания к коду:

  • F0254572-D254-11E1-BB33-B9ADEC20ED3D — Идентификатор первого пользовательского таргетинга сайта.
  • 1ED63174-C19A-11DF-8D53-C44BEAD1786B — Идентификатор второго пользовательского таргетинга сайта.
  • 1EDC16E8-C19A-11DF-8D53-C44BEAD1786B — Идентификатор третьего пользовательского таргетинга сайта.

6. Получение списка всех пользовательских таргетингов данного пользователя

Нижеследующий запрос позволяет получить список всех пользовательских таргетингов данного пользователя (в примере – пользователя 179221).

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

7. Редактирование данных пользовательского таргетинга

Если необходимо изменить данные ранее добавленного пользовательского таргетинга в системе AdRiver, то это можно осуществить с помощью запроса на его изменение. Операция редактирования по своей сути аналогична операции добавления пользовательского таргетинга, поскольку в соответствующем запросе содержится полный список параметров изменяемого пользовательского таргетинга.

Примечания к коду:

  • 3FC4435C-BF87-11E1-BF8E-8DFAF5422389 — Идентификатор пользовательского таргетинга для редактирования.

В случае успешного редактирования в ответе возвращаются все текущие данные пользовательского таргетинга.

В случае ошибки, например, если запрос на редактирование указывает на несуществующий таргетинг, выдается ответ следующего вида:

8. Просмотр данных пользовательского таргетинга

Имеется возможность также получить данные пользовательского таргетинга по его уникальному идентификатору (id). Идентификатор пользовательского таргетинга выдается в ответе системы при его добавлении, также можно получить идентификаторы всех пользовательских таргетингов данной учетной записи при просмотре списка пользовательских таргетингов пользователя (см. п.6).

Пример запроса на просмотр данных пользовательского таргетинга:

В ответ система возвращает все текущие данные по запрошенному идентификатору пользовательского таргетинга:

В случае ошибки, например, если запрос на просмотр данных пользовательского таргетинга включает в себя идентификатор недопустимого формата (с синтаксической ошибкой), выдается ответ следующего вида:

9. Получение статистики по значениям пользовательского таргетинга для сайта

С помощью программного интерфейса можно получить статистические данные по значениям пользовательского таргетинга для сайта. Соответствующие запросы позволяют получить статистику по следующим показателям:

  • показы;
  • клики;
  • программные события (действия пользователя по отношению к баннеру, вызывающие обращения к серверу, например, наведение курсора мыши, перемещение внутри баннера и т.п.).

Статистика может быть запрошена по заданному временному периоду. Период получения статистических данных задается с помощью указания даты начала и даты окончания периода.

Примечание: При указании периода получения статистики необходимо иметь в виду, что ненулевые статистические данные могут быть получены только за период реального выполнения рекламных кампаний на сайте. Срок хранения статистической информации системы для сайтов, рекламных кампаний, сценариев и баннеров составляет 365 суток.

Обязательными параметрами запроса на получение статистических данных являются:

📎📎📎📎📎📎📎📎📎📎