list_segments: Segments

In RGA: A Google Analytics API Client

Description

Lists segments to which the user has access.

Usage

list_segments(start.index = NULL, max.results = NULL, token)

Arguments

start.index	integer. An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
max.results	integer. The maximum number of segments to include in this response.
token	Token2.0 class object with a valid authorization data.

Value

The Segments collection is a set of Segment resources, each of which describes one of the user's default advanced segments or custom segments.

id	Segment ID.
kind	Resource type for Analytics segment.
segmentId	Segment ID. Can be used with the 'segment' parameter in Core Reporting API.
name	Segment name.
definition	Segment definition.
type	Type for a segment. Possible values are "BUILT_IN" or "CUSTOM".
created	Time the segment was created.
updated	Time the segment was last modified.

References

Management API - Segments Overview

See Also

Other Management API: get_custom_dimension, 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_unsampled_reports, list_uploads, list_webproperties

RGA documentation built on May 2, 2019, 6:47 a.m.