--- title: "Введение в Пакет rmytarget" author: "Alexey Seleznev" date: "`r Sys.Date()`" output: rmarkdown::html_vignette vignette: > %\VignetteIndexEntry{Введение в Пакет rmytarget} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{UTF-8} --- ```{r setup, include = FALSE} knitr::opts_chunk$set( collapse = TRUE, eval = FALSE, comment = "#>" ) ``` ## Краткое описание. Пакет rmytarget помогает получить дата фрейм со списком клиентов агентств из аккаунта MyTarget, получить список и обшие параметры рекламных кампаний по каждому из проектов, а так же получить детальную статистику по кампаниям, объявлениям и клиентам за каждый день, и в целом за выбранный период. ## Установка пакета rmytarget. Установка пакета осуществляется либо из CRAN, либо из репозитория GitHub, для этого сначала требуется установить и подключить пакет devtools. Установка из CRAN: `install.packages("rmytarget")` Для установка dev версии из GitHub предварительно вам необходимо установить пакет `devtools`, и уже с его помощью устанавлиать `rmytarget`: ```{r} install.packages("devtools") library(devtools) # После чего можно устанавливать пакет rmytarget. install_github('selesnow/rmytarget') library(rmytarget) ``` ## Пример кода для загрузки данных из API MyTarget ### Работа с обычным рекламным аккаунтом, даже если вы имете к нему доступ через агентский аккаунт ```{r} library(rmytarget) # ================ # пример работы с клиентским аккаунтом # авторизация # если вы работаете через агенский аккаунт то в браузере выберите пункт # предоставить доступ к аккаунту клиента или менеджера myTarAuth(login = "seleznev", token_path = "tokens") # загрузка списка рекламных кампаний и объявлений campaing <- myTarGetCampaignList(login = "seleznev", token_path = "tokens") ads <- myTarGetAdList(login = "seleznev", token_path = "tokens") # загрузка статистики по рекламным кампанийм camp_data <- myTarGetStats(date_from = Sys.Date() - 7, date_to = Sys.Date(), object_type = "campaigns", object_id = campaing$id, stat_type = "day", login = "seleznev", token_path = "tokens") # загрузка списка метрик входящих в группы "base", "tps", "viral" по объявлениям custom_data <- myTarGetStats(date_from = Sys.Date() - 7, date_to = Sys.Date(), object_type = "banners", metrics = c("base", "tps", "viral"), stat_type = "day", login = "seleznev", token_path = "tokens") # загрузка всех возможных метрик с группировкой по рекламным кампаниям all_data <- myTarGetStats(date_from = Sys.Date() - 7, date_to = Sys.Date(), object_type = "campaigns", metrics = "all", login = "seleznev", token_path = "tokens") ``` ### Работа с агентским аккаунтом ```{r} library(rmytarget) # авторизация # в браузере необходимо выбрать пункт предоставить доступ к аккаунту "логин агенсткого аккаунта" myTarAuth(login = "agency", token_path = "tokens") # загрузка списка клиентов clients <- myTarGetClientList(login = "agency", token_path = "tokens") # загрузка статистики с группировкой по клиентам агентского аккаунта client_stat <- myTarGetStats(date_from = Sys.Date() - 7, date_to = Sys.Date(), object_id = clients$id, object_type = "users", metrics = "all", login = "agency", token_path = "tokens") ``` ## Получение списка клиентов для агентского аккаунта. Эта функция доступна только для агентских аккаунтов, и соответсвенно для токенов выданных агентским аккаунтам. `myTarGetClients <- myTarGetClientList(login = "agency_login")` Аргументы функции: * auth - Необязательный аргумент, объект R с авторизационными данными, полученный с помощью функции myTarAuth * login - Логин, в принципе используется только для работы с файлом в котором храняться учётные данные * token_path - Путь к папке, в котором изначально будет сохранеён файл для хранения учётных данных, а в дальнейшем для загрузки учётных * данных, по умолчанию рабочая директория ## Получение списка рекламных кампаний. Функция доступна для рекламных аккаунтов в которых есть рекламные кампании, для того что бы получить список рекламных кампаний клиента агентства вам необходимо получить для этого клиента токен, указав имя клента в аргументе agency_client_name функции myTarAuth. `Campaign <- myTarGetCampaignList(login = "your_login")` Аргументы функции: * auth - Необязательный аргумент, объект R с авторизационными данными, полученный с помощью функции myTarAuth * login - Логин, в принципе используется только для работы с файлом в котором храняться учётные данные token_path - Путь к папке, в котором изначально будет сохранеён файл для хранения учётных данных, а в дальнейшем для загрузки учётных данных, по умолчанию рабочая директория * request_speed - Необязательный аргумент, служит для регулировки паузы между запросами к API, что бы избежать ошибки `Too Many Requests (RFC 6585) (HTTP 429)`, т.е. при работе с большим аккаунтом может потребоваться увеличить паузы между запросами, если столкнулись с такой ошибкой установите значение "slow", при работе с аккаунтами в которых небольшое количетсво рекламных кампаний можно устанавливать значение "fast". ## Получение списка объявлений. Для загрузки списка объявлений используйте функцию `myTarGetAdList`. `Ads <- myTarGetAdList(login = "your_login")` Аргументы функции: * auth - Необязательный аргумент, объект R с авторизационными данными, полученный с помощью функции myTarAuth * login - Логин, в принципе используется только для работы с файлом в котором храняться учётные данные token_path - Путь к папке, в котором изначально будет сохранеён файл для хранения учётных данных, а в дальнейшем для загрузки учётных данных, по умолчанию рабочая директория * request_speed - Необязательный аргумент, служит для регулировки паузы между запросами к API, что бы избежать ошибки `Too Many Requests (RFC 6585) (HTTP 429)`, т.е. при работе с большим аккаунтом может потребоваться увеличить паузы между запросами, если столкнулись с такой ошибкой установите значение "slow", при работе с аккаунтами в которых небольшое количетсво рекламных кампаний можно устанавливать значение "fast". ## Получение статистики по рекламным аккаунтам и объявлениям. Для загрузки статистики необходимо использовать функцию `myTarGetStats`. Примеры её использования приведены в начале документации. Аргументы функции: - date_from - Дата начала отчётного периода - date_to - Дата звершения отчётоного периода - object_type - Тип объекта по которому будут группироваться полученные данные, возможные значения banners, campaings и users. Группировка users доступна только при работе с агентскими аккаунтами, и предназначена для загрузки статистики в разрезе клиентов агентского аккаунта. - object_id - Необязательный аргумент, ID объектов по которым вы хотите получить статистику, зависит от значения установленного в аргумент object_type. По умолчанию запрашивается статистика по всем объектам указанного в аргументе object_type типа. - stat_type - Временная группировка данных, по умолчанию "day", так же можно загружать статистику за весь период указав значение "summary". - metrics - Вектор, содержащий названия групп метрик которые вы хотите получить, по умолчанию принимает значение base, но так же вам доступны такие группы: base, events, video, viral, uniques, tps. Для загрузки всех метрик укажите значение "all". Подробное описание метрик входящих в каждую группу доступно по [ссылке](https://target.my.com/adv/api-marketing/doc/stat-v2), или чуть ниже в этой документации. - auth - Необяхательный аргумент, объект который можно получить с помощью функции myTarAuth. - token_path - Путь к папке в которой хранится файл с учётными данными, файл создаётся при первом обращении к API MyTarget в случае запуска любой из функций пакета, далее учётые данные подтягиваются по значению аргумента login. **Будьтк внимательны, т.к. API MyTagrteg позволяет запрашивать не более 5 токен для одного аккаунта**. ### Группы метрик которые можно задавать в аргументе metrics:
base - базовые метрики:
events - метрики для рекламируемых сообщений в ленте социальных сетей:
uniques - метрики по количеству уникальных пользователей:
video - метрики для видеорекламы:
viral - метрики виральных событий:
carousel - статистика по отдельным слайдам рекламной карусели (N - от 1 до количества слайдов):
tps - статистика по дополнительным списаниям:
moat - статистика по данным сервиса moat: