Debian Codegraph @

docs/dyn/analyticsadmin_v1alpha.properties.accessBindings.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.accessBindings.html">accessBindings</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Creates information about multiple access bindings to an account or property. This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created.</p>
80 <p class="toc_element">
81 <code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes information about multiple users' links to an account or property.</p>
83 <p class="toc_element">
84 <code><a href="#batchGet">batchGet(parent, names=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets information about multiple access bindings to an account or property.</p>
86 <p class="toc_element">
87 <code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Updates information about multiple access bindings to an account or property.</p>
89 <p class="toc_element">
90 <code><a href="#close">close()</a></code></p>
91 <p class="firstline">Close httplib2 connections.</p>
92 <p class="toc_element">
93 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Creates an access binding on an account or property.</p>
95 <p class="toc_element">
96 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
97 <p class="firstline">Deletes an access binding on an account or property.</p>
98 <p class="toc_element">
99 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
100 <p class="firstline">Gets information about an access binding.</p>
101 <p class="toc_element">
102 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Lists all access bindings on an account or property.</p>
104 <p class="toc_element">
105 <code><a href="#list_next">list_next()</a></code></p>
106 <p class="firstline">Retrieves the next page of results.</p>
107 <p class="toc_element">
108 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Updates an access binding on an account or property.</p>
110 <h3>Method Details</h3>
111 <div class="method">
112 <code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code>
113 <pre>Creates information about multiple access bindings to an account or property. This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created.
114
115 Args:
116 parent: string, Required. The account or property that owns the access bindings. The parent field in the CreateAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property} (required)
117 body: object, The request body.
118 The object takes the form of:
119
120 { # Request message for BatchCreateAccessBindings RPC.
121 &quot;requests&quot;: [ # Required. The requests specifying the access bindings to create. A maximum of 1000 access bindings can be created in a batch.
122 { # Request message for CreateAccessBinding RPC.
123 &quot;accessBinding&quot;: { # A binding of a user to a set of roles. # Required. The access binding to create.
124 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot;
125 &quot;roles&quot;: [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
126 &quot;A String&quot;,
127 ],
128 &quot;user&quot;: &quot;A String&quot;, # If set, the email address of the user to set roles for. Format: &quot;[email protected]&quot;
129 },
130 &quot;parent&quot;: &quot;A String&quot;, # Required. Formats: - accounts/{account} - properties/{property}
131 },
132 ],
133 }
134
135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
139
140 Returns:
141 An object of the form:
142
143 { # Response message for BatchCreateAccessBindings RPC.
144 &quot;accessBindings&quot;: [ # The access bindings created.
145 { # A binding of a user to a set of roles.
146 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot;
147 &quot;roles&quot;: [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
148 &quot;A String&quot;,
149 ],
150 &quot;user&quot;: &quot;A String&quot;, # If set, the email address of the user to set roles for. Format: &quot;[email protected]&quot;
151 },
152 ],
153 }</pre>
154 </div>
155
156 <div class="method">
157 <code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
158 <pre>Deletes information about multiple users&#x27; links to an account or property.
159
160 Args:
161 parent: string, Required. The account or property that owns the access bindings. The parent of all provided values for the &#x27;names&#x27; field in DeleteAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property} (required)
162 body: object, The request body.
163 The object takes the form of:
164
165 { # Request message for BatchDeleteAccessBindings RPC.
166 &quot;requests&quot;: [ # Required. The requests specifying the access bindings to delete. A maximum of 1000 access bindings can be deleted in a batch.
167 { # Request message for DeleteAccessBinding RPC.
168 &quot;name&quot;: &quot;A String&quot;, # Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}
169 },
170 ],
171 }
172
173 x__xgafv: string, V1 error format.
174 Allowed values
175 1 - v1 error format
176 2 - v2 error format
177
178 Returns:
179 An object of the form:
180
181 { # 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); }
182 }</pre>
183 </div>
184
185 <div class="method">
186 <code class="details" id="batchGet">batchGet(parent, names=None, x__xgafv=None)</code>
187 <pre>Gets information about multiple access bindings to an account or property.
188
189 Args:
190 parent: string, Required. The account or property that owns the access bindings. The parent of all provided values for the &#x27;names&#x27; field must match this field. Formats: - accounts/{account} - properties/{property} (required)
191 names: string, Required. The names of the access bindings to retrieve. A maximum of 1000 access bindings can be retrieved in a batch. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding} (repeated)
192 x__xgafv: string, V1 error format.
193 Allowed values
194 1 - v1 error format
195 2 - v2 error format
196
197 Returns:
198 An object of the form:
199
200 { # Response message for BatchGetAccessBindings RPC.
201 &quot;accessBindings&quot;: [ # The requested access bindings.
202 { # A binding of a user to a set of roles.
203 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot;
204 &quot;roles&quot;: [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
205 &quot;A String&quot;,
206 ],
207 &quot;user&quot;: &quot;A String&quot;, # If set, the email address of the user to set roles for. Format: &quot;[email protected]&quot;
208 },
209 ],
210 }</pre>
211 </div>
212
213 <div class="method">
214 <code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>
215 <pre>Updates information about multiple access bindings to an account or property.
216
217 Args:
218 parent: string, Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property} (required)
219 body: object, The request body.
220 The object takes the form of:
221
222 { # Request message for BatchUpdateAccessBindings RPC.
223 &quot;requests&quot;: [ # Required. The requests specifying the access bindings to update. A maximum of 1000 access bindings can be updated in a batch.
224 { # Request message for UpdateAccessBinding RPC.
225 &quot;accessBinding&quot;: { # A binding of a user to a set of roles. # Required. The access binding to update.
226 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot;
227 &quot;roles&quot;: [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
228 &quot;A String&quot;,
229 ],
230 &quot;user&quot;: &quot;A String&quot;, # If set, the email address of the user to set roles for. Format: &quot;[email protected]&quot;
231 },
232 },
233 ],
234 }
235
236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
240
241 Returns:
242 An object of the form:
243
244 { # Response message for BatchUpdateAccessBindings RPC.
245 &quot;accessBindings&quot;: [ # The access bindings updated.
246 { # A binding of a user to a set of roles.
247 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot;
248 &quot;roles&quot;: [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
249 &quot;A String&quot;,
250 ],
251 &quot;user&quot;: &quot;A String&quot;, # If set, the email address of the user to set roles for. Format: &quot;[email protected]&quot;
252 },
253 ],
254 }</pre>
255 </div>
256
257 <div class="method">
258 <code class="details" id="close">close()</code>
259 <pre>Close httplib2 connections.</pre>
260 </div>
261
262 <div class="method">
263 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
264 <pre>Creates an access binding on an account or property.
265
266 Args:
267 parent: string, Required. Formats: - accounts/{account} - properties/{property} (required)
268 body: object, The request body.
269 The object takes the form of:
270
271 { # A binding of a user to a set of roles.
272 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot;
273 &quot;roles&quot;: [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
274 &quot;A String&quot;,
275 ],
276 &quot;user&quot;: &quot;A String&quot;, # If set, the email address of the user to set roles for. Format: &quot;[email protected]&quot;
277 }
278
279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
283
284 Returns:
285 An object of the form:
286
287 { # A binding of a user to a set of roles.
288 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot;
289 &quot;roles&quot;: [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
290 &quot;A String&quot;,
291 ],
292 &quot;user&quot;: &quot;A String&quot;, # If set, the email address of the user to set roles for. Format: &quot;[email protected]&quot;
293 }</pre>
294 </div>
295
296 <div class="method">
297 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
298 <pre>Deletes an access binding on an account or property.
299
300 Args:
301 name: string, Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding} (required)
302 x__xgafv: string, V1 error format.
303 Allowed values
304 1 - v1 error format
305 2 - v2 error format
306
307 Returns:
308 An object of the form:
309
310 { # 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); }
311 }</pre>
312 </div>
313
314 <div class="method">
315 <code class="details" id="get">get(name, x__xgafv=None)</code>
316 <pre>Gets information about an access binding.
317
318 Args:
319 name: string, Required. The name of the access binding to retrieve. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding} (required)
320 x__xgafv: string, V1 error format.
321 Allowed values
322 1 - v1 error format
323 2 - v2 error format
324
325 Returns:
326 An object of the form:
327
328 { # A binding of a user to a set of roles.
329 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot;
330 &quot;roles&quot;: [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
331 &quot;A String&quot;,
332 ],
333 &quot;user&quot;: &quot;A String&quot;, # If set, the email address of the user to set roles for. Format: &quot;[email protected]&quot;
334 }</pre>
335 </div>
336
337 <div class="method">
338 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
339 <pre>Lists all access bindings on an account or property.
340
341 Args:
342 parent: string, Required. Formats: - accounts/{account} - properties/{property} (required)
343 pageSize: integer, The maximum number of access bindings to return. The service may return fewer than this value. If unspecified, at most 200 access bindings will be returned. The maximum value is 500; values above 500 will be coerced to 500.
344 pageToken: string, A page token, received from a previous `ListAccessBindings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccessBindings` must match the call that provided the page token.
345 x__xgafv: string, V1 error format.
346 Allowed values
347 1 - v1 error format
348 2 - v2 error format
349
350 Returns:
351 An object of the form:
352
353 { # Response message for ListAccessBindings RPC.
354 &quot;accessBindings&quot;: [ # List of AccessBindings. These will be ordered stably, but in an arbitrary order.
355 { # A binding of a user to a set of roles.
356 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot;
357 &quot;roles&quot;: [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
358 &quot;A String&quot;,
359 ],
360 &quot;user&quot;: &quot;A String&quot;, # If set, the email address of the user to set roles for. Format: &quot;[email protected]&quot;
361 },
362 ],
363 &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.
364 }</pre>
365 </div>
366
367 <div class="method">
368 <code class="details" id="list_next">list_next()</code>
369 <pre>Retrieves the next page of results.
370
371 Args:
372 previous_request: The request for the previous page. (required)
373 previous_response: The response from the request for the previous page. (required)
374
375 Returns:
376 A request object that you can call &#x27;execute()&#x27; on to request the next
377 page. Returns None if there are no more items in the collection.
378 </pre>
379 </div>
380
381 <div class="method">
382 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
383 <pre>Updates an access binding on an account or property.
384
385 Args:
386 name: string, Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot; (required)
387 body: object, The request body.
388 The object takes the form of:
389
390 { # A binding of a user to a set of roles.
391 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot;
392 &quot;roles&quot;: [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
393 &quot;A String&quot;,
394 ],
395 &quot;user&quot;: &quot;A String&quot;, # If set, the email address of the user to set roles for. Format: &quot;[email protected]&quot;
396 }
397
398 x__xgafv: string, V1 error format.
399 Allowed values
400 1 - v1 error format
401 2 - v2 error format
402
403 Returns:
404 An object of the form:
405
406 { # A binding of a user to a set of roles.
407 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: &quot;accounts/100/accessBindings/200&quot;
408 &quot;roles&quot;: [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
409 &quot;A String&quot;,
410 ],
411 &quot;user&quot;: &quot;A String&quot;, # If set, the email address of the user to set roles for. Format: &quot;[email protected]&quot;
412 }</pre>
413 </div>
414
415 </body></html>