Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 673ec5cf1a654055c85c0d426b27d270a8ade262 / . / docs / dyn / analyticsadmin_v1alpha.accountSummaries.html
blob: b8c0f348c4173cda60dd26b3b7382056f02fdf17 [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[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="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.accountSummaries.html">accountSummaries</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]81 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Returns summaries of all accounts accessible by the caller.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]93 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <pre>Returns summaries of all accounts accessible by the caller.
95
96Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 pageSize: integer, The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]98 pageToken: string, A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103
104Returns:
105 An object of the form:
106
107 { # Response message for ListAccountSummaries RPC.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108 &quot;accountSummaries&quot;: [ # Account summaries of all accounts the caller has access to.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]109 { # A virtual resource representing an overview of an account and all its child GA4 properties.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]110 &quot;propertySummaries&quot;: [ # List of summaries for child accounts of this account.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]111 { # A virtual resource representing metadata for an GA4 property.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112 &quot;displayName&quot;: &quot;A String&quot;, # Display name for the property referred to in this account summary.
113 &quot;property&quot;: &quot;A String&quot;, # Resource name of property referred to by this property summary Format: properties/{property_id} Example: &quot;properties/1000&quot;
114 },
115 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]116 &quot;account&quot;: &quot;A String&quot;, # Resource name of account referred to by this account summary Format: accounts/{account_id} Example: &quot;accounts/1000&quot;
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]117 &quot;name&quot;: &quot;A String&quot;, # Resource name for this account summary. Format: accountSummaries/{account_id} Example: &quot;accountSummaries/1000&quot;
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]118 &quot;displayName&quot;: &quot;A String&quot;, # Display name for the account referred to in this account summary.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]119 },
120 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]121 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 }</pre>
123</div>
124
125<div class="method">
126 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
127 <pre>Retrieves the next page of results.
128
129Args:
130 previous_request: The request for the previous page. (required)
131 previous_response: The response from the request for the previous page. (required)
132
133Returns:
134 A request object that you can call &#x27;execute()&#x27; on to request the next
135 page. Returns None if there are no more items in the collection.
136 </pre>
137</div>
138
139</body></html>