get_custom_dimension: Gets a custom dimension to which the user has access to

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

Description

Gets a custom dimension to which the user has access to

Usage

get_custom_dimension(account.id, webproperty.id, dimension.id, token)

Arguments

account.id	Account ID for the custom dimension to retrieve.
webproperty.id	Web property ID for the custom dimension to retrieve.
dimension.id	The ID of the custom dimension to retrieve.
token	Token2.0 class object with a valid authorization data.

Value

An Analytics custom dimension.

kind	Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.
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.
self.link	Link for the custom dimension
parent.link	Parent link for the custom dimension. Points to the property to which the custom dimension belongs.
parent.link.type	Type of the parent link. Set to "analytics#webproperty".
parent.link.href	Link to the property to which the custom dimension belongs.

References

Management API - Custom Dimensions

See Also

authorize

Other Management API: get_custom_metric; get_experiment; get_filter; get_goal; get_profile; get_unsampled_report; get_webproperty; list_accounts; list_custom_dimensions; 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.