Merge pull request #91 from daroczig/v2.11

V2.11

Author: daroczig

DESCRIPTION

@@ -7,8 +7,8 @@ Title: Analyzing and Managing Facebook Ads from R
 Description: Wrapper functions around the Facebook Marketing 'API' to create,
     read, update and delete custom audiences, images, campaigns, ad sets, ads and
     related content.
-Version: 2.10.0
-Date: 2017-11-01
+Version: 2.11.0
+Date: 2018-04-28
 URL: https://github.com/daroczig/fbRads
 License: AGPL-3
 Imports:

NAMESPACE

@@ -15,6 +15,10 @@ export(fbad_create_lookalike_audience)
 export(fbad_delete_audience)
 export(fbad_get_adaccount_details)
 export(fbad_get_adaccounts)
+export(fbad_get_client_ad_accounts)
+export(fbad_get_client_pages)
+export(fbad_get_owned_ad_accounts)
+export(fbad_get_owned_pages)
 export(fbad_get_pixels)
 export(fbad_get_search)
 export(fbad_init)

NEWS

@@ -1,3 +1,72 @@
+fbRads 2.11.0 (2018-04-28)
+----------------------------------------------------------------
+
+Add support for Facebook Marketing API v2.11
+
+* get Pages and Ad Accounts of the clients of a Business Ad Account
+
+Fixes:
+
+* more standardized simplify argument when listing / reading Facebook objects
+* RCurl issues with Unicode characaters
+* further retries on (temporarily) SSL and network errors
+
+fbRads 2.10.0 (2017-11-01)
+----------------------------------------------------------------
+
+Add support for Facebook Marketing API v2.10
+
+Fixes:
+
+* further retries on (temporarily) SSL and network errors
+* improved malformed JSON parsing
+* improved paging of API results
+
+fbRads 2.9.0 (2017-07-21)
+----------------------------------------------------------------
+
+Add support for Facebook Marketing API v2.9:
+
+Fixes:
+
+* paging when listing all Ad Accounts on a Business Account
+* look-up pixels
+* simplify argument improvements
+* doc tweaks on how to generated a token
+
+fbRads 0.2 (2017-04-18)
+----------------------------------------------------------------
+
+Add support for Facebook Marketing API v2.8: #51
+
+Fixes:
+
+* remove line-breaks in malformed JSON returned by Facebook
+* simplify argument introduced for listing and reading Facebook objects
+
+fbRads 0.2 (2016-10-12)
+----------------------------------------------------------------
+
+Add support for Facebook Marketing API v2.7: #36
+
+* subtype for custom & lookalike audiences
+* business_management scope needed to manage ads
+
+Fixes:
+
+* return actual error message from Facebook
+* always retry failed sync Insights API requests as async
+
+fbRads 0.2 (2016-07-27)
+----------------------------------------------------------------
+
+Add support for Facebook Marketing API v2.6: #25
+
+Fixes:
+
+* timeout async queries after 45 mins
+* further retries on (temporarily) SSL and network errors
+
 fbRads 0.2 (2016-04-04)
 ----------------------------------------------------------------
 

R/fb_init.R

@@ -1,7 +1,7 @@
 #' Returns the most recent version of the supported Facebook Marketing API
 #' @return string
 #' @export
-fb_api_most_recent_version <- function() '2.10'
+fb_api_most_recent_version <- function() '2.11'
 
 #' Returns the currently used version of the Facebook Marketing API
 #' @return string
@@ -332,16 +332,16 @@ fbad_request_next_page <- function(url) {
     fromJSONish(res)
 }
 
-#' Get account details belonging to eg an Ad or Business Manager Account
-#' @references \url{https://developers.facebook.com/docs/marketing-api/reference/ad-account#Reading}
+#' Get account details of Ad Accounts owned by a Business Manager Account
+#' @references \url{https://developers.facebook.com/docs/marketing-api/businessmanager/assets#adaccounts}
 #' @param id Facebook Object, eg Ad Account (with \code{act} prefix) or a Business Manager Account ID
 #' @param token FB Ads API token (if running before \code{fb_init})
 #' @param version Facebook Marketing API version (if running before \code{fb_init})
 #' @param fields character vector
 #' @param simplify return \code{data.frame} or \code{list}
 #' @return list(s) containing account details
 #' @export
-fbad_get_adaccounts <- function(id, token, version, fields = c('name'), simplify = TRUE) {
+fbad_get_owned_ad_accounts <- function(id, token, version, fields = c('name'), simplify = TRUE) {
 
     ## look up function name to know what API endpoint to use
     fn <- deparse(match.call()[[1]])
@@ -363,7 +363,11 @@ fbad_get_adaccounts <- function(id, token, version, fields = c('name'), simplify
 
     res <- fromJSONish(fbad_request(
         path   = file.path(id, switch(fn,
+                                      'fbad_get_client_ad_accounts' = 'client_ad_accounts',
+                                      'fbad_get_owned_ad_accounts' = 'owned_ad_accounts',
                                       'fbad_get_adaccounts' = 'owned_ad_accounts',
+                                      'fbad_get_client_pages' = 'client_pages',
+                                      'fbad_get_owned_pages' = 'owned_pages',
                                       'fbad_get_pixels' = 'adspixels')),
         method = 'GET',
         params = list(
@@ -388,15 +392,39 @@ fbad_get_adaccounts <- function(id, token, version, fields = c('name'), simplify
 }
 
 
+#' Get account details of Ad Accounts belonging to the clients of a Business Manager Account
+#' @inheritParams fbad_get_owned_ad_accounts
+#' @export
+fbad_get_client_ad_accounts <- fbad_get_owned_ad_accounts
+
+
+#' Deprecated in favor of \code{fbad_get_owned_adaccounts}
+#' @inheritParams fbad_get_owned_ad_accounts
+#' @export
+fbad_get_adaccounts <- fbad_get_owned_ad_accounts
+
+
+#' Get account details of Pages belonging to the clients of a Business Manager Account
+#' @inheritParams fbad_get_owned_ad_accounts
+#' @export
+fbad_get_client_pages <- fbad_get_owned_ad_accounts
+
+
+#' Get account details of Pages owned by a Business Manager Account
+#' @inheritParams fbad_get_owned_ad_accounts
+#' @export
+fbad_get_owned_pages <- fbad_get_owned_ad_accounts
+
+
 #' Get tracking pixels of eg an Ad or Business Manager Account
 #' @references \url{https://developers.facebook.com/docs/marketing-api/reference/ads-pixel/#Reading}
-#' @inheritParams fbad_get_adaccounts
+#' @inheritParams fbad_get_owned_ad_accounts
 #' @param token FB Ads API token
 #' @param version Facebook Marketing API version
 #' @param fields character vector
 #' @return list(s) containing Ads Pixels
 #' @export
-fbad_get_pixels <- fbad_get_adaccounts
+fbad_get_pixels <- fbad_get_owned_ad_accounts
 
 
 #' Initiate Facebook Account with OAuth token

README.md

@@ -28,7 +28,7 @@ To be able to use this package, you will have to create a Facebook App and autho
 7. Please note the above last step: we store the token as a string. Now you can save that token in a safe place and start using `fbRads`, eg:
 
     ```r
-    fbad_init(accountid = accountid, token = tkn, version = '2.10')
+    fbad_init(accountid = accountid, token = tkn, version = '2.11')
     ```
 
 8. And list all your ads along with the ad name and status or eg filter for the active ads: