1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dfareporting_v3_5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_5.userRoles.html">userRoles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(profileId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing user role.</p>
<p class="toc_element">
<code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one user role by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new user role.</p>
<p class="toc_element">
<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>
<p class="firstline">Retrieves a list of user roles, possibly filtered. This method supports paging.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing user role. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing user role.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(profileId, id, x__xgafv=None)</code>
<pre>Deletes an existing user role.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, User role ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
<pre>Gets one user role by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, User role ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of auser role, which is used to manage user access.
"accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
"defaultUserRole": 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.
"id": "A String", # ID of this user role. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
"name": "A String", # 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.
"parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
"permissions": [ # List of permissions associated with this user role.
{ # Contains properties of a user role permission.
"availability": "A String", # Levels of availability for a user role permission.
"id": "A String", # ID of this user role permission.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
"name": "A String", # Name of this user role permission.
"permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
},
],
"subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
<pre>Inserts a new user role.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of auser role, which is used to manage user access.
"accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
"defaultUserRole": 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.
"id": "A String", # ID of this user role. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
"name": "A String", # 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.
"parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
"permissions": [ # List of permissions associated with this user role.
{ # Contains properties of a user role permission.
"availability": "A String", # Levels of availability for a user role permission.
"id": "A String", # ID of this user role permission.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
"name": "A String", # Name of this user role permission.
"permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
},
],
"subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of auser role, which is used to manage user access.
"accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
"defaultUserRole": 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.
"id": "A String", # ID of this user role. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
"name": "A String", # 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.
"parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
"permissions": [ # List of permissions associated with this user role.
{ # Contains properties of a user role permission.
"availability": "A String", # Levels of availability for a user role permission.
"id": "A String", # ID of this user role permission.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
"name": "A String", # Name of this user role permission.
"permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
},
],
"subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
}</pre>
</div>
<div class="method">
<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>
<pre>Retrieves a list of user roles, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount.
ids: string, Select only user roles with the specified IDs. (repeated)
maxResults: integer, Maximum number of results to return.
pageToken: string, Value of the nextPageToken from the previous result page.
searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
subaccountId: string, Select only user roles that belong to this subaccount.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # User Role List Response
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse".
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"userRoles": [ # User role collection.
{ # Contains properties of auser role, which is used to manage user access.
"accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
"defaultUserRole": 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.
"id": "A String", # ID of this user role. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
"name": "A String", # 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.
"parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
"permissions": [ # List of permissions associated with this user role.
{ # Contains properties of a user role permission.
"availability": "A String", # Levels of availability for a user role permission.
"id": "A String", # ID of this user role permission.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
"name": "A String", # Name of this user role permission.
"permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
},
],
"subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
<pre>Updates an existing user role. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, UserRole ID. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of auser role, which is used to manage user access.
"accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
"defaultUserRole": 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.
"id": "A String", # ID of this user role. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
"name": "A String", # 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.
"parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
"permissions": [ # List of permissions associated with this user role.
{ # Contains properties of a user role permission.
"availability": "A String", # Levels of availability for a user role permission.
"id": "A String", # ID of this user role permission.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
"name": "A String", # Name of this user role permission.
"permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
},
],
"subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of auser role, which is used to manage user access.
"accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
"defaultUserRole": 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.
"id": "A String", # ID of this user role. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
"name": "A String", # 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.
"parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
"permissions": [ # List of permissions associated with this user role.
{ # Contains properties of a user role permission.
"availability": "A String", # Levels of availability for a user role permission.
"id": "A String", # ID of this user role permission.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
"name": "A String", # Name of this user role permission.
"permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
},
],
"subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
<pre>Updates an existing user role.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of auser role, which is used to manage user access.
"accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
"defaultUserRole": 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.
"id": "A String", # ID of this user role. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
"name": "A String", # 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.
"parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
"permissions": [ # List of permissions associated with this user role.
{ # Contains properties of a user role permission.
"availability": "A String", # Levels of availability for a user role permission.
"id": "A String", # ID of this user role permission.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
"name": "A String", # Name of this user role permission.
"permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
},
],
"subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of auser role, which is used to manage user access.
"accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
"defaultUserRole": 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.
"id": "A String", # ID of this user role. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
"name": "A String", # 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.
"parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
"permissions": [ # List of permissions associated with this user role.
{ # Contains properties of a user role permission.
"availability": "A String", # Levels of availability for a user role permission.
"id": "A String", # ID of this user role permission.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
"name": "A String", # Name of this user role permission.
"permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
},
],
"subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
}</pre>
</div>
</body></html>
|
