Create a custom dimension

Create a dimension by specifying its attributes.

ga_custom_vars_create(
  name,
  index,
  accountId,
  webPropertyId,
  active,
  scope = c("HIT", "SESSION", "USER", "PRODUCT")
)

Arguments

name

Name of custom dimension

index

Index of custom dimension - integer between 1 and 20 (200 for GA360)

accountId

AccountId of the custom dimension

webPropertyId

WebPropertyId of the custom dimension

active

TRUE or FALSE if custom dimension is active or not

scope

Scope of custom dimension - one of "HIT","SESSION","USER","PRODUCT"

See also

Custom dimensions support article

Other custom variable functions: ga_custom_vars_list(), ga_custom_vars_patch(), ga_custom_vars()

Examples

if (FALSE) {
library(googleAnalyticsR)
ga_auth()

# create custom var
ga_custom_vars_create("my_custom_dim",
                      index = 15,
                      accountId = 54019251,
                      webPropertyId = "UA-54019251-4",
                      scope = "HIT",
                      active = FALSE)

# view custom dimension in list
ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customDimensions")

}