#' Check object target
#'
#' @description Retrieves the targeting description (in sentence lines)
#' of a specific ad or adset. See \code{\link{checkTargetTree}}
#'
#' @param id ID of object to retrieve.
#' @param n Number of results to retrieve, defaults to \code{100}. When you make an API request, you will usually not receive all of the results of that request in a single response. This is because some responses could contain thousands of objects so most responses are paginated by default. \code{previous} fetches the previous page of response (after the initial query) similarly \code{next} fetches the next page and \code{NULL} does not paginate (only makes one query).
#' @param token A valid token as returned by \code{\link{fbAuthenticate}} or a short-term token from \href{https://developers.facebook.com/tools/explorer}{facebook Graph API Explorer}.
#' @param limit
#' Number of results requested at each API call, defaults to 100.
#' Sometimes useful to bring it down if many results (\code{n}) are required as the
#' API might otherwise return \code{error_code: 1} or in other words an
#' "Unknown error".
#'
#' @return Returns a \code{data.frame} containing targeting sentences as columns.
#'
#' @details Corresponds to this API call; \url{https://developers.facebook.com/docs/marketing-api/targeting-description/v2.7}
#'
#' @examples
#' \dontrun{
#' # get information on account
#' ads <- grabAds(account.id = "act_123456789012345", token = "XXXXXXXXXXX")
#'
#' # pick random ad.id
#' rand_id <- sample(ads$id, 1)
#'
#' # fetch targeting description of random ad
#' checkTargetSentence(id = rand_id, n = 100, token = "XXXXXXXXXXX")
#' }
#'
#' @seealso \code{\link{checkTargetTree}}
#'
#' @author John Coene \email{jcoenep@@gmail.com}
#'
#' @export
checkTargetSentence <- function(id, token, n = 100, limit = 100){
# check inputs
if(missing(id)){
stop("Missing id")
} else if (missing(token)){
stop("Missing token")
}
# check token
token <- checkToken(token = token)
# build url
url <- paste0("https://graph.facebook.com/v2.8/",
id, "/targetingsentencelines?limit=", limit,
"&access_token=", token)
# call api
response <- httr::GET(url)
# parse to list
json <- rjson::fromJSON(rawToChar(response$content))
# check if query successful
if(length(json$error$message)){
stop(paste("this is likely due to account.id or token. Error Message returned: ",
json$error$message))
}
# check if data returned
if (length(json$targetingsentencelines)) {
# parse
dat <- do.call(plyr::"rbind.fill",
lapply(json$targetingsentencelines, as.data.frame))
# dat
dat <- processCheck(dat)
} else if (!length(json$targetingsentencelines)) {
# create empty data.frame to return
dat <- data.frame()
}
if (nrow(dat) == 0) warning(paste("No data."), call. = FALSE)
return(dat)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.