R/environments.R

In googleTagManageR: Access the 'Google Tag Manager' API using R

#' List the containers
#' 
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/environments/list}
#' @family environment functions
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#'
#' @description
#'
#' This lists the environments in a specified container.
#' 
#' @examples 
#' \dontrun{
#' accountId <- 1234567
#' containerId <- 7654321
#' 
#' environments <- gtm_environments_list(accountId, containerId)
#' 
#' }
#' 
#' @export
gtm_environments_list <- function(account_id,container_id) {
  
  if (any(missing(account_id),
          missing(container_id)
  )) {
    stop("Account Id and Container Id are required for this function")
  }
  
  path_args <- list(
    accounts = account_id,
    containers = container_id,
    environments = ""
  )
  res <- gtm_list(path_args = path_args, type = "environment")
  return(res)
}

#' This gets the metadata for a single GTM Environment
#' 
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/environments/get}
#' @family environment functions
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#' @param environment_id Environment Id
#'
#' @description
#'
#' This gets the metadata for a single GTM Environment
#' 
#' @examples 
#' \dontrun{ 
#' accountId <- 1234567
#' containerId <- 7654321
#' environmentId <- 3
#' 
#' environmnet <- gtm_environments_get(accountId, containerId, environmentId)
#' 
#' }
#' @export
gtm_environments_get <- function(account_id,container_id,environment_id){
  
  if (any(missing(account_id),
         missing(container_id),
         missing(environment_id)
  )) {
    stop("Account Id, Container Id and Environment Id are required for this function")
  }
  
  path_args <- list(
    accounts = account_id,
    containers = container_id,
    environments = environment_id
  )
  res <- gtm_get(path_args = path_args)
  return(res)
}

#' Create an environment
#' 
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/environments/update}
#' @family environment functions
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#' 
#' @param name The environment display name. Can be set or changed only on USER type environments.
#' @param description The environment description. Can be set or changed only on USER type environments.
#' @param debug Whether or not to enable debug by default for the environment.
#' @param url Default preview page url for the environment.
#'
#' @description
#'
#' This creates a new GTM environment
#' 
#' @examples 
#' \dontrun{
#' accountId <- 1234567
#' containerId <- 7654321
#' 
#' env <- gtm_environments_create(accountId, containerId, "Development")
#' 
#' pp_env <- gtm_environments_create(accountId, 
#'                                   containerId, 
#'                                   "Pre-Prod", 
#'                                   debug=TRUE, 
#'                                   url="https://pp.example.com")
#' }
#' 
#' @export
gtm_environments_create <- function(account_id, container_id, name, description = NULL, debug=c("TRUE","FALSE"), url = NULL) {
  
  if (any(missing(account_id),
         missing(container_id)
  )) {
    stop("Account Id and Container Id are both required for this function")
  }
  
  if (missing(name)) stop("An environment name is required for this function")
  if (missing(debug)) debug <- "FALSE"
  
  debug<-match.arg(debug)
  
  path_args <- list(
    accounts = account_id,
    containers = container_id,
    environments = ""
  )
  
  body <- list(
    name = name,
    description = description,
    debug = debug,
    url = url
  )
  
  res <- gtm_create(path_args = path_args, body = body)
  return(res)
}

#' Update an environment
#' 
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/environments/update}
#' @family environment functions
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#' @param environment_id Environment Id
#' @param name The environment display name. Can be set or changed only on USER type environments.
#' @param description The environment description. Can be set or changed only on USER type environments.
#' @param debug Whether or not to enable debug by default for the environment.
#' @param url Default preview page url for the environment.
#'
#' @description
#'
#' This updates a GTM environment
#' 
#' @examples 
#' \dontrun{
#' 
#' accountId <- 1234567
#' containerId <- 7654321
#' 
#' gtm_environments_update(accountId, containerId, "Pre-Prod", url="https://new-pp.example.com")
#' }
#' 
#' @export
gtm_environments_update <- function(account_id, container_id ,environment_id, name, description = NULL, debug=c("TRUE","FALSE"), url = NULL){
  
  if (any(missing(account_id),
         missing(container_id),
         missing(environment_id)
  )) {
    stop("Account Id, Container Id and Environment Id are required for this function")
  }
  
  if (missing(name)) stop("An environment name is required for this function")
  if (missing(debug)) debug <- "FALSE"
  
  debug <- match.arg(debug)
  
  path_args <- list(
    accounts = account_id,
    containers = container_id,
    environments = environment_id
  )
  
  body <- list(
    name = name,
    description = description,
    debug = debug,
    url = url
  )
  
  res <- gtm_update(path_args = path_args, body = body)
  
  return(res)
}

