class Users extends Resource (View source)

The "users" collection of methods.

Typical usage is:

 $displayvideoService = new Google\Service\DisplayVideo(...);
 $users = $displayvideoService->users;

Methods

bulkEditAssignedUserRoles(string $userId, BulkEditAssignedUserRolesRequest $postBody, array $optParams = [])

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 before using this method. The "Try this method" feature does not work for this method. (users.bulkEditAssignedUserRoles)

create(User $postBody, array $optParams = [])

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 before using this method. The "Try this method" feature does not work for this method. (users.create)

delete(string $userId, array $optParams = [])

Deletes a user. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method. (users.delete)

get(string $userId, array $optParams = [])

Gets a user. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method. (users.get)

listUsers(array $optParams = [])

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 before using this method. The "Try this method" feature does not work for this method. (users.listUsers)

patch(string $userId, User $postBody, array $optParams = [])

Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method. (users.patch)

Details

BulkEditAssignedUserRolesResponse bulkEditAssignedUserRoles(string $userId, BulkEditAssignedUserRolesRequest $postBody, array $optParams = [])

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 before using this method. The "Try this method" feature does not work for this method. (users.bulkEditAssignedUserRoles)

Parameters

string $userId

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

BulkEditAssignedUserRolesRequest $postBody
array $optParams

Optional parameters.

Return Value

BulkEditAssignedUserRolesResponse

Exceptions

Exception

User create(User $postBody, array $optParams = [])

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 before using this method. The "Try this method" feature does not work for this method. (users.create)

Parameters

User $postBody
array $optParams

Optional parameters.

Return Value

User

Exceptions

Exception

DisplayvideoEmpty delete(string $userId, array $optParams = [])

Deletes a user. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method. (users.delete)

Parameters

string $userId

Required. The ID of the user to delete.

array $optParams

Optional parameters.

Return Value

DisplayvideoEmpty

Exceptions

Exception

User get(string $userId, array $optParams = [])

Gets a user. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method. (users.get)

Parameters

string $userId

Required. The ID of the user to fetch.

array $optParams

Optional parameters.

Return Value

User

Exceptions

Exception

ListUsersResponse listUsers(array $optParams = [])

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 before using this method. The "Try this method" feature does not work for this method. (users.listUsers)

Parameters

array $optParams

Optional parameters.

Return Value

ListUsersResponse

Exceptions

Exception

User patch(string $userId, User $postBody, array $optParams = [])

Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method. The "Try this method" feature does not work for this method. (users.patch)

Parameters

string $userId

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

User $postBody
array $optParams

Optional parameters.

Return Value

User

Exceptions

Exception