yadirGetCampaignList: Get campaign list from yandex direct account

Description Usage Arguments Value Author(s) Examples

Description

yadirGetCampaignList get campaings names and parameters

Usage

1
2
3
4
5
6
7
8
yadirGetCampaignList(Logins          = NULL, 
                     States          = c("OFF","ON","SUSPENDED","ENDED","CONVERTED","ARCHIVED"),
                     Types           = c("TEXT_CAMPAIGN","MOBILE_APP_CAMPAIGN","DYNAMIC_TEXT_CAMPAIGN"),
                     Statuses        = c("ACCEPTED","DRAFT","MODERATION","REJECTED"),
                     StatusesPayment = c("DISALLOWED","ALLOWED"),
                     Token           = NULL,
                     AgencyAccount = NULL,
                     TokenPath     = getwd())

Arguments

Login

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"). to get all campaigns, including beta-"SMART_BANNER_CAMPAIGN" and "MCBANNER_CAMPAIGN", set c("ALL")

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
#Get data from client accounts
library(ryandexdirect)
my_ad_group <- yadirGetCampaignList(Login = "login")

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

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

grkhr/ryandexdirect documentation built on Dec. 10, 2019, 2:28 p.m.