ryandexdirect v3.6.0

0

Monthly downloads

0th

Percentile

Load Data From 'Yandex Direct'

Load data from 'Yandex Direct' API V5 <https://tech.yandex.ru/direct/doc/dg/concepts/about-docpage/> into R. Provide function for load lists of campaings, ads, keywords and other objects from 'Yandex Direct' account. Also you can load statistic from API 'Reports Service' <https://tech.yandex.ru/direct/doc/reports/reports-docpage/>. And allows keyword bids management.

Readme

ryandexdirect - пакет для работы с API Яндекс.Директ версии 4, Live 4 и 5.

Краткое описание.

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

  • Сервис Reports - Предназначен для получения статистики по аккаунту рекламодателя.
  • API Директа версии 4 и Live 4 - Через API внешние приложения добавляют и редактируют кампании, объявления, фразы, задают ставки, получают статистику показов.
  • API Директа версии 5 - Через API внешние приложения добавляют и редактируют кампании, объявления, фразы, задают ставки, получают статистику показов.

Пакет позволяет вам выполнять следующие действия:

  1. Авторизовываться в API.
  2. Получать список различных объектов рекламного кабинета, рекламных кампаний, групп объявлений, объявлений, для агентских аккаунтов можно запрашивать список клиентов, и параметры каждого клиента.
  3. Управлять показами на уровне рекламных кампаний, групп объявлений и объявлений.
  4. Загружать статистику.
  5. Упаравлять ставками ключевых слов и автотаргетингов.
  6. Загружать данные о расходах, показах и кликах из Яндекс.Директ в Google Analytics.
  7. Запрашивать данные из сервиса WordStat
  8. Получить прогноз показов, кликов и трат по заданным ключевым фразам и регионам.

Видео уроки

У ryandexdirect есть официальный обучающий плейлист на YouTube, все видео доступны по ссылке.

Установка пакета ryandexdirect.

Установка пакета осуществляется из репозитория CRAN

install.packages("ryandexdirect")

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

install.packages("devtools")

library(devtools)

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

install_github('selesnow/ryandexdirect')

Пример кода

# Установка пакетов
install.packages("ryandexdirect")

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

# Авторизация 
yadirAuth(Login     = "my_yandex_login",  # логин пользователя Яндекс.Директ
          TokenPath = "C:/direct/tokens") # путь к папаке в которой будет храниться файл с учётными данными

# ###################################################
# Загрузка различных объектов из рекламного аккаунта
# ###################################################

# Список рекламных кампаний
camp <- yadirGetCampaign(Logins    = "my_yandex_login",
                         TokenPath = "C:/direct/tokens",
                         States    = "ON",
                         Types     = "TEXT_CAMPAIGN")

# Список ключевых слов
kw <- yadirGetKeyWords(Login       = "my_yandex_login",
                       TokenPath   = "C:/direct/tokens",
                       CampaignIds = camp$Id[1:5],
                       States      = "ON")

# Список групп объявлений
adgroups <- yadirGetAdGroups(Login       = "my_yandex_login",
                             TokenPath   = "C:/direct/tokens",
                             CampaignIds = camp$Id[c(1,2)],
                             Types       = "TEXT_AD_GROUP",
                             Statuses    = c("ACCEPTED", "MODERATION"))

# Список объявлений
ads <- yadirGetAds(Login       = "my_yandex_login",
                   TokenPath   = "C:/direct/tokens",
                   CampaignIds = camp$Id[c(1,2)])

# Список быстрых ссылок 
links <- yadirGetSiteLinks(Login       = "my_yandex_login",
                           TokenPath   = "C:/direct/tokens")

# ###################################################
# Загрузка справочной информации
# ###################################################

# Справочник валют
currency <- yadirGetDictionary(DictionaryName = "Currencies",
                               Language       = "en",
                               Login          = "my_yandex_login",
                               TokenPath      = "C:/direct/tokens")

# Георгафический справочник
regions <- yadirGetDictionary(DictionaryName = "GeoRegions",
                              Language       = "ru",
                              Login          = "my_yandex_login",
                              TokenPath      = "C:/direct/tokens")

# ###################################################
# Загрузка статистики
# ###################################################

# простейший отчёт за прошлый месяц
simple_report <- yadirGetReport(DateRangeType = "LAST_MONTH",  # относительный период
                                FieldNames    = c("Date", "Clicks", "Impressions"),
                                Login         = "my_yandex_login",
                                TokenPath     = "C:/direct/tokens")

# отчёт по конверсиям с моделью аттрибуции за статичный период
attribution_report <- yadirGetReport(DateFrom          = "2018-11-15", # статичный период, дата начала
                                     DateTo            = "2018-11-20", # статичный период, дата завершения
                                     FieldNames        = c("Date", 
                                                           "Conversions"),
                                     Goals             = c(27475434, 38234732),
                                     AttributionModels = c("LC", "FC"),
                                     Login             = "my_yandex_login",
                                     TokenPath         = "C:/direct/tokens")

# отчёт с применением фильтрации
filtring_report <- yadirGetReport(DateRangeType = "LAST_30_DAYS",
                                  FieldNames    = c("Date", "Clicks", "Impressions"),
                                  FilterList    = c("Conversions GREATER_THAN 1", 
                                                    "Impressions LESS_THAN 3500"),
                                  Login         = "my_yandex_login",
                                  TokenPath     = "C:/direct/tokens")

