RGA (version 0.4.2)

get_custom_dimension: Custom Dimensions

Description

Get a custom dimension to which the user has access.

Usage

get_custom_dimension(accountId, webPropertyId, customDimensionId, token)

Arguments

accountId

character. Account ID for the custom dimension to retrieve.

webPropertyId

character. Web property ID for the custom dimension to retrieve.

customDimensionId

character. The ID of the custom dimension to retrieve.

token

Token2.0 class object with a valid authorization data.

Value

kind

Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field.

id

Custom dimension ID.

accountId

Account ID.

webPropertyId

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 Overview

See Also

Other Management API: get_custom_metric, get_experiment, get_filter, get_goal, get_profile, get_unsampled_report, get_upload, get_webproperty, list_accounts, list_custom_data_sources, list_custom_dimensions, list_custom_metrics, list_experiments, list_filters, list_goals, list_profiles, list_segments, list_unsampled_reports, list_uploads, list_webproperties