RGA (version 0.4.2)

list_dimsmets: Lists all the dimensions and metrics for a particular report type

Description

This dataset represents all of the dimensions and metrics for the reporting API with their attributes. Attributes returned include UI name, description, segments support, etc.

Usage

list_dimsmets(reportType = "ga")

Arguments

reportType

character. Report type. Allowed Values: "ga". Where "ga" corresponds to the Core Reporting API.

Value

A data.frame contains dimensions and metrics for a particular report type.

id

Parameter name.

type

The type of column: DIMENSION, METRIC.

dataType

The type of data this column represents: STRING, INTEGER, PERCENT, TIME, CURRENCY, FLOAT.

group

The dimensions/metrics group the column belongs to.

status

The status of the column: PUBLIC, DEPRECATED.

uiName

The name/label of the column used in user interfaces (UI).

description

The full description of the column.

allowedInSegments

Indicates whether the column can be used in the segment query parameter.

addedInApiVersion

API version with this param was added.

replacedBy

The replacement column to use for a column with a DEPRECATED status.

calculation

Only available for calculated metrics. This shows how the metric is calculated.

minTemplateIndex

Only available for templatized columns. This is the minimum index for the column.

maxTemplateIndex

Only available for templatized columns. This is the maximum index for the column.

premiumMinTemplateIndex

Only available for templatized columns. This is the minimum index for the column for premium properties.

premiumMaxTemplateIndex

Only available for templatized columns. This is the maximum index for the column for premium properties.

References

Google Analytics Metadata API

Core Reporting API - Dimensions & Metrics Reference

See Also

shiny_dimsmets get_ga

Examples

## Not run: 
# ga_meta <- list_dimsmets("ga")
# # a count of parameters types
# table(ga_meta$type)
# # parameters groups
# table(ga_meta$group)
# # get a deprecated parameters was replaced by
# subset(ga_meta, status == "DEPRECATED", c(id, replacedBy))
# # get a calculation metrics
# subset(ga_meta, !is.na(calculation), c(id, calculation))
# # get a not deprecated metrics from user group
# subset(ga_meta, group == "User" & type == "METRIC" & status != "DEPRECATED", id)
# # get parameters allowed in segments
# subset(ga_meta, allowedInSegments, id)
# ## End(Not run)