list_custom_metrics: Custom Metrics

In artemklevtsov/RGA: A Google Analytics API V3 Client

Description

Lists custom metrics to which the user has access.

Usage

list_custom_metrics(accountId, webPropertyId, start.index = NULL,
  max.results = NULL, token)

Arguments

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

Value

kind	Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field.
id	Custom metric ID.
accountId	Account ID.
webPropertyId	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.

References

Management API - Custom Metrics Overview

See Also

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

artemklevtsov/RGA documentation built on May 10, 2019, 1:50 p.m.