fbGetMarketingStat: Get statistic by ad accounts.

Description

fbGetMarketingStat is main function of rfacebookstat package, intended for load statiscit data by your ad, adset, campaign or account

Usage

fbGetMarketingStat(accounts_id = NULL, sorting = NULL, level = "account",
                   breakdowns = NULL, action_breakdowns = NULL, fields =
                   "account_id,campaign_name,impressions,clicks,reach,spend",
                   filtering = NULL, date_start = Sys.Date() - 30,
                   date_stop = Sys.Date(), api_version = "v3.1", interval
                   = "day", console_type = "progressbar", request_speed =
                   "normal", access_token = NULL)

Arguments

accounts_id

ID of your ad account.

sorting

Field to sort the result, and direction of sorting. You can specify sorting direction by appending "_ascending" or "_descending" to the sort field. For example, "reach_descending". This array supports no more than one element. By default, the sorting direction is ascending.

level

Represents the level of result. Avable ad, adset, campaign, account.

action_breakdowns

group results in the actions field. You can use the following breakdowns for action_breakdowns, for details go - https://developers.facebook.com/docs/marketing-api/insights/breakdowns/#actionsbreakdown

breakdowns

Permutations marked with an asterisk (*) can be joined with action_type and action_target_id. Avable age, country, gender, frequency_value, hourly_stats_aggregated_by_advertiser_time_zone, hourly_stats_aggregated_by_audience_time_zone, impression_device, place_page_id, placement, device_platform, product_id, region

fields

List of fields which you want get in R.

filtering

Array of filtring parameters, on example [/'field/':/'ad.effective_status/',/'operator/':/'IN/',/'value/':[/'ARCHIVED/']

date_start

Start reporting date.

date_stop

End reporting day

request_speed

Speed beetwen API request, "normal", "fast" or "slow", depend of you API access level.

api_version

Current Facebook API version.

interval

Character value for split by time interval, one of "day", "week", "month", "quarter", "year". By default = "day"

console_type

Character value for manage console output message, one of "progressbar", "message". By default = "progressbar". See more at Detail

access_token

Your facebook API token

Value

Data frame with statistic.

Details

console_type parameters, if chose "progressbar" you can see load progress in percent, and if chose "message" you get message about loading process.

Examples

Run this code

# NOT RUN {
fbStat <- fbGetMarketingStat(accounts_id = "act_xxxxxxxxxxxxxxx",
                             level = "campaign",
                             fields = "account_name,campaign_name,impressions",
                             breakdowns = "device_platform",
                             date_start = "2016-08-01",
                             date_stop = "2016-08-10",
			     interval = "day",
                             access_token = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
# }