#' Delete an environment
#' 
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/environments/reauthorize}
#' @family environment functions
#' @importFrom utils menu
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#' @param environment_id Environment Id
#' @param force This will bypass the user confirmation. Useful for scripted functions to avoid user input
#'
#' @description
#'
#' This deletes a GTM environment
#' 
#' @examples 
#' \dontrun{
#' accountId <- 1234567
#' containerId <- 7654321
#' environmentId <- 3
#' 
#' gtm_environments_delete(accountId, containerId, environmentId, TRUE)
#' 
#' environmentId <- 4
#' 
#' gtm_environments_delete(accountId, containerId, environmentId)
#' 
#' #  This will delete environment 4 Are you sure you want to continue?"
#' 
#' #  1: Yes
#' #  2: No
#' 
#' # Selection: 1
#' 
#' 
#' # Environment 4 has been deleted.
#' 
#' }
#' 
#' @export
gtm_environments_delete <- function(account_id, container_id, environment_id, force = c("TRUE","FALSE")) {
  
  if (any(missing(account_id),
         missing(container_id),
         missing(environment_id)
  )) {
    stop("Account Id, Container Id and Environment Id are required for this function")
  }
  
  if (missing(force)) force <- "FALSE"
  force <- as.character(force)
  force <- match.arg(force)
  force <- as.logical(force)
  
  path_args <- list(
    accounts = account_id,
    containers = container_id,
    environments = environment_id
  )
  
  if (force) {
    res <- gtm_delete(path_args = path_args)
    if (length(res) == 0) {
      myMessage(sprintf("Environment %s has been deleted", environment_id), level = 3)
    }
  } else {
    switch(
      menu(c("Yes", "No"),
           title = sprintf("This will delete environment %s. Are you sure you want to continue?", environment_id)), {
             res <- gtm_delete(path_args = path_args)
             }, {
               cancelled()
               }
    )
    }
  if (length(res) == 0) {
    myMessage(sprintf("Environment %s has been deleted", environment_id), level = 3)
  }
}


#' Reauthorise an existing GTM environment
#' 
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/environments/reauthorize}
#' @family environment functions
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#' @param environment_id Environment Id
#' @param environment An Environment object - If you don't have one, one will be generated for you.
#'
#' @description
#'
#' This reauthorises an existing GTM environment, generating a new authrorisation Id.
#' This is used to invalidate any existing preview GTM shared preview links and any installations
#' of the environment. You will need to update any snippets on your site with the new authorisation Id
#' afterwards.
#' 
#' @examples 
#' \dontrun{
#' 
#' accountId <- 1234567
#' containerId <- 7654321
#' environmentId <- 4
#' 
#' env <- gtm_environments_reauthorize(accountId, containerId, enviromentId)
#' 
#' }
#' 
#' @export
gtm_environments_reauthorize<-function(account_id, container_id, environment_id, environment){
  if (any(missing(account_id),
         missing(container_id),
         missing(environment_id)
  )) {
    stop("Account Id, Container Id and Environment Id are required for this function")
  }
  
  if (missing(environment)){
    environment = list(
      accountId = account_id,
      containerId = container_id
    )
  }
  
  path_args <- list(
    accounts = account_id,
    containers = container_id,
    environments = environment_id
  )
  
  res <- gtm_action(path_args = path_args, action = "reauthorize", body = environment)
  return(res)
}