R/GetDiscoverEnabled.R

Defines functions GetDiscoverEnabled

Documented in GetDiscoverEnabled

#' @details This function requires having a character vector with one or more valid Report Suites specified.
#'
#' @description Get whether Discover is enabled for the specified report suites.
#'
#' @title Get Whether Discover is Enabled for a Report Suite(s)
#'
#' @param reportsuite.ids Report suite id (or list of report suite ids)
#'
#' @importFrom jsonlite toJSON
#' @importFrom plyr rbind.fill
#'
#' @return Data frame
#'
#' @export
#'
#' @examples
#' \dontrun{
#' discenable <- GetDiscoverEnabled("your_report_suite")
#'
#' discenable2 <- GetDiscoverEnabled(report_suites$rsid)
#' }

GetDiscoverEnabled <- function(reportsuite.ids) {

  request.body <- c()
  request.body$rsid_list <- reportsuite.ids

  #Hack in locale, every method calls ApiRequest so this hopefully works
  #Set encoding to utf-8 as well; if someone wanted to do base64 they are out of luck
  request.body$locale <- unbox(AdobeAnalytics$SC.Credentials$locale)
  request.body$elementDataEncoding <- unbox("utf8")

  response <- ApiRequest(body=toJSON(request.body),func.name="ReportSuite.GetDiscoverEnabled")

  #Don't even know if this is possible, holdover from GetSegments code
  if(length(response$discover_enabled[[1]]) == 0) {
      return(print("Discover Not Enabled For This Report Suite"))
    }

  return(response)

}

Try the RSiteCatalyst package in your browser

Any scripts or data that you put into this service are public.

RSiteCatalyst documentation built on Nov. 6, 2019, 5:09 p.m.