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 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.</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.</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.</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.</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.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</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.</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. 105 106Args: 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 "createdAssignedUserRoles": [ # The assigned user roles to create in batch, specified as a list of AssignedUserRoles. 113 { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser. 114 "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to. 115 "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role. 116 "partnerId": "A String", # The ID of the partner that the assigned user role applies to. 117 "userRole": "A String", # Required. The user role to assign to a user for the entity. 118 }, 119 ], 120 "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`. 121 "A String", 122 ], 123} 124 125 x__xgafv: string, V1 error format. 126 Allowed values 127 1 - v1 error format 128 2 - v2 error format 129 130Returns: 131 An object of the form: 132 133 { 134 "createdAssignedUserRoles": [ # 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's authorized interaction with a specified partner or advertiser. 136 "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to. 137 "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role. 138 "partnerId": "A String", # The ID of the partner that the assigned user role applies to. 139 "userRole": "A String", # 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. 153 154Args: 155 body: object, The request body. 156 The object takes the form of: 157 158{ # A single user in Display & Video 360. 159 "assignedUserRoles": [ # 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's authorized interaction with a specified partner or advertiser. 161 "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to. 162 "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role. 163 "partnerId": "A String", # The ID of the partner that the assigned user role applies to. 164 "userRole": "A String", # Required. The user role to assign to a user for the entity. 165 }, 166 ], 167 "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes. 168 "email": "A String", # Required. Immutable. The email address used to identify the user. 169 "name": "A String", # Output only. The resource name of the user. 170 "userId": "A String", # Output only. The unique ID of the user. Assigned by the system. 171} 172 173 x__xgafv: string, V1 error format. 174 Allowed values 175 1 - v1 error format 176 2 - v2 error format 177 178Returns: 179 An object of the form: 180 181 { # A single user in Display & Video 360. 182 "assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles. 183 { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser. 184 "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to. 185 "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role. 186 "partnerId": "A String", # The ID of the partner that the assigned user role applies to. 187 "userRole": "A String", # Required. The user role to assign to a user for the entity. 188 }, 189 ], 190 "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes. 191 "email": "A String", # Required. Immutable. The email address used to identify the user. 192 "name": "A String", # Output only. The resource name of the user. 193 "userId": "A String", # Output only. The unique ID of the user. Assigned by the system. 194}</pre> 195</div> 196 197<div class="method"> 198 <code class="details" id="delete">delete(userId, x__xgafv=None)</code> 199 <pre>Deletes a user. 200 201Args: 202 userId: string, Required. The ID of the user to delete. (required) 203 x__xgafv: string, V1 error format. 204 Allowed values 205 1 - v1 error format 206 2 - v2 error format 207 208Returns: 209 An object of the form: 210 211 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`. 212}</pre> 213</div> 214 215<div class="method"> 216 <code class="details" id="get">get(userId, x__xgafv=None)</code> 217 <pre>Gets a user. 218 219Args: 220 userId: string, Required. The ID of the user to fetch. (required) 221 x__xgafv: string, V1 error format. 222 Allowed values 223 1 - v1 error format 224 2 - v2 error format 225 226Returns: 227 An object of the form: 228 229 { # A single user in Display & Video 360. 230 "assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles. 231 { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser. 232 "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to. 233 "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role. 234 "partnerId": "A String", # The ID of the partner that the assigned user role applies to. 235 "userRole": "A String", # Required. The user role to assign to a user for the entity. 236 }, 237 ], 238 "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes. 239 "email": "A String", # Required. Immutable. The email address used to identify the user. 240 "name": "A String", # Output only. The resource name of the user. 241 "userId": "A String", # Output only. The unique ID of the user. Assigned by the system. 242}</pre> 243</div> 244 245<div class="method"> 246 <code class="details" id="list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 247 <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. 248 249Args: 250 filter: string, Allows filtering by user properties. 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 operator must be `CONTAINS (:)` or `EQUALS (=)`. * The operator must be `CONTAINS (:)` for the following fields: - `displayName` - `email` * The operator must be `EQUALS (=)` for the following fields: - `assignedUserRole.userRole` - `assignedUserRole.partnerId` - `assignedUserRole.advertiserId` - `assignedUserRole.entityType`: A 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`: A synthetic field of AssignedUserRole used for filtering. Identifies the parent partner of the entity to which the user role is assigned." 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"` The length of this field should be no more than 500 characters. 251 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`. 252 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. 253 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. 254 x__xgafv: string, V1 error format. 255 Allowed values 256 1 - v1 error format 257 2 - v2 error format 258 259Returns: 260 An object of the form: 261 262 { 263 "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. 264 "users": [ # The list of users. This list will be absent if empty. 265 { # A single user in Display & Video 360. 266 "assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles. 267 { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser. 268 "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to. 269 "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role. 270 "partnerId": "A String", # The ID of the partner that the assigned user role applies to. 271 "userRole": "A String", # Required. The user role to assign to a user for the entity. 272 }, 273 ], 274 "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes. 275 "email": "A String", # Required. Immutable. The email address used to identify the user. 276 "name": "A String", # Output only. The resource name of the user. 277 "userId": "A String", # Output only. The unique ID of the user. Assigned by the system. 278 }, 279 ], 280}</pre> 281</div> 282 283<div class="method"> 284 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 285 <pre>Retrieves the next page of results. 286 287Args: 288 previous_request: The request for the previous page. (required) 289 previous_response: The response from the request for the previous page. (required) 290 291Returns: 292 A request object that you can call 'execute()' on to request the next 293 page. Returns None if there are no more items in the collection. 294 </pre> 295</div> 296 297<div class="method"> 298 <code class="details" id="patch">patch(userId, body=None, updateMask=None, x__xgafv=None)</code> 299 <pre>Updates an existing user. Returns the updated user if successful. 300 301Args: 302 userId: string, Output only. The unique ID of the user. Assigned by the system. (required) 303 body: object, The request body. 304 The object takes the form of: 305 306{ # A single user in Display & Video 360. 307 "assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles. 308 { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser. 309 "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to. 310 "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role. 311 "partnerId": "A String", # The ID of the partner that the assigned user role applies to. 312 "userRole": "A String", # Required. The user role to assign to a user for the entity. 313 }, 314 ], 315 "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes. 316 "email": "A String", # Required. Immutable. The email address used to identify the user. 317 "name": "A String", # Output only. The resource name of the user. 318 "userId": "A String", # Output only. The unique ID of the user. Assigned by the system. 319} 320 321 updateMask: string, Required. The mask to control which fields to update. 322 x__xgafv: string, V1 error format. 323 Allowed values 324 1 - v1 error format 325 2 - v2 error format 326 327Returns: 328 An object of the form: 329 330 { # A single user in Display & Video 360. 331 "assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles. 332 { # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser. 333 "advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to. 334 "assignedUserRoleId": "A String", # Output only. The ID of the assigned user role. 335 "partnerId": "A String", # The ID of the partner that the assigned user role applies to. 336 "userRole": "A String", # Required. The user role to assign to a user for the entity. 337 }, 338 ], 339 "displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes. 340 "email": "A String", # Required. Immutable. The email address used to identify the user. 341 "name": "A String", # Output only. The resource name of the user. 342 "userId": "A String", # Output only. The unique ID of the user. Assigned by the system. 343}</pre> 344</div> 345 346</body></html>