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
|
<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="displayvideo_v3.html">Display & Video 360 API</a> . <a href="displayvideo_v3.users.html">users</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#bulkEditAssignedUserRoles">bulkEditAssignedUserRoles(userId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.</p>
<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="#create">create(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.</p>
<p class="toc_element">
<code><a href="#delete">delete(userId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.</p>
<p class="toc_element">
<code><a href="#get">get(userId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.</p>
<p class="toc_element">
<code><a href="#list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.</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(userId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="bulkEditAssignedUserRoles">bulkEditAssignedUserRoles(userId, body=None, x__xgafv=None)</code>
<pre>Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Args:
userId: string, Required. The ID of the user to which the assigned user roles belong. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BulkEditAssignedUserRoles.
"createdAssignedUserRoles": [ # The assigned user roles to create in batch, specified as a list of AssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
"userRole": "A String", # Required. The user role to assign to a user for the entity.
},
],
"deletedAssignedUserRoles": [ # The assigned user roles to delete in batch, specified as a list of assigned_user_role_ids. The format of assigned_user_role_id is `entityType-entityid`, for example `partner-123`.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"createdAssignedUserRoles": [ # The list of assigned user roles that have been successfully created. This list will be absent if empty.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
"userRole": "A String", # Required. The user role to assign to a user for the entity.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(body=None, x__xgafv=None)</code>
<pre>Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Args:
body: object, The request body.
The object takes the form of:
{ # A single user in Display & Video 360.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
"userRole": "A String", # Required. The user role to assign to a user for the entity.
},
],
"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
"email": "A String", # Required. Immutable. The email address used to identify the user.
"lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
"name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single user in Display & Video 360.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
"userRole": "A String", # Required. The user role to assign to a user for the entity.
},
],
"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
"email": "A String", # Required. Immutable. The email address used to identify the user.
"lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
"name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(userId, x__xgafv=None)</code>
<pre>Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Args:
userId: string, Required. The ID of the user to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(userId, x__xgafv=None)</code>
<pre>Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Args:
userId: string, Required. The ID of the user to fetch. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single user in Display & Video 360.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
"userRole": "A String", # Required. The user role to assign to a user for the entity.
},
],
"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
"email": "A String", # Required. Immutable. The email address used to identify the user.
"lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
"name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Args:
filter: string, Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` and `email` fields must use the `HAS (:)` operator. * The `lastLoginTime` field must use either the `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId`: This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * The user with `displayName` containing "foo": `displayName:"foo"` * The user with `email` containing "bar": `email:"bar"` * All users with standard user roles: `assignedUserRole.userRole="STANDARD"` * All users with user roles for partner 123: `assignedUserRole.partnerId="123"` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId="123"` * All users with partner level user roles: `entityType="PARTNER"` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId="123"` * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO 8601): `lastLoginTime>="2023-01-01T00:00:00Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`.
pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListUsers` method. If not specified, the first page of results will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListUsers` method to retrieve the next page of results. This token will be absent if there are no more results to return.
"users": [ # The list of users. This list will be absent if empty.
{ # A single user in Display & Video 360.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
"userRole": "A String", # Required. The user role to assign to a user for the entity.
},
],
"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
"email": "A String", # Required. Immutable. The email address used to identify the user.
"lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
"name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
},
],
}</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(userId, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method.
Args:
userId: string, Output only. The unique ID of the user. Assigned by the system. (required)
body: object, The request body.
The object takes the form of:
{ # A single user in Display & Video 360.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
"userRole": "A String", # Required. The user role to assign to a user for the entity.
},
],
"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
"email": "A String", # Required. Immutable. The email address used to identify the user.
"lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
"name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
}
updateMask: string, Required. The mask to control which fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single user in Display & Video 360.
"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.
"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.
"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.
"partnerId": "A String", # The ID of the partner that the assigned user role applies to.
"userRole": "A String", # Required. The user role to assign to a user for the entity.
},
],
"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
"email": "A String", # Required. Immutable. The email address used to identify the user.
"lastLoginTime": "A String", # Output only. The timestamp when the user last logged in DV360 UI.
"name": "A String", # Output only. The resource name of the user.
"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.
}</pre>
</div>
</body></html>
|
