myTarget API
231 subscribers
1 photo
1 file
21 links
Новости myTarget API
Download Telegram
Теперь вы можете подписаться ещё и на изменения пользователя, используя ресурс USER.
Документация

/api/v3/subscription.json

Пример запроса:

{
"resource": "USER",
"callback_url": "https://mydomain.ru/users_callback"
}
12 и 13 апреля мы проводим профилактические работы.
В этот период будут доступны только основные метрики статистики: клики, показы, расход.
Обращаем ваше внимание, что с 29 апреля мы прекращаем поддержку следующих ресурсов:
/api/v2/remarketing/user_geo.json
/api/v2/remarketing/user_geo/<id>.json
для создания/редактирования списков георегионов.
Рекомендуем использовать для тех же целей следующие ресурсы:

/api/v2/regions.json
Документация: https://target.my.com/doc/api/ru/resource/Region

/api/v2/geo/coverage.json
Документация: https://target.my.com/doc/api/ru/resource/GeoCoverage

/api/v2/remarketing/local_geo.json
Документация: https://target.my.com/doc/api/ru/resource/LocalGeos
Мы обновили форму создания баннеров: с 26 октября вместо баннерного формата будут использоваться варианты формата (pattern) в пакетах содержащих флаг patterns.

Вариант формата — это набор полей, необходимый для отображения баннера на площадках myTarget. Для некоторых типов баннеров, таких как HTML5 баннер, вариант формата совпадает с текущим форматом. В мультиформате формат разделяется на несколько вариантов формата.

Например, сейчас мультиформат состоит из трех картинок (иконка 256х256, картинка 1080х607 и картинка 600х600), двух обязательных текстовых полей (Заголовок и Описание), кнопки call-to-action и опционального поля «Юр.инфо». Однако на большинстве площадок myTarget не используются все эти поля одновременно.

Каждый вариант формата будет соответствовать именно тому набору полей, которые показываются на конкретной площадке.
Для Ленты в «Одноклассниках» или «ВКонтакте» вариант формата будет содержать иконку 256х256, картинку 1080х607, заголовок, текст, кнопку и, опционально, юр.инфо. Картинка 600x600 для этой площадки не нужна.
Для такой площадки, как Главная Mail.ru 300х300 не нужна иконка 256х256, соответственно, это поле не обязательно к заполнению для создания варианта формата, способного показываться на этой площадке.

Таким образом, меняется состав полей, которые нужны для создания баннеров.
В "options" пакета в "pads" дополнительно к id мест размещений пакета появляется секция "pattern". В ней для каждого места размещения указан список вариантов формата, которые поддерживаются на данном месте размещения.
Например, для мультиформата, для размещения в ленте ОК/ВК используется вариант формата с id=34. Список ролей, которые необходимы для создания баннера по данному варианту формата, можно получить по API паттернов и полей.

Для некоторых пакетов и мест размещения некоторые варианты формата могут быть обязательными. В таком случае чтобы создать баннер, нужно отправить поля для заполнения обязательного варианта формата.
Если обязательные варианты формата в пакете не указаны, баннер будет создан при заполнении одного любого варианта формата.

Если в пакете текущий баннерный формат совпадает с доступным в пакете вариантом формата, создавать объявления можно обоими способами — и по баннерному формату, и по вариантам формата. У таких пакетов стоят флаги patterns и patterns_migration.

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

Документация: https://target.my.com/doc/api/ru/resource/BannerPatterns
https://target.my.com/doc/api/ru/object/BannerPattern
Уже сейчас вам доступен новый способ в нашей песочнице для отладки API запросов: https://target-sandbox.my.com/ (зарегистрируйтесь и присылайте запрос на выдачу доступа к API песочницы).
Id пакетов с вариантами формата: 1995,1994 - для сайтов и 2408,2410 - для мобильных приложений.

Ниже приведена инструкция:

