yadirectr

0

Описание

Языки

  • R100%
README.md

YaDirectR

Коршаков Александр 2025-01-31

YaDirectR

YaDirectR — это пакет на языке R, который предоставляет удобный интерфейс для работы с API Яндекс.Директа (версии 5+). Пакет использует следующие основные библиотеки:

  • data.table для высокопроизводительной обработки данных.
  • httr2 для формирования и отправки HTTP-запросов к Яндекс.Директу.

Основные возможности

  • Упрощает аутентификацию и управление токенами для работы с API Яндекс.Директа.
  • Предоставляет вспомогательные функции для запроса данных о кампаниях, объявлениях, ключевых словах и т.д.
  • Возвращает результаты в удобном формате
    data.table
    для дальнейшей обработки.
  • Позволяет связно вызывать несколько методов API Яндекс.Директа через единый интерфейс.

Установка

Чтобы установить пакет напрямую из Git-репозитория, вам потребуется пакет remotes (или devtools) в R.
После установки и загрузки пакета вы сможете пользоваться всеми функциями YaDirectR.

Подключаем пакет:

Использование

Ниже приведён краткий пример использования YaDirectR.

Аутентификация

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

Получение списка кампаний

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

Получение отчета

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

data.table
, который легко обрабатывать, используя синтаксис data.table.

Другие функции

Пакет содержит следующие основные функции для работы с:

  • Отчётами
  • Обяъвлениями
  • Финансовыми метриками

Подробное описание каждой функции смотрите в документации к функциям (

?getBalanceYD
,
?getBalance
и т.д.).

Обработка данных с помощью data.table

yDirectR возвращает результаты в формате

data.table
, вы можете сразу использовать высокоскоростные операции, свойственные этому пакету: группировку, фильтрацию и т.д.

Лицензия

Проект распространяется под лицензией MIT. Полный текст лицензии смотрите в файле LICENSE.