# ###################################################
# Управление ставками
# ###################################################

# запрашиваем ставки
bids  <- yadirGetKeyWordsBids(kw$Id)

# запрашиваем ставки и данные торго на поиске
bids_search <- yadirGetKeyWordsBids(kw$Id,
                                    AuctionBids = "search")

# запрашиваем ставки и данные торго в сетях
network_bids <- yadirGetKeyWordsBids(kw$Id,
                                     AuctionBids = "network")

# запрашиваем список рекламных кампаний
camp <- yadirGetCampaign()

# меняем ставки
setbid     <- yadirSetKeyWordsBids(CampaignIds = camp$Id[1],
                                   SearchBid   = 9)

# меняем ставки
autosetbids <- yadirSetAutoKeyWordsBids(KeywordIds = kw$Id,
                                        TargetTrafficVolume = 50)

Виньетки

Пакет имеет подробные виньетки отдельно по каждой из своих возможностей, в которой наиболее подробно описаны детали работы с его функционалом. На данный момент в пакете ryandexdirect доступны 3 виньетки.

  1. Загрзка статистики из API Яндекс Директ: vignette("yandex-direct-get-statistic", package = "ryandexdirect")
  2. Авторизация и работа с учётными данными: vignette("yandex-direct-auth", package = "ryandexdirect")
  3. Управление ставками ключевых слов в Яндекс Директ: vignette("yandex-direct-keyword-bids", package = "ryandexdirect")
  4. Загрузка данных из сервиса WordStat и построение прогноха по показам, кликам и тратам: vignette("yandex-direct-get-wordstat-forecast", package = "ryandexdirect")
  5. Загрузка данных о расходах, показах и кликах из Яндекс Директ в Google Analytics: vignette("yandex-direct-cost-data", package = "ryandexdirect")

Статьи о пакете ryandexdirect

Вебинары

Ссылки

  1. Полная, официальная документация по работе с пакетом ryandexdirect.
  2. Баг репорты, предложения по доработке и улучшению функционала ryandexdirect оставлять тут.
  3. Список релизов.
  4. Телеграмм канал R4marketing.
  5. Группа в Вконтакте.

Автор пакета

Алексей Селезнёв, Head of analytics dept. at Netpeak


email: selesnow@gmail.com


skype: selesnow


facebook: facebook.com/selesnow


blog: alexeyseleznev.wordpress.com

Бейджи

Rdoc rpackages.io rank

Functions in ryandexdirect

Name Description
yadirGetCampaign Get Campaigns List
yadirGetKeyWords Get Keywords
yadirGetForecast Get Forecast
yadirGetDictionary Get Dictionary from 'Yandex Direct'
yadirGetCostData Loading Cost Data for Upload to Google Analytics
yadirSetKeyWordsBids Set KeyWords Bids
yadirSetLogin Set Login
yadirGetToken Auth in 'Yandex Direct' API
yadirGetWordStatReport Get WordStat Report
yadirSetAutoKeyWordsBids Auto Set KeyWords Bids
yadirSetAgencyAccount Set Agency Account
yadirGetKeyWordsBids Get KeyWords Bids
yadirGetReport Get Report From 'Yandex Direct Report Service'
yadirStartAds Start Ads
yadirStartCampaigns Start Campaigns
yadirGetLogins Get Login List or Set Login
yadirStopKeyWords Suspend impressions by KeyWords
yadirStopAds Suspend impressions by Ads
yadirStopCampaigns Suspend impressions by Campaigns
yadirStartKeyWords Resume KeyWords
yadirGetSiteLinks Get Fast Links
yadirAuth Authentication in 'Yandex Direct' API
yadirGetBalance Get 'Yandex Direct' account balance
yadirGetClientParam Get params list from 'Yandex Direct' agency clients
yadirCurrencyRates Get currencies
yadirGetClientList Get Client List From Agency Account
yadirGetAdGroups Get AdGroups List
ryandexdirect-deprecated Deprecated functions in ryandexdirect
ryandexdirect-package ryandexdirect
yadirGetAds Get Ads List From 'Yandex Direct' account
No Results!

Vignettes of ryandexdirect

Name
yandex-direct-auth.Rmd
yandex-direct-cost-data.Rmd
yandex-direct-get-statistic.Rmd
yandex-direct-get-wordstat-forecast.Rmd
yandex-direct-keyword-bids.Rmd
No Results!

Last month downloads

Details

Type Package
Date 2020-06-09
License GPL-2
BugReports https://github.com/selesnow/ryandexdirect/issues
URL https://selesnow.github.io/ryandexdirect, https://t.me/R4marketing, https://www.youtube.com/playlist?list=PLD2LDq8edf4oUo0L9Kw77ZXf0KcV1hu67
Encoding UTF-8
Language ru
VignetteBuilder knitr
NeedsCompilation no
Packaged 2020-06-09 20:04:06 UTC; Alsey
Repository CRAN
Date/Publication 2020-06-09 20:20:03 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/ryandexdirect)](http://www.rdocumentation.org/packages/ryandexdirect)