* $realtimebiddingService = new Google\Service\RealTimeBidding(...); * $userLists = $realtimebiddingService->userLists; * */ class BuyersUserLists extends \Google\Service\Resource { /** * Change the status of a user list to CLOSED. This prevents new users from * being added to the user list. (userLists.close) * * @param string $name Required. The name of the user list to close. See * UserList.name * @param CloseUserListRequest $postBody * @param array $optParams Optional parameters. * @return UserList */ public function close($name, CloseUserListRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('close', [$params], UserList::class); } /** * Create a new user list. (userLists.create) * * @param string $parent Required. The name of the parent buyer of the user list * to be retrieved that must follow the pattern `buyers/{buyerAccountId}`, where * `{buyerAccountId}` represents the account ID of the buyer who owns user * lists. For a bidder accessing user lists on behalf of a child seat buyer , * `{buyerAccountId}` should represent the account ID of the child seat buyer. * @param UserList $postBody * @param array $optParams Optional parameters. * @return UserList */ public function create($parent, UserList $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], UserList::class); } /** * Gets a user list by its name. (userLists.get) * * @param string $name Required. The name of the user list to be retrieved. See * UserList.name. * @param array $optParams Optional parameters. * @return UserList */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], UserList::class); } /** * Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript * code that can be placed on a web page. When a user visits a page containing a * remarketing tag, Google adds the user to a user list. * (userLists.getRemarketingTag) * * @param string $name Required. To fetch remarketing tag for an account, name * must follow the pattern `buyers/{accountId}` where `{accountId}` represents * ID of a buyer that owns the remarketing tag. For a bidder accessing * remarketing tag on behalf of a child seat buyer, `{accountId}` should * represent the ID of the child seat buyer. To fetch remarketing tag for a * specific user list, name must follow the pattern * `buyers/{accountId}/userLists/{userListId}`. See UserList.name. * @param array $optParams Optional parameters. * @return GetRemarketingTagResponse */ public function getRemarketingTag($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('getRemarketingTag', [$params], GetRemarketingTagResponse::class); } /** * Lists the user lists visible to the current user. * (userLists.listBuyersUserLists) * * @param string $parent Required. The name of the parent buyer for the user * lists to be returned that must follow the pattern `buyers/{buyerAccountId}`, * where `{buyerAccountId}` represents the account ID of the buyer who owns user * lists. For a bidder accessing user lists on behalf of a child seat buyer , * `{buyerAccountId}` should represent the account ID of the child seat buyer. * @param array $optParams Optional parameters. * * @opt_param int pageSize The number of results to return per page. * @opt_param string pageToken Continuation page token (as received from a * previous response). * @return ListUserListsResponse */ public function listBuyersUserLists($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListUserListsResponse::class); } /** * Change the status of a user list to OPEN. This allows new users to be added * to the user list. (userLists.open) * * @param string $name Required. The name of the user list to open. See * UserList.name * @param OpenUserListRequest $postBody * @param array $optParams Optional parameters. * @return UserList */ public function open($name, OpenUserListRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('open', [$params], UserList::class); } /** * Update the given user list. Only user lists with URLRestrictions can be * updated. (userLists.update) * * @param string $name Output only. Name of the user list that must follow the * pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents * the account ID of the buyer who owns the user list. For a bidder accessing * user lists on behalf of a child seat buyer, `{buyer}` represents the account * ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by * Google to uniquely identify a user list. * @param UserList $postBody * @param array $optParams Optional parameters. * @return UserList */ public function update($name, UserList $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('update', [$params], UserList::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(BuyersUserLists::class, 'Google_Service_RealTimeBidding_Resource_BuyersUserLists');