Learn R Programming

rlinkedinads

rlinkedinads - R пакет для работы с Linkedin Advertising API.

Установка

Вы можете установить пакет rlinkedinads из GitHub с помощью:

# install.packages("pak")
pak::pak("selesnow/rlinkedinads")

Начало работы с Linkedin Advertising API

Подробное описание о начале работе с Linkedin Advertising API можно найти в [справке].

Обязательными шагами является создание вашего OAuth приложения, создать его можно на этой странице. Так же обязательным шагом является активирование Advertising API в вашем приложении, для этого перейдите в раздел "Products" вашего приложения и подайте заявку на доступ к Advertising API.

В разделе "Authorized redirect URLs for your app" вашего приложения добавьте URL - https://selesnow.github.io/rlinkedinads/inst/get_code/auth_code.html.

Авторизация

В разделе "Auth" вашего OAuth приложения вы найдёте Client ID и Client Secret, необходимые для прохождения авторизации и обновления ваших токенов. Создайте две переменные среды для их хранения в файле .Renviron.

Открыть файл для редактирования переменных среды можно командой usethis::edit_r_environ(), далее добавьте в него 2 строки:

LKD_CLIENT_ID=Client ID вашего OAuth приложения
LKD_CLIENT_SECRET=Client secret вашего OAuth приложения 

Далее используйте функцию

library(rlinkedinads)
lkd_set_login('ВАШ ЛОГИН')
lkd_auth()

Вы будете перенаправлены в браузер, после чего вы даёте разрешение пакету на доступ к данным, и полученные авторизационные данные будут закешированы на вашем жестком диске, для того, что бы не потребовалась ручная авторизация в каждой последующей сессии работы с Linkedin Advertising API.

Пример запроса данных

library(rlinkedinads)

lkd_set_login('ВАШ ЛОГИН')
lkd_set_account_id(ID ВАШЕГО РЕКЛАМНОГО АККАУНТА)

# Иерархия рекламного аккаунта
accounts        <- lkd_get_accounts()
user_accounts   <- lkd_get_accounts_by_authenticated_user()
account_users   <- lkd_get_ad_account_users_by_accounts(account_urn_id = 'urn:li:sponsoredAccount:511009658')
campaign_groups <- lkd_get_campaign_groups()
campaigns       <- lkd_get_campaigns()
creatives       <- lkd_get_creatives()

# Запрос аналитики
report <- lkd_get_ads_analytics(
      pivot            = 'CAMPAIGN',
      date_from        = '2023-01-01,
      date_to          = '2023-06-30,
      time_granularity = 'DAILY',
      fields           = c(
        'pivotValues',
        'dateRange',
        'clicks',
        'impressions',
        'dateRange',
        'costInUsd',
        'oneClickLeads',
        'externalWebsiteConversions'
      ),
      accounts  = 'urn:li:sponsoredAccount:511009658', 
      campaigns = c(
        'urn:li:sponsoredCampaign:253102116', 
        'urn:li:sponsoredCampaign:276103383'
      )
) 

Copy Link

Version

Install

install.packages('rlinkedinads')

Monthly Downloads

170

Version

0.2.0

License

MIT + file LICENSE

Maintainer

Alexey Seleznev

Last Published

January 29th, 2024

Functions in rlinkedinads (0.2.0)

lkd_get_accounts_by_authenticated_user

Find Ad Accounts by Authenticated User All ad accounts that an authenticated user has access
lkd_remove_token

remove token
lkd_set_account_id

Set Ad Account ID for R session
lkd_get_ads_analytics

Get Linkedin ads analytics The Analytics Finder should be used when specifying a single pivot.
lkd_get_campaigns

Get campaigns
lkd_get_creatives

Get Creatives You can search for creative content in order to get a collection of creatives matching
lkd_get_ad_account_users_by_accounts

lkd_get_campaign_groups

Get Ad campaign Groups Campaign groups provide advertisers a way to manage status, budget, and performance across multiple related campaigns.
lkd_set_api_version

lkd_set_client_id

lkd_auth

Authorization in Linkedin API
lkd_set_token_path

Set own token cache path
lkd_get_accounts

Get account list
lkd_set_client_secret

lkd_set_login

Set login for current R session
rlinkedinads-package

rlinkedinads: Load Data from 'Linkedin Advertising API'