yadirGetReport: Get report from yandex direct Report service

Description Usage Arguments Details Value Author(s) Examples

View source: R/yadirGetReport.R

Description

yadirGetReport get data frame with Report data from Report Yandex Direct Service

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
yadirGetReport(ReportType = "CAMPAIGN_PERFORMANCE_REPORT", 
               DateRangeType = "LAST_MONTH", 
               DateFrom = NULL, 
               DateTo = NULL, 
               FieldNames = c("CampaignName","Impressions","Clicks","Cost"), 
               FilterList = NULL,
               IncludeVAT = "NO",
               IncludeDiscount = "NO",
               Login = NULL,
               Token = NULL)

Arguments

ReportType

Report level, one from ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, CUSTOM_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT. For detail go https://tech.yandex.ru/direct/doc/reports/type-docpage/

DateRangeType

Reporting period, one from TODAY, YESTERDAY, LAST_3_DAYS, LAST_5_DAYS, LAST_7_DAYS, LAST_14_DAYS, LAST_30_DAYS, LAST_90_DAYS, LAST_365_DAYS, THIS_WEEK_MON_TODAY ,THIS_WEEK_SUN_TODAY, LAST_WEEK, LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT, THIS_MONTH, LAST_MONTH, ALL_TIME, CUSTOM_DATE, AUTO. For detail go https://tech.yandex.ru/direct/doc/reports/period-docpage/

DateFrom

If your select CUSTOM_DATE in DateRangeType you must enter start date in this argument in YYYY-MM-DD format else you can not used this argument

DateTo

If your select CUSTOM_DATE in DateRangeType you must enter end date in this argument in YYYY-MM-DD format else you can not used this argument

FieldNames

Character vector with field names list, for example c("Date","CampaignName","Impressions","Clicks"), for more ditails go https://tech.yandex.ru/direct/doc/reports/fields-list-docpage/

FilterList

Character vector with rows filters, for example c("Clicks GREATER_THAN 99","Impressions LESS_THAN 1000"), for more details go https://tech.yandex.ru/direct/doc/reports/filters-docpage/

IncludeVAT

Include or exclude VAT, one of "NO" or "YES"

IncludeDiscount

Include or exclude Discount, one of "NO" or "YES"

Login

Your Yandex Login

Token

Your Yandex API Token

Details

For more details about Report service go https://tech.yandex.ru/direct/doc/reports/reports-docpage/

Value

data frame with campaings names and parameters

Author(s)

Alexey Seleznev

Examples

1
2
#For get Report
My_report <- yadirGetReport(ReportType = "CAMPAIGN_PERFORMANCE_REPORT", DateRangeType = "LAST_MONTH", DateFrom = NULL, DateTo = NULL, FieldNames = c("CampaignName","Impressions","Clicks"), FilterList = c("Clicks GREATER_THAN 99","Impressions LESS_THAN 1000"), Login = <YourLogin>, Token = <YourToken>)

alex-www-marketing/ryandexdirect_edit documentation built on May 4, 2019, 10:57 a.m.