ga: Lists all columns for a Google Analytics core report type

Description Usage Format Source References See Also Examples

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

1

Format

A data frame with 436 rows and 14 variables containing the following columns:

id

Parameter name.

type

The type of column: DIMENSION, METRIC.

data.type

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.

ui.name

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

description

The full description of the column.

allowed.in.segments

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

replaced.by

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.

min.template.index

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

max.template.index

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

premium.min.template.index

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

premium.max.template.index

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

Source

https://www.googleapis.com/analytics/v3/metadata/ga/columns?pp=1

References

Google Analytics Metadata API

Core Reporting API - Dimensions & Metrics Reference

See Also

get_ga list_dimsmets

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# a count of parameters types
table(ga$type)
# parameters groups
table(ga$group)
# get a deprecated parameters was replaced by
subset(ga, status == "DEPRECATED", c(id, replaced.by))
# get a calculation metrics
subset(ga, !is.na(calculation), c(id, calculation))
# get a not deprecated metrics from user group
subset(ga, group == "User" & type == "METRIC" & status != "DEPRECATED", id)
# get parameters allowed in segments
subset(ga, allowed.in.segments, id)

jdeboer/RGA-1 documentation built on May 18, 2019, 11:29 p.m.