R/tags.R

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

#' List all tags in a workspace
#' 
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/workspaces/tags/list}
#' @family tag functions
#' 
#' @description
#'
#' This will return a data frame all your available tags in a given workspace
#' If you want to get the information for a single tag, use \code{gtm_tags_get}
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#' @param workspace_id Workspace Id
#' 
#' @examples
#' 
#' \dontrun{
#' accountId <- 1234567
#' containerId <- 7654321
#' workspaceId <- 10
#' 
#' tags <- gtm_tags_list(accountId, containerId, workspaceId)
#' 
#' }
#' 
#' @export
gtm_tags_list <- function(account_id, container_id, workspace_id) {
  if (any(missing(account_id),
          missing(container_id),
          missing(workspace_id)
  )) {
    stop("Account Id, Container Id and Workspace Id are all required for this function")
  }
  path_args <- list(
    accounts = account_id,
    containers = container_id,
    workspaces = workspace_id,
    tags = ""
  )
  res <- gtm_list(path_args = path_args, type = "tag")
  return(res)
}

#' Get one tag in a workspace
#' 
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/workspaces/tags/get}
#' @family tag functions
#' 
#' @description
#'
#' This will return a list with the settings of a single tag.
#' If you want to get the information for all tags, use \code{gtm_tags_list}
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#' @param workspace_id Workspace Id
#' @param tag_id Tag Id
#' 
#' @examples
#' 
#' \dontrun{
#' accountId <- 1234567
#' containerId <- 7654321
#' workspaceId <- 10
#' tagId = 100
#' 
#' tag <- gtm_tags_get(accountId, containerId, workspaceId, tagId)
#' 
#' }
#' 
#' @export
gtm_tags_get <- function(account_id,container_id,workspace_id,tag_id) {
  
  if (any(missing(account_id),
          missing(container_id),
          missing(workspace_id),
          missing(tag_id)
  )) {
    stop("Account Id, Container Id, Workspace Id and Tag Id are all required for this function")
  }
  
  path_args <- list(
    accounts = account_id,
    containers = container_id,
    workspaces = workspace_id,
    tags = tag_id
  )
  
  res <- gtm_get(path_args)
  return(res)
}

#' Create a new tag
#'
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/workspaces/tags/create}
#' @family tag functions
#' 
#' @description
#'
#' This takes a tag resource and creates a new tag in GTM.
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#' @param workspace_id Workspace Id
#' @param tag_object Tag Object
#' 
#' @examples 
#' \dontrun{
#' 
#' accountId <- 1234567
#' containerId <- 7654321
#' workspaceId <- 5
#' # In the Tag Object below you will need to substitute your own trigger Id - 
#' # see \code{gtm_triggers_list} and \code{gtm_triggers_create}
#' tag <- list(
#'   name = "Example DataLayer Push",
#'   type = "html",
#'   tagFiringOption = "oncePerEvent",
#'   parameter = list(
#'     list(
#'       type = "template",
#'       key = "html",
#'       value = "<script>\n   
#'                window.dataLayer=window.dataLayer||[];\n   
#'                window.dataLayer.push({\"event\": \"demoEvent\"});\n
#'                </script>"
#'     ),
#'     list(
#'       type = "boolean",
#'       key = "supportDocumentWrite",
#'       value = "false"
#'     )
#'   ),
#'   firingTriggerId = 20,
#'   tagFiringOption = "oncePerPage"
#' )
#' 
#' newTag <- gtm_tags_create(accountId, containerId, workspaceId, tag)
#' }
#' @export
gtm_tags_create <- function(account_id,container_id,workspace_id,tag_object) {
  
  if (any(missing(account_id),
          missing(container_id),
          missing(workspace_id)
  )) {
    stop("Account Id, Container Id, Workspace Id and Tag Id are all required for this function")
  }
  
  if (missing(tag_object)) stop("A Tag Object is required for this function")
    
  path_args <- list(
    accounts = account_id,
    containers = container_id,
    workspaces = workspace_id,
    tags = ""
  )
  res <- gtm_create(path_args = path_args, body = tag_object)
  
  myMessage(sprintf("Tag %s (%s) has been created",res$name,res$tagId),level=3)
  
  return(res)
}


