##Содержание

• Краткое описание
• Установка пакета ryandexdirect
• Функции входящие в пакет ryandexdirect
• yadirGetToken
• yadirGetClientList
• yadirGetCampaignList
• yadirGetCampaignListOld
• yadirGetSummaryStat
• yadirCurrencyRates
• yadirGetLogsData
• Пример работы с пакетом ryandexdirect
• Пример работы с Logs API Яндекс Метрики

Пакет ryandexdirect помонает получить дата фрейм со списком клиентов агентств из аккаунта Яндекс.Директ, получить список и обшие параметры рекламных кампаний по каждому из проектов, а так же получить детальную статистику по кампаниям за каждый день.

Установка пакета осуществляется из репозитория GitHub, для этого сначала требуется установить и подключить пакет devtools.

install.packages("devtools")

library(devtools)

После чего можно устанавливать пакет ryandexdirect.

install_github('selesnow/ryandexdirect')

На данный момент в версию пакета 1.3 входит 7 функции:

###yadirGetToken() Функция для получения токена для доступа к API Яндекс.Директ, полученый токен используется во всех остальных функциях.

###yadirGetClientList(token = NULL) Данная функция возвращает дата фрейм со списком всех клиентов доступных в агентском аккаунте которому был выдан токен для доступа к API, используется только при работе с агентскими аккаунтами.

####Структура возвращаемого функцией yadirGetClientList дата фрейма:

###yadirGetCampaignList(logins = NULL, token = NULL) Функция возвращает дата фрейм со списком рекламных кампаний и некоторых их параметров по логину.

####Структура возвращаемого функцией yadirGetCampaignList дата фрейма:

###yadirGetCampaignListOld(logins = NULL, token = NULL) Устаревшая функцая для получения списка рекламных кампаний, список функций запрашивался с помощью метода GetCampaignList из версии API 4, с августе 2016 года этот метод стал недоступен, для того что бы получить список кампаний используйте новую функциюyadirGetCampaignList(logins = NULL, token = NULL).

###yadirGetSummaryStat(campaignIDS = NULL, dateStart = Sys.Date() - 10, dateEnd = Sys.Date(), currency = "USD", token = NULL) Основная функция пакета, возвращает дата фрейм со статистикой в разрезе кампаний и дат.

####Структура возвращаемого функцией yadirGetSummaryStat дата фрейма:

###yadirCurrencyRates(login = NULL, token = NULL) Функция возвращает дата фрейм с актуальными курсами валют в Яндекс.Директ.

####Структура возвращаемого функцией yadirGetSummaryStat дата фрейма:

###yadirGetLogsData(counter = NULL, date_from = Sys.Date() - 10, date_to = Sys.Date(), fields = NULL, source = "visits", token = NULL) Функция для работы с Logs API Яндекс Метрики, которое позволяет выгрузить сырые данные.

Иногда возникают проблемы с тем, что функция останавливается если в возвращаемых данных встречается строчная русская буква 'я', решение этой проблемы описано тут.

По сути просто необходимо установить одну хитрую локаль.

Sys.setlocale("LC_ALL","Russian_Russia.20866")

Далее функция будет работать корректно.

####Аргументы: counter - номер счётчика Яндекс Метрики date_from - начальная дата отчёта date_to - конечная дата отчёта fields - список полей которые вы отите получить, для visits актуальный список доступных полей можно получить тут, для hits актуальный список полей можно получить тут. source - Источник логов, возможные значения hits — просмотры или visits — визиты

Подробное описание аргументов можно посмотреть тут.

###Подключаем пакет ryandexdirect library(ryandexdirect)

###Получаем токен для доступа к API myToken <- yadirGetToken()

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

Далее в случае если у вас агетский аккаунт получаем список всех клиентов:

clientList <- yadirGetClientList(myToken)

Следующий шаг получить список рекламных кампаний клиентов, для этого в функции yadirGetCampaignList, для агентских аккаунтов необходимо задать вектор со списком логинов тех аккаунтов по которым вы хотите получить статистику, для обычных аккаунтов достаточно просто указать ваш токен.

campaignList <- yadirGetCampaignList(logins = clientList$Login, token = myToken)

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

stat <- yadirGetSummaryStat(campaignIDS = campaigns$CampaignID], dateStart = "2016-01-01", dateEnd = "2016-06-30", currency = "USD", token = myToken)

##Образец кода для работы с пакетом ryandexdirect

library(ryandexdirect)
myToken <- yadirGetToken()
clientList <- yadirGetClientList(myToken)
campaignList <- yadirGetCampaignList(logins = clientList$Login, token = myToken)
stat <- yadirGetSummaryStat(campaignIDS = campaigns$CampaignID,
                            dateStart = "2016-01-01",
                            dateEnd = "2016-06-30",
                            currency = "USD",
                            token = myToken)

#Пример работы с Logs API Яндекс Метрики.

library(ryandexdirect)
myToken <- yadirGetToken()
rawmetrikdata <- yadirGetLogsData(counter = "00000000",
                                  date_from = "2016-12-01",
                                  date_to = "2016-12-20",
                                  fields = "ym:s:visitID,ym:s:date,ym:s:bounce,ym:s:clientID,ym:s:networkType",
                                  source = "visits",
                                  token = myToken)

Автор пакета: Алексей Селезнёв, Head of Analytics Dept. at Netpeak

GitHub VK Facebook Linkedin Stepik