jdeboer / ganalytics Goto Github PK

metric_operators <- c(
  "EQUAL" = "==",
  "LESS_THAN" = "<",
  "GREATER_THAN" = ">",
  "BETWEEN" = "<>"
)

dimension_operators <- c(
  "REGEXP" = "=~",
  "PARTIAL" = "=@",
  "EXACT" = "==",
  "IN_LIST" = "[]",
  "NUMERIC_LESS_THAN" = "<",
  "NUMERIC_GREATER_THAN" = ">",
  "NUMERIC_BETWEEN" = "<>"
)

negated_operators <- c(
  "!=", "!~", "!@", ">=", "<="
)

setClass("dim_fil_ga4")
setClass("met_fil_ga4")
setClass("segmentFilterClause_ga4")
setClass("orFiltersForSegment_ga4")
setClass("segmentSequenceStep_ga4")
setClass("simpleSegment_ga4")
setClass("sequenceSegment_ga4")
setClass("segmentFilter_ga4")
setClass("segmentDef_ga4")

get_expression_details <- function(from, var_operators) {
  varName <- as.character(Var(from))
  names(varName) <- sub("^ga:", "", varName)
  operator <- Comparator(from)
  negated <- operator %in% negated_operators
  if(negated) operator <- Not(operator)
  operator_lookup_index <- match(as.character(operator), var_operators)
  operator_name <- names(var_operators)[operator_lookup_index]
  operand <- as.character(Operand(from))
  expressions <- character(0)
  minComparisonValue <- character(0)
  maxComparisonValue <- character(0)
  if(operator == "<>") {
    minComparisonValue <- operand[1]
    maxComparisonValue <- operand[2]
  } else if(inherits(from, ".metExpr")) {
    minComparisonValue <- operand
  } else {
    expressions <- operand
  }
  list(
    varName = varName,
    operator = operator,
    operator_name = operator_name,
    negated = negated,
    expressions = expressions,
    minComparisonValue = minComparisonValue,
    maxComparisonValue = maxComparisonValue
  )
}

setAs("gaDimExpr", "dim_fil_ga4", def = function(from, to) {
  dim_operation <- get_expression_details(from, dimension_operators)
  x <- list(
    dimensionName = dim_operation$varName,
    not = dim_operation$negated,
    operator = dim_operation$operator_name,
    expressions = as.list(as.character(Operand(from))),
    caseSensitive = FALSE
  )
  class(x) <- "dim_fil_ga4"
  x
})

setAs("gaMetExpr", "met_fil_ga4", def = function(from, to) {
  met_operation <- get_expression_details(from, metric_operators)
  x <- list(
    metricName = met_operation$varName,
    not = met_operation$negated,
    operator = met_operation$operator_name,
    comparisonValue = as.character(Operand(from))
  )
  class(x) <- "met_fil_ga4"
  x
})

setAs("gaDimExpr", "segmentFilterClause_ga4", def = function(from, to) {
  exp_details <- get_expression_details(from, dimension_operators)
  segmentDimensionFilter <- list(
    dimensionName = exp_details$varName,
    operator = exp_details$operator_name,
    caseSensitive = NULL,
    expressions = exp_details$expressions,
    minComparisonValue = exp_details$minComparisonValue,
    maxComparisonValue = exp_details$maxComparisonValue
  )
  class(segmentDimensionFilter) <- "segmentDimFilter_ga4"
  x <- list(
    not = exp_details$negated,
    dimensionFilter = segmentDimensionFilter,
    metricFilter = NULL
  )
  class(x) <- "segmentFilterClause_ga4"
  x
})

setAs("gaMetExpr", "segmentFilterClause_ga4", def = function(from, to) {
  from <- as(from, "gaSegMetExpr")
  as(from, to)
})

setAs("gaSegMetExpr", "segmentFilterClause_ga4", def = function(from, to) {
  exp_details <- get_expression_details(from, metric_operators)
  scope <- c("perHit" = "HIT", "perSession" = "SESSION", "perUser" = "USER")[[ScopeLevel(from)]]
  segmentMetricFilter <- list(
    scope = scope,
    metricName = exp_details$varName,
    operator = exp_details$operator_name,
    comparisonValue = exp_details$minComparisonValue,
    maxComparisonValue = exp_details$maxComparisonValue
  )
  class(segmentMetricFilter) <- "segmentMetFilter_ga4"
  x <- list(
    not = exp_details$negated,
    dimensionFilter = NULL,
    metricFilter = segmentMetricFilter
  )
  class(x) <- "segmentFilterClause_ga4"
  x
})

