* $displayvideoService = new Google\Service\DisplayVideo(...); * $users = $displayvideoService->users; * */ class Users extends \Google\Service\Resource { /** * 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. (users.bulkEditAssignedUserRoles) * * @param string $userId Required. The ID of the user to which the assigned user * roles belong. * @param BulkEditAssignedUserRolesRequest $postBody * @param array $optParams Optional parameters. * @return BulkEditAssignedUserRolesResponse * @throws \Google\Service\Exception */ public function bulkEditAssignedUserRoles($userId, BulkEditAssignedUserRolesRequest $postBody, $optParams = []) { $params = ['userId' => $userId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('bulkEditAssignedUserRoles', [$params], BulkEditAssignedUserRolesResponse::class); } /** * 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. (users.create) * * @param User $postBody * @param array $optParams Optional parameters. * @return User * @throws \Google\Service\Exception */ public function create(User $postBody, $optParams = []) { $params = ['postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], User::class); } /** * 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. (users.delete) * * @param string $userId Required. The ID of the user to delete. * @param array $optParams Optional parameters. * @return DisplayvideoEmpty * @throws \Google\Service\Exception */ public function delete($userId, $optParams = []) { $params = ['userId' => $userId]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], DisplayvideoEmpty::class); } /** * 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. (users.get) * * @param string $userId Required. The ID of the user to fetch. * @param array $optParams Optional parameters. * @return User * @throws \Google\Service\Exception */ public function get($userId, $optParams = []) { $params = ['userId' => $userId]; $params = array_merge($params, $optParams); return $this->call('get', [$params], User::class); } /** * 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. (users.listUsers) * * @param array $optParams Optional parameters. * * @opt_param string filter Allows filtering by user fields. 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 `displayName` and `email` fields must * use the `HAS (:)` operator. * The `lastLoginTime` field must use either the * `LESS THAN OR EQUAL TO (<=)` or `GREATER THAN OR EQUAL TO (>=)` operator. * * All other fields must use the `EQUALS (=)` operator. Supported fields: * * `assignedUserRole.advertiserId` * `assignedUserRole.entityType`: This is * 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`: This is a synthetic field * of `AssignedUserRole` used for filtering. Identifies the parent partner of * the entity to which the user role is assigned. * `assignedUserRole.partnerId` * * `assignedUserRole.userRole` * `displayName` * `email` * `lastLoginTime` * (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) 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"` * * All users that last logged in on or after 2023-01-01T00:00:00Z (format of ISO * 8601): `lastLoginTime>="2023-01-01T00:00:00Z"` The length of this field * should be no more than 500 characters. Reference our [filter `LIST` * requests](/display-video/api/guides/how-tos/filters) guide for more * information. * @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`. * @opt_param int pageSize Requested page size. Must be between `1` and `200`. * 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. * @return ListUsersResponse * @throws \Google\Service\Exception */ public function listUsers($optParams = []) { $params = []; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListUsersResponse::class); } /** * 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. (users.patch) * * @param string $userId Output only. The unique ID of the user. Assigned by the * system. * @param User $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask Required. The mask to control which fields to * update. * @return User * @throws \Google\Service\Exception */ public function patch($userId, User $postBody, $optParams = []) { $params = ['userId' => $userId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], User::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(Users::class, 'Google_Service_DisplayVideo_Resource_Users');