blob: e6abf1fea5b824a241424704c0df444b48773677 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#list">list(max_results=None, start_index=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040082<p class="firstline">Lists segments to which the user has access.</p>
83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
90 <code class="details" id="list">list(max_results=None, start_index=None)</code>
John Asmuth614db982014-04-24 15:46:26 -040091 <pre>Lists segments to which the user has access.
92
93Args:
Bu Sun Kim65020912020-05-20 12:08:20 -070094 max_results: integer, The maximum number of segments to include in this response.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070095 start_index: integer, An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
John Asmuth614db982014-04-24 15:46:26 -040096
97Returns:
98 An object of the form:
99
100 { # An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700101 &quot;startIndex&quot;: 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700102 &quot;nextLink&quot;: &quot;A String&quot;, # Link to next page for this segment collection.
Bu Sun Kim65020912020-05-20 12:08:20 -0700103 &quot;items&quot;: [ # A list of segments.
John Asmuth614db982014-04-24 15:46:26 -0400104 { # JSON template for an Analytics segment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700105 &quot;updated&quot;: &quot;A String&quot;, # Time the segment was last modified.
106 &quot;definition&quot;: &quot;A String&quot;, # Segment definition.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700107 &quot;type&quot;: &quot;A String&quot;, # Type for a segment. Possible values are &quot;BUILT_IN&quot; or &quot;CUSTOM&quot;.
108 &quot;created&quot;: &quot;A String&quot;, # Time the segment was created.
109 &quot;id&quot;: &quot;A String&quot;, # Segment ID.
110 &quot;segmentId&quot;: &quot;A String&quot;, # Segment ID. Can be used with the &#x27;segment&#x27; parameter in Core Reporting API.
111 &quot;selfLink&quot;: &quot;A String&quot;, # Link for this segment.
112 &quot;name&quot;: &quot;A String&quot;, # Segment name.
113 &quot;kind&quot;: &quot;analytics#segment&quot;, # Resource type for Analytics segment.
John Asmuth614db982014-04-24 15:46:26 -0400114 },
115 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700116 &quot;itemsPerPage&quot;: 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700117 &quot;totalResults&quot;: 42, # The total number of results for the query, regardless of the number of results in the response.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700118 &quot;username&quot;: &quot;A String&quot;, # Email ID of the authenticated user
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700119 &quot;kind&quot;: &quot;analytics#segments&quot;, # Collection type for segments.
120 &quot;previousLink&quot;: &quot;A String&quot;, # Link to previous page for this segment collection.
John Asmuth614db982014-04-24 15:46:26 -0400121 }</pre>
122</div>
123
124</body></html>