Создаем кампанию в пакете 1995, хотим таргетировать ее на все места размещения.
1. Идем в API пакетов https://target.my.com/api/v2/packages.json?fields=id,name,description,options для пакета 1995
Смотрим pads в options пакета:
https://pastebin.com/GMS2JRJh

2. В секции «паттерн» получаем для каждого места размещения список вариантов формата (patterns), которые поддерживаются на указанном месте размещения. Например, место размещения Десктоп Лента, pad:242743 — поддерживается только вариант формата id=34
Для места размещения Десктоп-МРГ-Колонка, pad:146590 — поддерживаются варианты формата с id=2,3,64,51

3. Чтобы получить список полей для вариантов формата, идем в API паттернов:
https://target.my.com/api/v2/banner_patterns.json?limit=50

Например, для варианта формата 34 получаем список полей:
https://pastebin.com/LsNGXcVK

4. Требования к полям получаем в API полей, по имени роли
https://target.my.com/api/v2/banner_fields.json
Например, для роли image_1080x607 в поле format указаны минимальные/максимальные размеры картинки, тип картинки
"max_height": 607,
"max_width": 1080,
"min_height": 607,
"min_width": 1080,
"type": "static"

5. Далее создаем баннер и кампанию как обычно, передавая в запросе в поле banners список полей для вариантов формата (patterns). Например, так:
https://pastebin.com/7Wa4eteN

Будет создан баннер, соответствующий варианту формата 2 и 51, сможет показываться на местах размещения, где есть хотя бы один из этих вариантов формата: 146590, 242746, 242744, 242745, 242742, 242750, 242748
Обращаем ваше внимание, что с 21 октября прекращаем поддержку быстрой статистики по уникальным пользователям /api/v2/statistics/uniquestat/{banners|campaigns|users}.json
Все доступные виды статистики по-прежнему описаны в нашей документации по ссылке https://target.my.com/adv/api-marketing/doc/stat-v2
Работа по новому API для пакетов с флагом patterns_migration.

Мы продолжаем переход с баннерного формата на варианты формата (pattern). С 13 ноября у пакетов появится флаг patterns_migration — эти пакеты вы можете переключить на работу по новому API.
На переходный период необходимо отправлять ВСЕ обязательные роли всех паттернов.

Для большинства пакетов еще некоторое время будет доступна работа и по старому, и по новому API.
Для мультиформата будет доступна только работа по новому API, обратная миграция с текущими форматами перестанет работать. Это произойдет до конца ноября, точную дату переключения мультиформата мы сообщим позже.

Мы рекомендуем перейти на новое API и отладить работу уже сейчас, чтобы быть готовыми к отключению старого API.
Мы продолжаем переключение пакетов мультиформата на новую форму создания баннеров. В понедельник, 21 декабря, переключим следующие пакеты:
807 tt_crossdevice_site_multiformat_cpm_goal_ReachTrafficOffline
811 tt_crossdevice_site_multiformat_cpc_goal_TrafficOffline
А в течение недели все остальные, включая тизерные пакеты 1029, 1030.
Так же появилась возможность создавать карусельные баннеры, все соответствующие пакеты настроены на работу с новым API.
Напоминаем, что теперь создавать рекламные кампании в мультиформатах и тизерах можно только новым способом, с помощью вариантов формата (patterns)

Подробная схема создания с примером: https://t.me/mytarget_api/24

Мы подготовили для вас несколько инструкций "было-стало" для вашего удобства:

Мультиформат https://pastebin.com/7dvrfXZs
Тизеры: https://pastebin.com/aKFVbsR8
Мультиформат аппы: https://pastebin.com/ucALBpmC
Карусель сайты: https://pastebin.com/aTfn10Me
Карусель аппы: https://pastebin.com/24Gi7Zvq
В ближайшее время добавим шаг при установке общего ограничения бюджета budget_limit в настройках кампании. Изменение должно быть кратно значению budget_limit_step из /api/v2/currencies.json для валюты пользователя.

