Debian Codegraph @

docs/dyn/displayvideo_v1.users.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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.users.html">users</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#bulkEditAssignedUserRoles">bulkEditAssignedUserRoles(userId, body=None, x__xgafv=None)</a></code></p>
79 <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>
80 <p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82 <p class="firstline">Close httplib2 connections.</p>
83 <p class="toc_element">
84 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
85 <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>
86 <p class="toc_element">
87 <code><a href="#delete">delete(userId, x__xgafv=None)</a></code></p>
88 <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>
89 <p class="toc_element">
90 <code><a href="#get">get(userId, x__xgafv=None)</a></code></p>
91 <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>
92 <p class="toc_element">
93 <code><a href="#list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
94 <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>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#patch">patch(userId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
100 <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>
101 <h3>Method Details</h3>
102 <div class="method">
103 <code class="details" id="bulkEditAssignedUserRoles">bulkEditAssignedUserRoles(userId, body=None, x__xgafv=None)</code>
104 <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 &quot;Try this method&quot; feature does not work for this method.
105
106 Args:
107 userId: string, Required. The ID of the user to which the assigned user roles belong. (required)
108 body: object, The request body.
109 The object takes the form of:
110
111 { # Request message for BulkEditAssignedUserRoles.
112 &quot;createdAssignedUserRoles&quot;: [ # The assigned user roles to create in batch, specified as a list of AssignedUserRoles.
113 { # A single assigned user role, which defines a user&#x27;s authorized interaction with a specified partner or advertiser.
114 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that the assigend user role applies to.
115 &quot;assignedUserRoleId&quot;: &quot;A String&quot;, # Output only. The ID of the assigned user role.
116 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that the assigned user role applies to.
117 &quot;userRole&quot;: &quot;A String&quot;, # Required. The user role to assign to a user for the entity.
118 },
119 ],
120 &quot;deletedAssignedUserRoles&quot;: [ # 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`.
121 &quot;A String&quot;,
122 ],
123 }
124
125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130 Returns:
131 An object of the form:
132
133 {
134 &quot;createdAssignedUserRoles&quot;: [ # The list of assigned user roles that have been successfully created. This list will be absent if empty.
135 { # A single assigned user role, which defines a user&#x27;s authorized interaction with a specified partner or advertiser.
136 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that the assigend user role applies to.
137 &quot;assignedUserRoleId&quot;: &quot;A String&quot;, # Output only. The ID of the assigned user role.
138 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that the assigned user role applies to.
139 &quot;userRole&quot;: &quot;A String&quot;, # Required. The user role to assign to a user for the entity.
140 },
141 ],
142 }</pre>
143 </div>
144
145 <div class="method">
146 <code class="details" id="close">close()</code>
147 <pre>Close httplib2 connections.</pre>
148 </div>
149
150 <div class="method">
151 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
152 <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 &quot;Try this method&quot; feature does not work for this method.
153
154 Args:
155 body: object, The request body.
156 The object takes the form of:
157
158 { # A single user in Display &amp; Video 360.
159 &quot;assignedUserRoles&quot;: [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
160 { # A single assigned user role, which defines a user&#x27;s authorized interaction with a specified partner or advertiser.
161 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that the assigend user role applies to.
162 &quot;assignedUserRoleId&quot;: &quot;A String&quot;, # Output only. The ID of the assigned user role.
163 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that the assigned user role applies to.
164 &quot;userRole&quot;: &quot;A String&quot;, # Required. The user role to assign to a user for the entity.
165 },
166 ],
167 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
168 &quot;email&quot;: &quot;A String&quot;, # Required. Immutable. The email address used to identify the user.
169 &quot;lastLoginTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the user last logged in DV360 UI.
170 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the user.
171 &quot;userId&quot;: &quot;A String&quot;, # Output only. The unique ID of the user. Assigned by the system.
172 }
173
174 x__xgafv: string, V1 error format.
175 Allowed values
176 1 - v1 error format
177 2 - v2 error format
178
179 Returns:
180 An object of the form:
181
182 { # A single user in Display &amp; Video 360.
183 &quot;assignedUserRoles&quot;: [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
184 { # A single assigned user role, which defines a user&#x27;s authorized interaction with a specified partner or advertiser.
185 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that the assigend user role applies to.
186 &quot;assignedUserRoleId&quot;: &quot;A String&quot;, # Output only. The ID of the assigned user role.
187 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that the assigned user role applies to.
188 &quot;userRole&quot;: &quot;A String&quot;, # Required. The user role to assign to a user for the entity.
189 },
190 ],
191 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
192 &quot;email&quot;: &quot;A String&quot;, # Required. Immutable. The email address used to identify the user.
193 &quot;lastLoginTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the user last logged in DV360 UI.
194 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the user.
195 &quot;userId&quot;: &quot;A String&quot;, # Output only. The unique ID of the user. Assigned by the system.
196 }</pre>
197 </div>
198
199 <div class="method">
200 <code class="details" id="delete">delete(userId, x__xgafv=None)</code>
201 <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 &quot;Try this method&quot; feature does not work for this method.
202
203 Args:
204 userId: string, Required. The ID of the user to delete. (required)
205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
209
210 Returns:
211 An object of the form:
212
213 { # 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); }
214 }</pre>
215 </div>
216
217 <div class="method">
218 <code class="details" id="get">get(userId, x__xgafv=None)</code>
219 <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 &quot;Try this method&quot; feature does not work for this method.
220
221 Args:
222 userId: string, Required. The ID of the user to fetch. (required)
223 x__xgafv: string, V1 error format.
224 Allowed values
225 1 - v1 error format
226 2 - v2 error format
227
228 Returns:
229 An object of the form:
230
231 { # A single user in Display &amp; Video 360.
232 &quot;assignedUserRoles&quot;: [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
233 { # A single assigned user role, which defines a user&#x27;s authorized interaction with a specified partner or advertiser.
234 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that the assigend user role applies to.
235 &quot;assignedUserRoleId&quot;: &quot;A String&quot;, # Output only. The ID of the assigned user role.
236 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that the assigned user role applies to.
237 &quot;userRole&quot;: &quot;A String&quot;, # Required. The user role to assign to a user for the entity.
238 },
239 ],
240 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
241 &quot;email&quot;: &quot;A String&quot;, # Required. Immutable. The email address used to identify the user.
242 &quot;lastLoginTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the user last logged in DV360 UI.
243 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the user.
244 &quot;userId&quot;: &quot;A String&quot;, # Output only. The unique ID of the user. Assigned by the system.
245 }</pre>
246 </div>
247
248 <div class="method">
249 <code class="details" id="list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
250 <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 &quot;Try this method&quot; feature does not work for this method.
251
252 Args:
253 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 `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (&lt;)` operator. * The `displayName and `email` field must use the `HAS (:)` 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` Examples: * The user with `displayName` containing &quot;foo&quot;: `displayName:&quot;foo&quot;` * The user with `email` containing &quot;bar&quot;: `email:&quot;bar&quot;` * All users with standard user roles: `assignedUserRole.userRole=&quot;STANDARD&quot;` * All users with user roles for partner 123: `assignedUserRole.partnerId=&quot;123&quot;` * All users with user roles for advertiser 123: `assignedUserRole.advertiserId=&quot;123&quot;` * All users with partner level user roles: `entityType=&quot;PARTNER&quot;` * All users with user roles for partner 123 and advertisers under partner 123: `parentPartnerId=&quot;123&quot;` 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.
254 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 &quot;desc&quot; should be added to the field name. For example, `displayName desc`.
255 pageSize: integer, Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.
256 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.
257 x__xgafv: string, V1 error format.
258 Allowed values
259 1 - v1 error format
260 2 - v2 error format
261
262 Returns:
263 An object of the form:
264
265 {
266 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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.
267 &quot;users&quot;: [ # The list of users. This list will be absent if empty.
268 { # A single user in Display &amp; Video 360.
269 &quot;assignedUserRoles&quot;: [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
270 { # A single assigned user role, which defines a user&#x27;s authorized interaction with a specified partner or advertiser.
271 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that the assigend user role applies to.
272 &quot;assignedUserRoleId&quot;: &quot;A String&quot;, # Output only. The ID of the assigned user role.
273 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that the assigned user role applies to.
274 &quot;userRole&quot;: &quot;A String&quot;, # Required. The user role to assign to a user for the entity.
275 },
276 ],
277 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
278 &quot;email&quot;: &quot;A String&quot;, # Required. Immutable. The email address used to identify the user.
279 &quot;lastLoginTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the user last logged in DV360 UI.
280 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the user.
281 &quot;userId&quot;: &quot;A String&quot;, # Output only. The unique ID of the user. Assigned by the system.
282 },
283 ],
284 }</pre>
285 </div>
286
287 <div class="method">
288 <code class="details" id="list_next">list_next()</code>
289 <pre>Retrieves the next page of results.
290
291 Args:
292 previous_request: The request for the previous page. (required)
293 previous_response: The response from the request for the previous page. (required)
294
295 Returns:
296 A request object that you can call &#x27;execute()&#x27; on to request the next
297 page. Returns None if there are no more items in the collection.
298 </pre>
299 </div>
300
301 <div class="method">
302 <code class="details" id="patch">patch(userId, body=None, updateMask=None, x__xgafv=None)</code>
303 <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 &quot;Try this method&quot; feature does not work for this method.
304
305 Args:
306 userId: string, Output only. The unique ID of the user. Assigned by the system. (required)
307 body: object, The request body.
308 The object takes the form of:
309
310 { # A single user in Display &amp; Video 360.
311 &quot;assignedUserRoles&quot;: [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
312 { # A single assigned user role, which defines a user&#x27;s authorized interaction with a specified partner or advertiser.
313 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that the assigend user role applies to.
314 &quot;assignedUserRoleId&quot;: &quot;A String&quot;, # Output only. The ID of the assigned user role.
315 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that the assigned user role applies to.
316 &quot;userRole&quot;: &quot;A String&quot;, # Required. The user role to assign to a user for the entity.
317 },
318 ],
319 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
320 &quot;email&quot;: &quot;A String&quot;, # Required. Immutable. The email address used to identify the user.
321 &quot;lastLoginTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the user last logged in DV360 UI.
322 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the user.
323 &quot;userId&quot;: &quot;A String&quot;, # Output only. The unique ID of the user. Assigned by the system.
324 }
325
326 updateMask: string, Required. The mask to control which fields to update.
327 x__xgafv: string, V1 error format.
328 Allowed values
329 1 - v1 error format
330 2 - v2 error format
331
332 Returns:
333 An object of the form:
334
335 { # A single user in Display &amp; Video 360.
336 &quot;assignedUserRoles&quot;: [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.
337 { # A single assigned user role, which defines a user&#x27;s authorized interaction with a specified partner or advertiser.
338 &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser that the assigend user role applies to.
339 &quot;assignedUserRoleId&quot;: &quot;A String&quot;, # Output only. The ID of the assigned user role.
340 &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner that the assigned user role applies to.
341 &quot;userRole&quot;: &quot;A String&quot;, # Required. The user role to assign to a user for the entity.
342 },
343 ],
344 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.
345 &quot;email&quot;: &quot;A String&quot;, # Required. Immutable. The email address used to identify the user.
346 &quot;lastLoginTime&quot;: &quot;A String&quot;, # Output only. The timestamp when the user last logged in DV360 UI.
347 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the user.
348 &quot;userId&quot;: &quot;A String&quot;, # Output only. The unique ID of the user. Assigned by the system.
349 }</pre>
350 </div>
351
352 </body></html>