Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / analytics_v3.management.accountSummaries.html
blob: f01e419566e556810f844c4afc48b3c18d098af7 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.accountSummaries.html">accountSummaries</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 account summaries (lightweight tree comprised of accounts/properties/profiles) 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 account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.
84
85Args:
Craig Citrobdd05a82014-10-17 20:32:03 -0700[diff] [blame]86 max_results: integer, The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]87 start_index: integer, An index of the first entity 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 AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary.
93 "username": "A String", # Email ID of the authenticated user
94 "kind": "analytics#accountSummaries", # Collection type.
95 "items": [ # A list of AccountSummaries.
96 { # JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]97 "starred": True or False, # Indicates whether this account is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98 "kind": "analytics#accountSummary", # Resource type for Analytics AccountSummary.
99 "webProperties": [ # List of web properties under this account.
100 { # JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.
101 "kind": "analytics#webPropertySummary", # Resource type for Analytics WebPropertySummary.
102 "name": "A String", # Web property name.
103 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
104 "profiles": [ # List of profiles under this web property.
105 { # JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]106 "starred": True or False, # Indicates whether this view (profile) is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]107 "kind": "analytics#profileSummary", # Resource type for Analytics ProfileSummary.
108 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
109 "id": "A String", # View (profile) ID.
110 "name": "A String", # View (profile) name.
111 },
112 ],
113 "websiteUrl": "A String", # Website url for this web property.
114 "internalWebPropertyId": "A String", # Internal ID for this web property.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]115 "starred": True or False, # Indicates whether this web property is starred or not.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]116 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
117 },
118 ],
119 "id": "A String", # Account ID.
120 "name": "A String", # Account name.
121 },
122 ],
123 "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.
124 "previousLink": "A String", # Link to previous page for this AccountSummary collection.
125 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
126 "nextLink": "A String", # Link to next page for this AccountSummary collection.
127 "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
128 }</pre>
129</div>
130
131</body></html>