Blame - docs/dyn/displayvideo_v1.users.html - platform/external/python/google-api-python-client

<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

81

<code><a href="#close">close()</a></code></p>

82

<p class="firstline">Close httplib2 connections.</p>

83

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

87

<code><a href="#delete">delete(userId, x__xgafv=None)</a></code></p>

88

<p class="firstline">Deletes a user.</p>

89

90

<code><a href="#get">get(userId, x__xgafv=None)</a></code></p>

91

92

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

93

<code><a href="#list">list(pageToken=None, orderBy=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

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

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

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

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

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

"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`.

113

"A String",

114

],

115

"createdAssignedUserRoles": [ # The assigned user roles to create in batch, specified as a list of AssignedUserRoles.

116

{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

117

"userRole": "A String", # Required. The user role to assign to a user for the entity.

118

"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

119

"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.

120

"partnerId": "A String", # The ID of the partner that the assigned user role applies to.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

},

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

136

"userRole": "A String", # Required. The user role to assign to a user for the entity.

137

"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

138

"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.

139

"partnerId": "A String", # The ID of the partner that the assigned user role applies to.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="close">close()</code>

147

<pre>Close httplib2 connections.</pre>

</div>

<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

154

Args:

155

body: object, The request body.

156

The object takes the form of:

157

158

{ # A single user in Display & Video 360.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

159

"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.

160

"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.

161

"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.

162

{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.

163

"userRole": "A String", # Required. The user role to assign to a user for the entity.

164

"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.

165

"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.

166

"partnerId": "A String", # The ID of the partner that the assigned user role applies to.

167

},

168

],

169

"email": "A String", # Required. Immutable. The email address used to identify the user.

170

"name": "A String", # Output only. The resource name of the user.

171

}

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

172

173

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

180

181

{ # A single user in Display & Video 360.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

182

"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.

183

"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.

184

"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.

185

{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.

186

"userRole": "A String", # Required. The user role to assign to a user for the entity.

187

"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.

188

"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.

189

"partnerId": "A String", # The ID of the partner that the assigned user role applies to.

190

},

191

],

192

"email": "A String", # Required. Immutable. The email address used to identify the user.

193

"name": "A String", # Output only. The resource name of the user.

194

}</pre>

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<code class="details" id="delete">delete(userId, x__xgafv=None)</code>

<pre>Deletes a user.

Args:

userId: string, Required. The ID of the user to delete. (required)

203

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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 `{}`.

}</pre>

</div>

<code class="details" id="get">get(userId, x__xgafv=None)</code>

<pre>Gets a user.

Args:

userId: string, Required. The ID of the user to fetch. (required)

221

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

228

229

{ # A single user in Display & Video 360.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

230

"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.

231

"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.

232

"assignedUserRoles": [ # 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's authorized interaction with a specified partner or advertiser.

234

"userRole": "A String", # Required. The user role to assign to a user for the entity.

235

"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.

236

"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.

237

"partnerId": "A String", # The ID of the partner that the assigned user role applies to.

238

},

239

],

240

"email": "A String", # Required. Immutable. The email address used to identify the user.

241

"name": "A String", # Output only. The resource name of the user.

242

}</pre>

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

246

<code class="details" id="list">list(pageToken=None, orderBy=None, filter=None, pageSize=None, x__xgafv=None)</code>

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

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

249

Args:

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

250

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.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

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

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.

253

pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

254

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

261

262

{

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

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.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

264

"users": [ # The list of users. This list will be absent if empty.

265

{ # A single user in Display & Video 360.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

266

"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.

267

"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.

268

"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.

269

{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.

270

"userRole": "A String", # Required. The user role to assign to a user for the entity.

271

"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.

272

"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.

273

"partnerId": "A String", # The ID of the partner that the assigned user role applies to.

274

},

275

],

276

"email": "A String", # Required. Immutable. The email address used to identify the user.

277

"name": "A String", # Output only. The resource name of the user.

278

},

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

279

],

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

285

<pre>Retrieves the next page of results.

286

287

Args:

288

previous_request: The request for the previous page. (required)

289

previous_response: The response from the request for the previous page. (required)

290

291

Returns:

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.

</pre>

</div>

<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

301

Args:

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.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

307

"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.

308

"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.

309

"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.

310

{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.

311

"userRole": "A String", # Required. The user role to assign to a user for the entity.

312

"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.

313

"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.

314

"partnerId": "A String", # The ID of the partner that the assigned user role applies to.

315

},

316

],

317

"email": "A String", # Required. Immutable. The email address used to identify the user.

318

"name": "A String", # Output only. The resource name of the user.

319

}

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

320

321

updateMask: string, Required. The mask to control which fields to update.

322

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

329

330

{ # A single user in Display & Video 360.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame^]

331

"displayName": "A String", # Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes.

332

"userId": "A String", # Output only. The unique ID of the user. Assigned by the system.

333

"assignedUserRoles": [ # The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles.

334

{ # A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.

335

"userRole": "A String", # Required. The user role to assign to a user for the entity.

336

"assignedUserRoleId": "A String", # Output only. The ID of the assigned user role.

337

"advertiserId": "A String", # The ID of the advertiser that the assigend user role applies to.

338

"partnerId": "A String", # The ID of the partner that the assigned user role applies to.

339

},

340

],

341

"email": "A String", # Required. Immutable. The email address used to identify the user.

342

"name": "A String", # Output only. The resource name of the user.

343

}</pre>

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

344

</div>

345

346

</body></html>