Documentation

Google_Service_DisplayVideo_Resource_Users extends Google_Service_Resource
in package

The "users" collection of methods.

Typical usage is: $displayvideoService = new Google_Service_DisplayVideo(...); $users = $displayvideoService->users;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
bulkEditAssignedUserRoles()  : Google_Service_DisplayVideo_BulkEditAssignedUserRolesResponse
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.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_DisplayVideo_User
Creates a new user. Returns the newly created user if successful.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DisplayVideo_DisplayvideoEmpty
Deletes a user. (users.delete)
get()  : Google_Service_DisplayVideo_User
Gets a user. (users.get)
listUsers()  : Google_Service_DisplayVideo_ListUsersResponse
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.
patch()  : Google_Service_DisplayVideo_User
Updates an existing user. Returns the updated user if successful.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

bulkEditAssignedUserRoles()

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.

public bulkEditAssignedUserRoles(string $userId, Google_Service_DisplayVideo_BulkEditAssignedUserRolesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_BulkEditAssignedUserRolesResponse

(users.bulkEditAssignedUserRoles)

Parameters
$userId : string

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

$postBody : Google_Service_DisplayVideo_BulkEditAssignedUserRolesRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DisplayVideo_BulkEditAssignedUserRolesResponse —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

listUsers()

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.

public listUsers([array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_ListUsersResponse

(users.listUsers)

Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter 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.

opt_param

int pageSize Requested page size. Must be between 1 and 100. If unspecified will default to 100.

opt_param

string pageToken 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.

opt_param

string orderBy 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.

Return values
Google_Service_DisplayVideo_ListUsersResponse —

patch()

Updates an existing user. Returns the updated user if successful.

public patch(string $userId, Google_Service_DisplayVideo_User $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_User

(users.patch)

Parameters
$userId : string

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

$postBody : Google_Service_DisplayVideo_User
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

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

Return values
Google_Service_DisplayVideo_User —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results