com.google.api.services.displayvideo.v4

Class DisplayVideo.Users

java.lang.Object

com.google.api.services.displayvideo.v4.DisplayVideo.Users

Enclosing class:

DisplayVideo

public class DisplayVideo.Users
extends Object

The "users" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DisplayVideo.Users.BulkEditAssignedUserRoles
class	DisplayVideo.Users.Create
class	DisplayVideo.Users.Delete
class	DisplayVideo.Users.Get
class	DisplayVideo.Users.List
class	DisplayVideo.Users.Patch

Constructor Summary

Constructors

Constructor and Description
Users()

Method Summary

Modifier and Type	Method and Description
DisplayVideo.Users.BulkEditAssignedUserRoles	bulkEditAssignedUserRoles(Long userId, BulkEditAssignedUserRolesRequest content) Bulk edits user roles for a user.
DisplayVideo.Users.Create	create(User content) Creates a new user.
DisplayVideo.Users.Delete	delete(Long userId) Deletes a user.
DisplayVideo.Users.Get	get(Long userId) Gets a user.
DisplayVideo.Users.List	list() Lists users that are accessible to the current user.
DisplayVideo.Users.Patch	patch(Long userId, User content) Updates an existing user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Users

public Users()

Method Detail

bulkEditAssignedUserRoles

public DisplayVideo.Users.BulkEditAssignedUserRoles bulkEditAssignedUserRoles(Long userId,
                                                                              BulkEditAssignedUserRolesRequest content)
                                                                       throws IOException

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. Create a request for the method "users.bulkEditAssignedUserRoles". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - Required. The ID of the user to which the assigned user roles belong.

content - the BulkEditAssignedUserRolesRequest

Returns:

the request

Throws:

IOException

create

public DisplayVideo.Users.Create create(User content)
                                 throws IOException

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. Create a request for the method "users.create". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the User

Returns:

the request

Throws:

IOException

delete

public DisplayVideo.Users.Delete delete(Long userId)
                                 throws IOException

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. Create a request for the method "users.delete". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - Required. The ID of the user to delete.

Returns:

the request

Throws:

IOException

get

public DisplayVideo.Users.Get get(Long userId)
                           throws IOException

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. Create a request for the method "users.get". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - Required. The ID of the user to fetch.

Returns:

the request

Throws:

IOException

list

public DisplayVideo.Users.List list()
                             throws IOException

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. Create a request for the method "users.list". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

patch

public DisplayVideo.Users.Patch patch(Long userId,
                                      User content)
                               throws IOException

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. Create a request for the method "users.patch". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

userId - Output only. The unique ID of the user. Assigned by the system.

content - the User

Returns:

the request

Throws:

IOException