Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 33237a8250e3becfaa1e4b5f67ef0c887cfc44a9 / . / docs / dyn / dfareporting_v3_3.userRoles.html
blob: 9a6f6d876d8cf5828558cb2205a16e54e640c08c [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]75<h1><a href="dfareporting_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.userRoles.html">userRoles</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <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="#delete">delete(profileId, id, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Deletes an existing user role.</p>
83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]84 <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Gets one user role by ID.</p>
86<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87 <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Inserts a new user role.</p>
89<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]90 <code><a href="#list">list(profileId, accountUserRoleOnly=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Retrieves a list of user roles, possibly filtered. This method supports paging.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]96 <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="firstline">Updates an existing user role. This method supports patch semantics.</p>
98<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]99 <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Updates an existing user role.</p>
101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
108 <code class="details" id="delete">delete(profileId, id, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 <pre>Deletes an existing user role.
110
111Args:
112 profileId: string, User profile ID associated with this request. (required)
113 id: string, User role ID. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]114 x__xgafv: string, V1 error format.
115 Allowed values
116 1 - v1 error format
117 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118</pre>
119</div>
120
121<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 <code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 <pre>Gets one user role by ID.
124
125Args:
126 profileId: string, User profile ID associated with this request. (required)
127 id: string, User role ID. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132
133Returns:
134 An object of the form:
135
136 { # Contains properties of auser role, which is used to manage user access.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]137 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this user role. This is a read-only field that can be left blank.
138 &quot;defaultUserRole&quot;: True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
139 &quot;id&quot;: &quot;A String&quot;, # ID of this user role. This is a read-only, auto-generated field.
140 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRole&quot;.
141 &quot;name&quot;: &quot;A String&quot;, # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
142 &quot;parentUserRoleId&quot;: &quot;A String&quot;, # ID of the user role that this user role is based on or copied from. This is a required field.
143 &quot;permissions&quot;: [ # List of permissions associated with this user role.
144 { # Contains properties of a user role permission.
145 &quot;availability&quot;: &quot;A String&quot;, # Levels of availability for a user role permission.
146 &quot;id&quot;: &quot;A String&quot;, # ID of this user role permission.
147 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRolePermission&quot;.
148 &quot;name&quot;: &quot;A String&quot;, # Name of this user role permission.
149 &quot;permissionGroupId&quot;: &quot;A String&quot;, # ID of the permission group that this user role permission belongs to.
150 },
151 ],
152 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this user role. This is a read-only field that can be left blank.
153}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154</div>
155
156<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]157 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 <pre>Inserts a new user role.
159
160Args:
161 profileId: string, User profile ID associated with this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]162 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 The object takes the form of:
164
165{ # Contains properties of auser role, which is used to manage user access.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]166 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this user role. This is a read-only field that can be left blank.
167 &quot;defaultUserRole&quot;: True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
168 &quot;id&quot;: &quot;A String&quot;, # ID of this user role. This is a read-only, auto-generated field.
169 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRole&quot;.
170 &quot;name&quot;: &quot;A String&quot;, # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
171 &quot;parentUserRoleId&quot;: &quot;A String&quot;, # ID of the user role that this user role is based on or copied from. This is a required field.
172 &quot;permissions&quot;: [ # List of permissions associated with this user role.
173 { # Contains properties of a user role permission.
174 &quot;availability&quot;: &quot;A String&quot;, # Levels of availability for a user role permission.
175 &quot;id&quot;: &quot;A String&quot;, # ID of this user role permission.
176 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRolePermission&quot;.
177 &quot;name&quot;: &quot;A String&quot;, # Name of this user role permission.
178 &quot;permissionGroupId&quot;: &quot;A String&quot;, # ID of the permission group that this user role permission belongs to.
179 },
180 ],
181 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this user role. This is a read-only field that can be left blank.
182}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188
189Returns:
190 An object of the form:
191
192 { # Contains properties of auser role, which is used to manage user access.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]193 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this user role. This is a read-only field that can be left blank.
194 &quot;defaultUserRole&quot;: True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
195 &quot;id&quot;: &quot;A String&quot;, # ID of this user role. This is a read-only, auto-generated field.
196 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRole&quot;.
197 &quot;name&quot;: &quot;A String&quot;, # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
198 &quot;parentUserRoleId&quot;: &quot;A String&quot;, # ID of the user role that this user role is based on or copied from. This is a required field.
199 &quot;permissions&quot;: [ # List of permissions associated with this user role.
200 { # Contains properties of a user role permission.
201 &quot;availability&quot;: &quot;A String&quot;, # Levels of availability for a user role permission.
202 &quot;id&quot;: &quot;A String&quot;, # ID of this user role permission.
203 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRolePermission&quot;.
204 &quot;name&quot;: &quot;A String&quot;, # Name of this user role permission.
205 &quot;permissionGroupId&quot;: &quot;A String&quot;, # ID of the permission group that this user role permission belongs to.
206 },
207 ],
208 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this user role. This is a read-only field that can be left blank.
209}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210</div>
211
212<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]213 <code class="details" id="list">list(profileId, accountUserRoleOnly=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 <pre>Retrieves a list of user roles, possibly filtered. This method supports paging.
215
216Args:
217 profileId: string, User profile ID associated with this request. (required)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]218 accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount.
219 ids: string, Select only user roles with the specified IDs. (repeated)
220 maxResults: integer, Maximum number of results to return.
221 pageToken: string, Value of the nextPageToken from the previous result page.
222 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, &quot;userrole*2015&quot; will return objects with names like &quot;userrole June 2015&quot;, &quot;userrole April 2015&quot;, or simply &quot;userrole 2015&quot;. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of &quot;userrole&quot; will match objects with name &quot;my userrole&quot;, &quot;userrole 2015&quot;, or simply &quot;userrole&quot;.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]223 sortField: string, Field by which to sort the list.
224 Allowed values
225 ID -
226 NAME -
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]227 sortOrder: string, Order of sorted results.
228 Allowed values
229 ASCENDING -
230 DESCENDING -
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]231 subaccountId: string, Select only user roles that belong to this subaccount.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]232 x__xgafv: string, V1 error format.
233 Allowed values
234 1 - v1 error format
235 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]236
237Returns:
238 An object of the form:
239
240 { # User Role List Response
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]241 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRolesListResponse&quot;.
242 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
243 &quot;userRoles&quot;: [ # User role collection.
244 { # Contains properties of auser role, which is used to manage user access.
245 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this user role. This is a read-only field that can be left blank.
246 &quot;defaultUserRole&quot;: True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
247 &quot;id&quot;: &quot;A String&quot;, # ID of this user role. This is a read-only, auto-generated field.
248 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRole&quot;.
249 &quot;name&quot;: &quot;A String&quot;, # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
250 &quot;parentUserRoleId&quot;: &quot;A String&quot;, # ID of the user role that this user role is based on or copied from. This is a required field.
251 &quot;permissions&quot;: [ # List of permissions associated with this user role.
252 { # Contains properties of a user role permission.
253 &quot;availability&quot;: &quot;A String&quot;, # Levels of availability for a user role permission.
254 &quot;id&quot;: &quot;A String&quot;, # ID of this user role permission.
255 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRolePermission&quot;.
256 &quot;name&quot;: &quot;A String&quot;, # Name of this user role permission.
257 &quot;permissionGroupId&quot;: &quot;A String&quot;, # ID of the permission group that this user role permission belongs to.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]258 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]259 ],
260 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this user role. This is a read-only field that can be left blank.
261 },
262 ],
263}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]264</div>
265
266<div class="method">
267 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
268 <pre>Retrieves the next page of results.
269
270Args:
271 previous_request: The request for the previous page. (required)
272 previous_response: The response from the request for the previous page. (required)
273
274Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]275 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]276 page. Returns None if there are no more items in the collection.
277 </pre>
278</div>
279
280<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]281 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 <pre>Updates an existing user role. This method supports patch semantics.
283
284Args:
285 profileId: string, User profile ID associated with this request. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]286 id: string, UserRole ID. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]287 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288 The object takes the form of:
289
290{ # Contains properties of auser role, which is used to manage user access.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]291 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this user role. This is a read-only field that can be left blank.
292 &quot;defaultUserRole&quot;: True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
293 &quot;id&quot;: &quot;A String&quot;, # ID of this user role. This is a read-only, auto-generated field.
294 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRole&quot;.
295 &quot;name&quot;: &quot;A String&quot;, # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
296 &quot;parentUserRoleId&quot;: &quot;A String&quot;, # ID of the user role that this user role is based on or copied from. This is a required field.
297 &quot;permissions&quot;: [ # List of permissions associated with this user role.
298 { # Contains properties of a user role permission.
299 &quot;availability&quot;: &quot;A String&quot;, # Levels of availability for a user role permission.
300 &quot;id&quot;: &quot;A String&quot;, # ID of this user role permission.
301 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRolePermission&quot;.
302 &quot;name&quot;: &quot;A String&quot;, # Name of this user role permission.
303 &quot;permissionGroupId&quot;: &quot;A String&quot;, # ID of the permission group that this user role permission belongs to.
304 },
305 ],
306 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this user role. This is a read-only field that can be left blank.
307}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]308
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]309 x__xgafv: string, V1 error format.
310 Allowed values
311 1 - v1 error format
312 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]313
314Returns:
315 An object of the form:
316
317 { # Contains properties of auser role, which is used to manage user access.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]318 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this user role. This is a read-only field that can be left blank.
319 &quot;defaultUserRole&quot;: True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
320 &quot;id&quot;: &quot;A String&quot;, # ID of this user role. This is a read-only, auto-generated field.
321 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRole&quot;.
322 &quot;name&quot;: &quot;A String&quot;, # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
323 &quot;parentUserRoleId&quot;: &quot;A String&quot;, # ID of the user role that this user role is based on or copied from. This is a required field.
324 &quot;permissions&quot;: [ # List of permissions associated with this user role.
325 { # Contains properties of a user role permission.
326 &quot;availability&quot;: &quot;A String&quot;, # Levels of availability for a user role permission.
327 &quot;id&quot;: &quot;A String&quot;, # ID of this user role permission.
328 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRolePermission&quot;.
329 &quot;name&quot;: &quot;A String&quot;, # Name of this user role permission.
330 &quot;permissionGroupId&quot;: &quot;A String&quot;, # ID of the permission group that this user role permission belongs to.
331 },
332 ],
333 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this user role. This is a read-only field that can be left blank.
334}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]335</div>
336
337<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]338 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]339 <pre>Updates an existing user role.
340
341Args:
342 profileId: string, User profile ID associated with this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]343 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]344 The object takes the form of:
345
346{ # Contains properties of auser role, which is used to manage user access.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]347 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this user role. This is a read-only field that can be left blank.
348 &quot;defaultUserRole&quot;: True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
349 &quot;id&quot;: &quot;A String&quot;, # ID of this user role. This is a read-only, auto-generated field.
350 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRole&quot;.
351 &quot;name&quot;: &quot;A String&quot;, # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
352 &quot;parentUserRoleId&quot;: &quot;A String&quot;, # ID of the user role that this user role is based on or copied from. This is a required field.
353 &quot;permissions&quot;: [ # List of permissions associated with this user role.
354 { # Contains properties of a user role permission.
355 &quot;availability&quot;: &quot;A String&quot;, # Levels of availability for a user role permission.
356 &quot;id&quot;: &quot;A String&quot;, # ID of this user role permission.
357 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRolePermission&quot;.
358 &quot;name&quot;: &quot;A String&quot;, # Name of this user role permission.
359 &quot;permissionGroupId&quot;: &quot;A String&quot;, # ID of the permission group that this user role permission belongs to.
360 },
361 ],
362 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this user role. This is a read-only field that can be left blank.
363}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]364
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]365 x__xgafv: string, V1 error format.
366 Allowed values
367 1 - v1 error format
368 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]369
370Returns:
371 An object of the form:
372
373 { # Contains properties of auser role, which is used to manage user access.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]374 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this user role. This is a read-only field that can be left blank.
375 &quot;defaultUserRole&quot;: True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
376 &quot;id&quot;: &quot;A String&quot;, # ID of this user role. This is a read-only, auto-generated field.
377 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRole&quot;.
378 &quot;name&quot;: &quot;A String&quot;, # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
379 &quot;parentUserRoleId&quot;: &quot;A String&quot;, # ID of the user role that this user role is based on or copied from. This is a required field.
380 &quot;permissions&quot;: [ # List of permissions associated with this user role.
381 { # Contains properties of a user role permission.
382 &quot;availability&quot;: &quot;A String&quot;, # Levels of availability for a user role permission.
383 &quot;id&quot;: &quot;A String&quot;, # ID of this user role permission.
384 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#userRolePermission&quot;.
385 &quot;name&quot;: &quot;A String&quot;, # Name of this user role permission.
386 &quot;permissionGroupId&quot;: &quot;A String&quot;, # ID of the permission group that this user role permission belongs to.
387 },
388 ],
389 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this user role. This is a read-only field that can be left blank.
390}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]391</div>
392
393</body></html>