yadirGetAds: Get Ads List From 'Yandex Direct' account

In ryandexdirect: Load Data From 'Yandex Direct'

Get Ads List From 'Yandex Direct' account

Description

Returns the parameters of ads that match the specified criteria.

Usage

yadirGetAds(CampaignIds   = NULL, 
            AdGroupIds    = NA, 
            Ids           = NA, 
            Types         = c("TEXT_AD", "MOBILE_APP_AD", "DYNAMIC_TEXT_AD", 
                              "IMAGE_AD", "CPC_VIDEO_AD", "CPM_BANNER_AD", 
                              "CPM_VIDEO_AD", "SMART_AD"),
            States        = c("OFF","ON","SUSPENDED","OFF_BY_MONITORING","ARCHIVED"), 
            Login         = getOption("ryandexdirect.user"),
            Token         = NULL,
            AgencyAccount = getOption("ryandexdirect.agency_account"),
            TokenPath     = yadirTokenPath())

Arguments

CampaignIds	character vector with yandex direct campaign ID, require
AdGroupIds	character vector with yandex direct adgroup ID
Ids	character vector with yandex direct ad ID
Types	character vector, types of ads: TEXT_AD, MOBILE_APP_AD, DYNAMIC_TEXT_AD, IMAGE_AD, CPC_VIDEO_AD, CPM_BANNER_AD, CPM_VIDEO_AD, SMART_AD
States	character vector with ad states
Login	character, your login at Yandex, require
Token	character, your Yandex Direct API Token, require
AgencyAccount	Your agency account login, if you get statistic from client account
TokenPath	Path to directory where you save credential data

Value

Data Frame

Author(s)

Alexey Seleznev

Examples

## Not run: 
### Please choose another TokenPath to save the Login permanently.
#For get ads data frame
# Get ads from client account
aut <- yadirAuth(Login = "login", NewUser = TRUE,
                 TokenPath = tempdir())
my_ads  <- yadirGetAds(Login = "login",
                       Token = aut)
					   
# Get data from agency account
aut <- yadirAuth(Login = "agency_login", NewUser = TRUE,
                 TokenPath = tempdir())

my_ads  <- yadirGetAds(Login = "client_login",
					   AgencyAccount = "agency_login",
                       Token = aut)

## End(Not run)

ryandexdirect documentation built on March 31, 2023, 5:35 p.m.