Документация: https://target.my.com/doc/api/ru/resource/Campaign
Теперь вы можете добавить существующего клиента в своё агентство используя username.
Пример такого запроса:

  POST https://target.my.com/api/v2/agency/clients.json
{
"access_type":"full_access",
"user": {
"username":"client_username",
"additional_emails": ["test@mail.ru"],
"additional_info": {
"client_info": "Заметка",
"client_name": "Василий Иванов",
}
}
}

Документация: https://target.my.com/doc/api/ru/resource/AgencyClients
Уважаемые пользователи, завтра, 8 июня в 13:00 планируются профилактические работы. Приблизительная длительность составит один час, в это время может быть недоступна статистика. Приносим извинения за неудобства.
Уважаемые пользователи API myTarget,

мы планируем перейти на третью версию статистики к 1 сентября 2021 года (точную дату перехода объявим дополнительно).

/api/v3/statistics/{banners|campaigns|users}/day.json

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

Новый метод уже доступен и вы можете начать им пользоваться. Документация по ссылке.
Уважаемые пользователи API myTarget,
22 июля в 11:00 по московскому времени планируются профилактические работы. В это время может быть недоступна статистика.
Приносим извинения за доставленные неудобства.
Уважаемые пользователи API myTarget,

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

/api/v2/statistics/{banners|campaigns|users}/{day|summary}.json

О дате перехода на третью версию статистики мы сообщим вам заблаговременно.
Уважаемые пользователи API myTarget,

обращаем ваше внимание, что в марте мы планируем ограничить использование второй версии ресурса для RemarketingUsersList и RemarketingUsersLists.

Рекомендуем начать использовать v3 для тех же целей:

/api/v3/remarketing/users_lists.json
/api/v3/remarketing/users_lists/<id>.json

Отличительные особенности:
1. Упрощен формат содержимого запроса: все поля запроса передаются в формате multipart/form-data.
2. Теперь ресурс возвращает описание проблем связанных с недочётами в файле. Проблемы описываются в ответе в поле error.
3. Появился параметр _q для полнотекстового поиска по имени (не более 255 символов).

Документация доступна по ссылкам:
https://target.my.com/doc/api/ru/resource/RemarketingUsersList?v=3
https://target.my.com/doc/api/ru/resource/RemarketingUsersLists?v=3
Уважаемые пользователи API myTarget,

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

/api/v2/statistics/{banners|campaigns|users}/{day|summary}.json

При запросе метрики viral ответ для этого вида статистики будет возвращаться без данных.

Документация:
https://target.my.com/adv/api-marketing/doc/stat-v2#statistics
Уважаемые пользователи API myTarget,

обращаем ваше внимание, что с 29 ноября будут внесены изменения в API статистики для:

/api/v2/statistics/{banners|campaigns|users|ad_plans|ad_groups}/{day|summary}.json
/api/v3/statistics/{banners|campaigns|users|ad_plans|ad_groups}/{day|total}.json
/api/v2/statistics/direct_deal/{campaigns}/{day|summary}.json

Из метрики uniques будут удалены следующие поля:

started
viewed_10_seconds
viewed_25_percent
viewed_50_percent
viewed_75_percent
viewed_100_percent
viewed_10_seconds_rate
viewed_25_percent_rate
viewed_50_percent_rate
viewed_75_percent_rate
viewed_100_percent_rate
depth_of_view_uniques

И перемещены в метрику video со следующими наименованиями:

unique_started
unique_viewed_10_seconds
unique_viewed_25_percent
unique_viewed_50_percent
unique_viewed_75_percent
unique_viewed_100_percent
unique_viewed_10_seconds_rate
unique_viewed_25_percent_rate
unique_viewed_50_percent_rate
unique_viewed_75_percent_rate
unique_viewed_100_percent_rate
unique_depth_of_view_uniques

Отметим, что поле reach в метрике uniques какое-то время будет возвращать ноль, но позже мы удалим его вовсе.

Ожидайте обновления документации:
https://target.my.com/doc/api/ru/info/Statistics