yadirGetCampaignList: Get Campaigns List

In serditov/ryandexdirect: Load Data From Yandex Direct

Description

Returns the parameters of campaigns that meet the specified criteria.

Usage

yadirGetCampaignList(Logins = NULL, States = c("OFF", "ON", "SUSPENDED",
                   "ENDED", "CONVERTED", "ARCHIVED"), Types =
                   c("TEXT_CAMPAIGN", "MOBILE_APP_CAMPAIGN",
                   "DYNAMIC_TEXT_CAMPAIGN", "CPM_BANNER_CAMPAIGN"),
                   Statuses = c("ACCEPTED", "DRAFT", "MODERATION",
                   "REJECTED"), StatusesPayment = c("DISALLOWED",
                   "ALLOWED"), Token = NULL, AgencyAccount = NULL,
                   TokenPath = getwd())
				   
yadirGetCampaign(Logins = NULL, States = c("OFF", "ON", "SUSPENDED",
                   "ENDED", "CONVERTED", "ARCHIVED"), Types =
                   c("TEXT_CAMPAIGN", "MOBILE_APP_CAMPAIGN",
                   "DYNAMIC_TEXT_CAMPAIGN", "CPM_BANNER_CAMPAIGN"),
                   Statuses = c("ACCEPTED", "DRAFT", "MODERATION",
                   "REJECTED"), StatusesPayment = c("DISALLOWED",
                   "ALLOWED"), Token = NULL, AgencyAccount = NULL,
                   TokenPath = getwd())

Arguments

Logins	Your Yandex Login
AgencyAccount	Your agency account login, if you get statistic from client account
TokenPath	Path to directory where you save credential data
Token	character or list object, your Yandex API Token, you can get this by function yadirGetToken or yadirAuth
States	character vector, filter by campaign states, for example c("OFF", "ON", "SUSPENDED", "ENDED", "CONVERTED", "ARCHIVED")
Types	character vector with campaign types, example c("TEXT_CAMPAIGN", "MOBILE_APP_CAMPAIGN", "DYNAMIC_TEXT_CAMPAIGN")
Statuses	character vector, filter campaign list by status, for example c("ACCEPTED", "DRAFT", "MODERATION", "REJECTED")
StatusesPayment	character vector, filter campaign list by payment status, for example c("DISALLOWED", "ALLOWED")

Value

data frame with campaings names and parameters

Author(s)

Alexey Seleznev

Examples

## Not run: 
### Please choose another TokenPath to save the Login permanently.
#Get data from client accounts
my_ad_group <- yadirGetCampaign(Login = "login",
                                TokenPath = tempdir())

#Get data from agency account
# Auth
aut <- yadirAuth(Login = "agency_login", 
                 NewUser = TRUE, 
				 TokenPath = tempdir())

# Load Ad Group List
my_ad_group <- yadirGetCampaign(Login = "client_login",
                                Token = aut,
								TokenPath     = tempdir())

## End(Not run)

serditov/ryandexdirect documentation built on May 15, 2019, 12:09 a.m.