Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 673ec5cf1a654055c85c0d426b27d270a8ade262 / . / docs / dyn / analyticsadmin_v1alpha.accounts.html
blob: 0a8f6f1d195425bf5568eb0bba1194a9010286cb [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.accounts.html">accounts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="analyticsadmin_v1alpha.accounts.userLinks.html">userLinks()</a></code>
79</p>
80<p class="firstline">Returns the userLinks Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Lookup for a single Account. Throws "Target not found" if no such account found, or if caller does not have permissions to access it.</p>
91<p class="toc_element">
92 <code><a href="#getDataSharingSettings">getDataSharingSettings(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Get data sharing settings on an account. Data sharing settings are singletons.</p>
94<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]95 <code><a href="#list">list(showDeleted=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
96<p class="firstline">Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Updates an account.</p>
103<p class="toc_element">
104 <code><a href="#provisionAccountTicket">provisionAccountTicket(body=None, x__xgafv=None)</a></code></p>
105<p class="firstline">Requests a ticket for creating an account.</p>
106<h3>Method Details</h3>
107<div class="method">
108 <code class="details" id="close">close()</code>
109 <pre>Close httplib2 connections.</pre>
110</div>
111
112<div class="method">
113 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
114 <pre>Marks target Account as soft-deleted (ie: &quot;trashed&quot;) and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
115
116Args:
117 name: string, Required. The name of the Account to soft-delete. Format: accounts/{account} Example: &quot;accounts/100&quot; (required)
118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
122
123Returns:
124 An object of the form:
125
126 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
127 }</pre>
128</div>
129
130<div class="method">
131 <code class="details" id="get">get(name, x__xgafv=None)</code>
132 <pre>Lookup for a single Account. Throws &quot;Target not found&quot; if no such account found, or if caller does not have permissions to access it.
133
134Args:
135 name: string, Required. The name of the account to lookup. Format: accounts/{account} Example: &quot;accounts/100&quot; (required)
136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141Returns:
142 An object of the form:
143
144 { # A resource message representing a Google Analytics account.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 &quot;deleted&quot;: True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]146 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when account payload fields were last updated.
147 &quot;countryCode&quot;: &quot;A String&quot;, # Country of business. Must be a non-deprecated code for a UN M.49 region. https: //unicode.org/cldr/charts/latest/supplem // ental/territory_containment_un_m_49.html
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]148 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this account. Format: accounts/{account} Example: &quot;accounts/100&quot;
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]149 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this account.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]150 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this account was originally created.
151 }</pre>
152</div>
153
154<div class="method">
155 <code class="details" id="getDataSharingSettings">getDataSharingSettings(name, x__xgafv=None)</code>
156 <pre>Get data sharing settings on an account. Data sharing settings are singletons.
157
158Args:
159 name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: &quot;accounts/1000/dataSharingSettings&quot; (required)
160 x__xgafv: string, V1 error format.
161 Allowed values
162 1 - v1 error format
163 2 - v2 error format
164
165Returns:
166 An object of the form:
167
168 { # A resource message representing data sharing settings of a Google Analytics account.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]169 &quot;sharingWithGoogleAssignedSalesEnabled&quot;: True or False, # Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]170 &quot;sharingWithOthersEnabled&quot;: True or False, # Allows Google to share the data anonymously in aggregate form with others.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]171 &quot;sharingWithGoogleSupportEnabled&quot;: True or False, # Allows Google support to access the data in order to help troubleshoot issues.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]172 &quot;sharingWithGoogleProductsEnabled&quot;: True or False, # Allows Google to use the data to improve other Google products or services.
173 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: &quot;accounts/1000/dataSharingSettings&quot;
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]174 &quot;sharingWithGoogleAnySalesEnabled&quot;: True or False, # Allows any of Google sales to access the data in order to suggest configuration changes to improve results.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]175 }</pre>
176</div>
177
178<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]179 <code class="details" id="list">list(showDeleted=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
180 <pre>Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: &quot;trashed&quot;) accounts are excluded by default. Returns an empty list if no relevant accounts are found.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]181
182Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]183 showDeleted: boolean, Whether to include soft-deleted (ie: &quot;trashed&quot;) Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.
184 pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]185 pageSize: integer, The maximum number of 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)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
190
191Returns:
192 An object of the form:
193
194 { # Request message for ListAccounts RPC.
195 &quot;accounts&quot;: [ # Results that were accessible to the caller.
196 { # A resource message representing a Google Analytics account.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]197 &quot;deleted&quot;: True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]198 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when account payload fields were last updated.
199 &quot;countryCode&quot;: &quot;A String&quot;, # Country of business. Must be a non-deprecated code for a UN M.49 region. https: //unicode.org/cldr/charts/latest/supplem // ental/territory_containment_un_m_49.html
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]200 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this account. Format: accounts/{account} Example: &quot;accounts/100&quot;
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]201 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this account.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]202 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this account was originally created.
203 },
204 ],
205 &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.
206 }</pre>
207</div>
208
209<div class="method">
210 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
211 <pre>Retrieves the next page of results.
212
213Args:
214 previous_request: The request for the previous page. (required)
215 previous_response: The response from the request for the previous page. (required)
216
217Returns:
218 A request object that you can call &#x27;execute()&#x27; on to request the next
219 page. Returns None if there are no more items in the collection.
220 </pre>
221</div>
222
223<div class="method">
224 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
225 <pre>Updates an account.
226
227Args:
228 name: string, Output only. Resource name of this account. Format: accounts/{account} Example: &quot;accounts/100&quot; (required)
229 body: object, The request body.
230 The object takes the form of:
231
232{ # A resource message representing a Google Analytics account.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]233 &quot;deleted&quot;: True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]234 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when account payload fields were last updated.
235 &quot;countryCode&quot;: &quot;A String&quot;, # Country of business. Must be a non-deprecated code for a UN M.49 region. https: //unicode.org/cldr/charts/latest/supplem // ental/territory_containment_un_m_49.html
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]236 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this account. Format: accounts/{account} Example: &quot;accounts/100&quot;
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]237 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this account.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]238 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this account was originally created.
239}
240
241 updateMask: string, The list of fields to be updated. Omitted fields will not be updated.
242 x__xgafv: string, V1 error format.
243 Allowed values
244 1 - v1 error format
245 2 - v2 error format
246
247Returns:
248 An object of the form:
249
250 { # A resource message representing a Google Analytics account.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]251 &quot;deleted&quot;: True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]252 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when account payload fields were last updated.
253 &quot;countryCode&quot;: &quot;A String&quot;, # Country of business. Must be a non-deprecated code for a UN M.49 region. https: //unicode.org/cldr/charts/latest/supplem // ental/territory_containment_un_m_49.html
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]254 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this account. Format: accounts/{account} Example: &quot;accounts/100&quot;
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]255 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this account.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]256 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this account was originally created.
257 }</pre>
258</div>
259
260<div class="method">
261 <code class="details" id="provisionAccountTicket">provisionAccountTicket(body=None, x__xgafv=None)</code>
262 <pre>Requests a ticket for creating an account.
263
264Args:
265 body: object, The request body.
266 The object takes the form of:
267
268{ # Request message for ProvisionAccountTicket RPC.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]269 &quot;account&quot;: { # A resource message representing a Google Analytics account. # The account to create.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]270 &quot;deleted&quot;: True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]271 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when account payload fields were last updated.
272 &quot;countryCode&quot;: &quot;A String&quot;, # Country of business. Must be a non-deprecated code for a UN M.49 region. https: //unicode.org/cldr/charts/latest/supplem // ental/territory_containment_un_m_49.html
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]273 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this account. Format: accounts/{account} Example: &quot;accounts/100&quot;
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]274 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this account.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]275 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this account was originally created.
276 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]277 &quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]278 }
279
280 x__xgafv: string, V1 error format.
281 Allowed values
282 1 - v1 error format
283 2 - v2 error format
284
285Returns:
286 An object of the form:
287
288 { # Response message for ProvisionAccountTicket RPC.
289 &quot;accountTicketId&quot;: &quot;A String&quot;, # The param to be passed in the ToS link.
290 }</pre>
291</div>
292
293</body></html>