get_custom_metric: Gets a custom metric to which the user has access to

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

Description

Gets a custom metric to which the user has access to

Usage

get_custom_metric(account.id, webproperty.id, metric.id, token)

Arguments

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

Value

An Analytics custom metric.

kind	Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
id	Custom metric ID.
account.id	Account ID.
webproperty.id	Property ID.
name	Name of the custom metric.
index	Index of the custom metric.
scope	Scope of the custom metric: HIT or PRODUCT.
active	Boolean indicating whether the custom metric is active.
type	Data type of custom metric.
min_value	Min value of custom metric.
max_value	Max value of custom metric.
created	Time the custom metric was created.
updated	Time the custom metric was last modified.
self.link	Link for the custom metric
parent.link	Parent link for the custom metric. Points to the property to which the custom metric belongs.
parent.link.type	Type of the parent link. Set to "analytics#webproperty".
parent.link.href	Link to the property to which the custom metric belongs.

References

Management API - Custom metrics

See Also

authorize

Other Management API: get_custom_dimension; 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.