list_custom_dimensions: Lists custom dimensions to which the user has access to

In jdeboer/RGA-1: A Google Analytics API Client

Description

Lists custom dimensions to which the user has access to

Usage

list_custom_dimensions(account.id, webproperty.id, start.index = NULL,
  max.results = NULL, token)

Arguments

account.id	Account ID for the custom dimensions to retrieve.
webproperty.id	Web property ID for the custom dimensions to retrieve.
start.index	An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
max.results	The maximum number of custom dimensions to include in this response.
token	Token2.0 class object with a valid authorization data.

Value

An Analytics custom dimension.

id	Custom dimension ID.
account.id	Account ID.
webproperty.id	Property ID.
name	Name of the custom dimension.
index	Index of the custom dimension.
scope	Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.
active	Boolean indicating whether the custom dimension is active.
created	Time the custom dimension was created.
updated	Time the custom dimension was last modified.

References

Management API - Custom Dimensions

See Also

authorize

Other Management API: get_custom_dimension; get_custom_metric; get_experiment; get_filter; get_goal; get_profile; get_unsampled_report; get_webproperty; list_accounts; list_custom_metrics; list_custom_sources; list_experiments; list_filters; list_goals; list_profiles; list_segments; list_unsampled_reports; list_webproperties

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