setAs("orExpr", "orFiltersForSegment_ga4", def = function(from, to) {
  x <- list(
    segmentFilterClauses = lapply(from, as, "segmentFilterClause_ga4")
  )
  class(x) <- "orFiltersForSegment_ga4"
  x
})

setAs("andExpr", "simpleSegment_ga4", def = function(from, to) {
  x <- list(
    orFiltersForSegment = lapply(from, as, "orFiltersForSegment_ga4")
  )
  class(x) <- "simpleSegment_ga4"
  x
})

setAs("gaSegmentSequenceStep", "segmentSequenceStep_ga4", def = function(from, to) {
  matchType <- if(from@immediatelyPrecedes) "IMMEDIATELY_PRECEDES" else "PRECEDES"
  x <- c(
    as(as(from@.Data, "andExpr"), "simpleSegment_ga4"),
    list(matchType = matchType)
  )
  class(x) <- "segmentSequenceStep_ga4"
  x
})

setAs("gaSegmentSequenceFilter", "sequenceSegment_ga4", def = function(from, to) {
  segmentSequenceSteps <- lapply(from, as, "segmentSequenceStep_ga4")
  x <- list(
    segmentSequenceSteps = segmentSequenceSteps,
    firstStepShouldMatchFirstHit = from[[1]]@immediatelyPrecedes
  )
  class(x) <- "sequenceSegment_ga4"
  x
})

setAs("gaSegmentConditionFilter", "segmentFilter_ga4", def = function(from, to) {
  x <- list(
    not = IsNegated(from),
    simpleSegment = as(from, "simpleSegment_ga4"),
    sequenceSegment = NULL
  )
  class(x) <- "segmentFilter_ga4"
  x
})

setAs("gaSegmentSequenceFilter", "segmentFilter_ga4", def = function(from, to) {
  x <- list(
    not = IsNegated(from),
    simpleSegment = NULL,
    sequenceSegment = as(from, "sequenceSegment_ga4")
  )
  class(x) <- "segmentFilter_ga4"
  x
})

setAs("gaSegmentFilterList", "segmentDef_ga4", def = function(from, to) {
  x <- list(
    segmentFilters = lapply(from, as, "segmentFilter_ga4")
  )
  class(x) <- "segmentDef_ga4"
  x
})

install_github(repo = "ganalytics", username = "jdeboer")
install.packages(c("plyr", "stringr", "RJSONIO", "Rook", "httpuv"))

library(ganalytics)
Sys.setenv(GANALYTICS_CONSUMER_ID = "myKey",
GANALYTICS_CONSUMER_SECRET = "mySecret")
ga.query <- GaQuery(profileID)
GetGaData(ga.query)
Error in GetGaData(ga.query) : could not find function "new_oauth"

Segment(Expr(~pagepath %matches% "products")) & Segment(Expr(~source == "google"))

Segment(Include(Expr(~pagepath %matches% "products")), Include(Expr(~source == "google")))

query <- GaQuery()

Metrics(query) <- c("users", "sessions", "pageviews", "bounceRate", "timeOnSite", "goalCompletionsAll", "transactions", "transactionRevenue", "totalEvents", "uniquePageviews", "goal1Completions", ...)

metrics <- Metrics(query)
dimensions <- Dimensions(query)

kMaxApiQueryMetrics <- 10

metricGroups <- split(metrics, ceiling(seq_along(metrics) / kMaxApiQueryMetrics))

responseDataFramesList <- lapply(metricGroups, function(queryMetrics) {
  Metrics(query) <- queryMetrics
  GetGaData(query)
})

response <- Reduce(function(x, y) {join(x, y, by = dimensions)}, responseDataFramesList)

GaAnd( 
  GaExpr('keyword', '@', 'buy'), 
  GaOr( 
    GaExpr('city', '~', '^(Sydney|Melbourne)$'), 
    GaExpr('isTablet', '=', ‘Yes’) ) )

GaExpr('keyword', '@', 'buy') && 
  (GaExpr('city', '~', '^(Sydney|Melbourne)$') || 
   GaExpr('isTablet', '=', ‘Yes’))

GaAutoExpr(keyword %matches% "buy" && 
  (city %in% c("Sydney", "Melbourne") || isTablet == TRUE))

segment(
  perUser(
    expr1, # treat an expression as 'condition type segment filter' by default
    perHit(
      metrixExpr1
    )
  ),
  sequence(
    epxr2,
    then(expr3), # 'then' means 'immediately followed by'
    later(expr4) # 'later' means 'followed by', but not necessarily immediately.
  ),
  sequence(
    first(expr5), # First expressly means 'first interaction' within the date range.
    then(expr6), # By default, treat an expression within a sequence as happening
    expr7 # at any point after any preceding steps in the sequence, i.e. 'later'.
  )
)