utf8/README.md

In selesnow/rmytarget: Load Data from 'MyTarget API v2 and v3'

rmytarget - пакет для работы с API MyTarget на языке R.

Содержание README:

• Установка пакета rmytarget
• Авторизация в API MyTarget
• Обновление токена доступа после истечение срока действия
• Получение списка клиентов для агентского аккаунта
• Получение списка рекламных кампаний
• Получение общей статистики по всем рекламным кампаниям аккаунта

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

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

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

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

install.packages("devtools")

library(devtools)

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

install_github('selesnow/rmytarget')

library(rmytarget)

Авторизация в API MyTarget.

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

В API MyTarget существует две схемы авторазиции, Client Credentials Grant для обычного рекламодателя и для агентства. В зависимости от типа вашего аккаунта вам необходимо получить токен доступа согласно типу вашего аккаунта в MyTarget.

Получение токена для обычного рекламного аккаунта.

myTargetAuth <- myTarAuth(grant_type = "client_credentials",
                          client_id = "XXXXXXXXXX",
                          client_secret = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")        

Аргументы: grant_type - Тип вашего аккаунта, в данном случае обычный клиентский аккаунт. client_id - ID выдаётся вам при подтверждение доступа к API MyTarget. client_secret - Выдаётся вам при подтверждение доступа к API MyTarget вместе с Client ID.

Получение токена для агентского аккаунта.

myTargetAuth <- myTarAuth(grant_type = "agency_client_credentials",
                          client_id = "XXXXXXXXXX",
                          client_secret = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                          agency_client_name = "xxxxxxxxx@agency_client")

Вариант grant_type=agency_client_credentials не является стандартным для OAuth2. Он реализован для того, чтобы агентства могли создавать access-токены для своих клиентов напрямую. Помимо параметров client_id, client_secret нужно передавать agency_client_name. Для получения информации по агентскому аккаунту, например поучить список клиентов агентсва необходимо следовать первой описанной схеме с grant_type = "client_credentials" и получить токен агентского аккаунта.

Обновление токена доступа

Каждый полученный access-токен является действительным в течение суток. На это указывает свойство expires_in в ответе на запрос access-токена. Для обновления токета в пакете rmytarget есть функция myTarRefreshToken

myTargetAuth <- myTarRefreshToken(old_auth = myTargetAuth,
                                  client_id = "xxxxxxxxx",
                                  client_secret = "xxxxxxxxxxxxxxxxxxxxxxxxxxx...")

Аргументы функции: old_auth - R объект с учётными данными полученный с помощью функции myTarAuth. client_id - ID выдаётся вам при подтверждение доступа к API MyTarget. client_secret - Выдаётся вам при подтверждение доступа к API MyTarget вместе с Client ID.

Подробную информацию о схеме аутинтификации в API вы можете получить по ссылке.

Получение списка клиентов для агентского аккаунта.

Эта функция доступна только для агентских аккаунтов, и соответсвенно для токенов выданных агентским аккаунтам.

myTargetClients <- myTarGetClientList(myTargetAuth)

Аргументы функции: auth - Объект R с авторизационными данными, полученный с помощью функции myTarAuth

Более подробную информацию по списку клиентов можно получить по ссылке

Получение списка рекламных кампаний.

Функция доступна для рекламных аккаунтов в которых есть рекламные кампании, для того что бы получить список рекламных кампаний клиента агентства вам необходимо получить для этого клиента токен, указав имя клента в аргументе agency_client_name функции myTarAuth.

myTargetCampaign <- myTarGetCampaignList(myTargetAuth)

Аргументы функции: auth - Объект R с авторизационными данными, полученный с помощью функции myTarAuth

Более полная информация находится в официальной документации к API по ссылке

Получение общей статистики по всем рекламным кампаниям аккаунта.

Функция доступна для рекламных аккаунтов в которых есть рекламные кампании.

myTargetSummary <- myTarGetTotalStats(date_to = "2016-08-01",
                                      date_to = "2016-08-10",
                                      auth = myTargetAuth)

Функция возвращает data frame со статистикой по рекламным кампаниям в разрезе дат.

Структура полученного data frame.

ПолеТип данныхОписание DateDateДата CampaignNameCharacterНазвание рекламной кампании CampaignIDCharacterID рекламной кампании ReachintegerОхват, количество уникальных пользователей которым были показаны объявления за всё время ведения рекламной кампании CTRNumericКликабельность объявлений CostNumericСумма списаний по рекламной кампании в рублях ImpressionsintegerКоличество показов ClicksintegerКоличество кликов UniquesIncrementintegerПрирост новых уникальных пользователей увидивших объявления впервые

selesnow/rmytarget documentation built on Oct. 22, 2021, 12:04 p.m.