#' Update an existing tag
#'
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/workspaces/tags/update}
#' @family tag functions
#' 
#' @description
#'
#' This takes a tag resource and overwrites the existing tag in GTM
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#' @param workspace_id Workspace Id
#' @param tag_id Tag Id
#' @param tag_object Tag Object
#' 
#' @examples 
#' \dontrun{
#' 
#' accountId <- 1234567
#' containerId <- 7654321
#' workspaceId <- 5
#' tagId <- 11
#' 
#' tag <- list(
#'   name = "Example DataLayer Push",
#'   type = "html",
#'   tagFiringOption = "oncePerEvent",
#'   parameter = list(
#'     list(
#'       type = "template",
#'       key = "html",
#'       value = "<script>\n   window.dataLayer=window.dataLayer||[];\n   
#'                window.dataLayer.push({\"event\": \"demoEvent\"});\n
#'                </script>"
#'     ),
#'     list(
#'       type = "boolean",
#'       key = "supportDocumentWrite",
#'       value = "false"
#'     )
#'   ),
#'   firingTriggerId = 20,
#'   tagFiringOption = "oncePerPage"
#' )
#' 
#' updatedTag <- gtm_tags_update(accountId, containerId, workspaceId, tagId, tag)
#' }
#' 
#' @export
gtm_tags_update <- function(account_id, container_id, workspace_id, tag_id, tag_object) {
  
  if (any(missing(account_id),
          missing(container_id),
          missing(workspace_id),
          missing(tag_id)
  )) {
    stop("Account Id, Container Id, Workspace Id and Tag Id are all required for this function")
  }
  
  if (missing(tag_object)) stop("A Tag Object is required for this function")
  
    path_args <- list(
      accounts = account_id,
      containers = container_id,
      workspaces = workspace_id,
      tags = tag_id
    )
    res <- gtm_update(path_args = path_args, body = tag_object)
    myMessage(sprintf("Tag %s (%s) has been updated", res$name, res$tagId),
              level = 3)
    return(res)
  }

#' Delete a tag
#'
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/workspaces/tags/delete}
#' @family tag functions
#' @importFrom utils menu
#' 
#' @description
#'
#' This deletes a tag in a GTM workspace
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#' @param workspace_id Workspace Id
#' @param tag_id Tag Id
#' @param force Force deletion without user input
#' 
#' @examples
#' 
#' \dontrun{
#' accountId <- 1234567
#' containerId <- 7654321
#' workspaceId <- 10
#' tagId <- 100
#' 
#' gtm_tags_delete(accountId, containerId, workspaceId, tagId)
#' 
#' # This will delete tag %s. Are you sure you want to continue?
#' 
#' #  1: Yes
#' #  2: No
#'
#' # Selection: 1
#' 
#' # Tag 100 has been deleted.
#' 
#' tagId = 101
#' 
#' gtm_tags_delete(accountId, containerId, workspaceId, tagId, "TRUE")
#' 
#' # Tag 101 has been deleted.
#' 
#' }
#' 
#' @export
gtm_tags_delete <-function(account_id, container_id, workspace_id, tag_id, force = c("TRUE","FALSE")) {

    if(any(missing(account_id),
         missing(container_id),
         missing(workspace_id),
         missing(tag_id)
    )){
      stop("Account Id, Container Id, Workspace Id and Tag Id are all required for this function")
    }
    
    path_args <- list(
      accounts = account_id,
      containers = container_id,
      workspaces = workspace_id,
      tags = tag_id
    )
    
    if (missing(force)) force <- "FALSE"
    force <- as.character(force)
    force <- match.arg(force)
    force <- as.logical(force)
    
    if (force) {
      res <- gtm_delete(path_args = path_args)
    } else {
      switch(
        menu(c("Yes", "No"),
             title = sprintf("This will delete tag %s. Are you sure you want to continue?", tag_id)),
        {
          res <- gtm_delete(path_args = path_args)
        },
        {
          cancelled()
        }
      )
    }
    if (length(res) == 0) {
      myMessage(sprintf("Tag %s has been deleted", tag_id), level = 3)
    }
    return()
  }

#' Reverts a tag,
#'
#' @seealso \url{https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/workspaces/tags/revert}
#' @family tag functions
#' 
#' @description
#'
#' This reverts a tag back to its original, unmodified state.
#' 
#' @param account_id Account Id
#' @param container_id Container Id
#' @param workspace_id Workspace Id
#' @param tag_id Tag Id
#' 
#' @examples
#' 
#' \dontrun{
#' accountId <- 1234567
#' containerId <- 7654321
#' workspaceId <- 10
#' tagId <- 102
#' 
#' tag <- gtm_tags_revert(accountId, containerId, workspaceId, tagId)
#' 
#' # Changes to tag 102 have been reverted
#' }
#' 
#' @export
gtm_tags_revert <- function(account_id, container_id, workspace_id, tag_id) {
  
  if (any(missing(account_id),
         missing(container_id),
         missing(workspace_id),
         missing(tag_id)
  )) {
    stop("Account Id, Container Id, Workspace Id and Tag Id are all required for this function")
  }
  
  path_args <- list(
    accounts = account_id,
    containers = container_id,
    workspaces = workspace_id,
    tags = tag_id
  )
  
  res <- gtm_action(path_args = path_args, action = "revert")
  myMessage(sprintf("Changes to tag %s have been reverted", res$tag$tagId), level = 3)
  return(res)
}