R/fb_campaign.R

In fbRads: Analyzing and Managing Facebook Ads from R

#' Created Ad Campaign
#' @inheritParams fbad_request
#' @param buying_type Facebook optimization algorithm to delivery, pricing, and limits
#' @param campaign_status initial status of the Ad Campaign
#' @param execution_options special execution settings passed to the API
#' @param name Ad Campaign name
#' @param objective the campaign's objective
#' @param spend_cap spend cap of the campaign
#' @return Ad Campaign id
#' @export
#' @references \url{https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group#Creating}
fbad_create_campaign <- function(fbacc, buying_type = c('AUCTION', 'FIXED_CPM', 'RESERVED'),
                                 campaign_status = c('ACTIVE', 'PAUSED'),
                                 execution_options = NULL, name,
                                 objective = c(
                                     'BRAND_AWARENESS', 'CANVAS_APP_ENGAGEMENT',
                                     'CANVAS_APP_INSTALLS', 'CONVERSIONS',
                                     'EVENT_RESPONSES', 'EXTERNAL', 'LEAD_GENERATION',
                                     'LINK_CLICKS', 'LOCAL_AWARENESS',
                                     'MOBILE_APP_ENGAGEMENT', 'MOBILE_APP_INSTALLS',
                                     'OFFER_CLAIMS', 'PAGE_LIKES', 'POST_ENGAGEMENT',
                                     'PRODUCT_CATALOG_SALES', 'VIDEO_VIEWS'),
                                 spend_cap = NULL) {

    fbacc <- fbad_check_fbacc()
    if (missing(name))
        stop('A campaign name is required.')

    buying_type           <- match.arg(buying_type)

    ## build params list
    params <- list(
        buying_type       = buying_type,
        objective         = objective,
        name              = name,
        execution_options = execution_options,
        spend_cap         = spend_cap,
        objective         = match.arg(objective),
        campaign_status   = match.arg(campaign_status))

    ## drop NULL args
    params <- as.list(unlist(params, recursive = FALSE))

    ## get results
    res <- fbad_request(fbacc,
                        path   = paste0('act_', fbacc$account_id, '/campaigns'),
                        method = "POST",
                        params = params)

    ## return Ad Campaign ID on success
    fromJSONish(res)$id

}


#' Read Ad Campaign details
#' @inheritParams fbad_read_ad
#' @param id Ad Campaign id(s)
#' @export
#' @references \url{https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group#Reading}
fbad_read_campaign <- fbad_read_ad


#' Update Ad Campaign
#' @inheritParams fbad_update_ad
#' @param id Ad Campaign id
#' @export
#' @references \url{https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group#Updating}
fbad_update_campaign <- fbad_update_ad


#' List all Ad Campaigns for current account
#' @inheritParams fbad_list_ad
#' @param id not supported argument
#' @export
#' @references \url{https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group#Reading}
fbad_list_campaign <- fbad_list_ad