• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.segments.html">segments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(max_results=None, start_index=None)</a></code></p>
79<p class="firstline">Lists segments to which the user has access.</p>
80<h3>Method Details</h3>
81<div class="method">
82    <code class="details" id="list">list(max_results=None, start_index=None)</code>
83  <pre>Lists segments to which the user has access.
84
85Args:
86  max_results: integer, The maximum number of segments to include in this response.
87  start_index: integer, An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
88
89Returns:
90  An object of the form:
91
92    { # An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.
93    "username": "A String", # Email ID of the authenticated user
94    "kind": "analytics#segments", # Collection type for segments.
95    "items": [ # A list of segments.
96      { # JSON template for an Analytics segment.
97        "definition": "A String", # Segment definition.
98        "kind": "analytics#segment", # Resource type for Analytics segment.
99        "segmentId": "A String", # Segment ID. Can be used with the 'segment' parameter in Core Reporting API.
100        "created": "A String", # Time the segment was created.
101        "updated": "A String", # Time the segment was last modified.
102        "type": "A String", # Type for a segment. Possible values are "BUILT_IN" or "CUSTOM".
103        "id": "A String", # Segment ID.
104        "selfLink": "A String", # Link for this segment.
105        "name": "A String", # Segment name.
106      },
107    ],
108    "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
109    "previousLink": "A String", # Link to previous page for this segment collection.
110    "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
111    "nextLink": "A String", # Link to next page for this segment collection.
112    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
113  }</pre>
114</div>
115
116</body></html>