1. class
  2. Google
  3. \
  4. Service
  5. \
  6. RealTimeBidding
  7. \
  8. Resource
  9. \
  10. BuyersUserLists

BuyersUserLists

class BuyersUserLists extends Resource (View source)

The "userLists" collection of methods.

Typical usage is:

 $realtimebiddingService = new Google\Service\RealTimeBidding(...);
 $userLists = $realtimebiddingService->buyers_userLists;

Methods

UserList
close(string $name, CloseUserListRequest $postBody, array $optParams = [])

Changes the status of a user list to CLOSED. This prevents new users from being added to the user list. (userLists.close)

UserList
create(string $parent, UserList $postBody, array $optParams = [])

Creates a new user list. (userLists.create)

UserList
get(string $name, array $optParams = [])

Gets a user list by its name. (userLists.get)

GetRemarketingTagResponse
getRemarketingTag(string $name, array $optParams = [])

This has been sunset as of October 2023, and will return an error response if called. For more information, see the release notes: https://developers.google.com/authorized-buyers/apis/relnotes#real-time- bidding-api 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.

ListUserListsResponse
listBuyersUserLists(string $parent, array $optParams = [])

Lists the user lists visible to the current user.

UserList
open(string $name, OpenUserListRequest $postBody, array $optParams = [])

Changes the status of a user list to OPEN. This allows new users to be added to the user list. (userLists.open)

UserList
update(string $name, UserList $postBody, array $optParams = [])

Updates the given user list. Only user lists with URLRestrictions can be updated. (userLists.update)

Details

at line 47
UserList close(string $name, CloseUserListRequest $postBody, array $optParams = [])

Changes the status of a user list to CLOSED. This prevents new users from being added to the user list. (userLists.close)

Parameters

string $name

Required. The name of the user list to close. See UserList.name
CloseUserListRequest $postBody
array $optParams

Optional parameters.

Return Value

UserList

Exceptions

Exception

at line 66
UserList create(string $parent, UserList $postBody, array $optParams = [])

Creates a new user list. (userLists.create)

Parameters

string $parent

Required. The name of the parent buyer of the user list to be retrieved, which must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} 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, {buyerAccountId} should represent the account ID of the child seat buyer.
UserList $postBody
array $optParams

Optional parameters.

Return Value

UserList

Exceptions

Exception

at line 81
UserList get(string $name, array $optParams = [])

Gets a user list by its name. (userLists.get)

Parameters

string $name

Required. The name of the user list to be retrieved. See UserList.name.
array $optParams

Optional parameters.

Return Value

UserList

Exceptions

Exception

at line 107
GetRemarketingTagResponse getRemarketingTag(string $name, array $optParams = [])

This has been sunset as of October 2023, and will return an error response if called. For more information, see the release notes: https://developers.google.com/authorized-buyers/apis/relnotes#real-time- bidding-api 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)

Parameters

string $name

Required. To fetch the remarketing tag for an account, the name must follow the pattern buyers/{accountId}, where {accountId} represents the ID of the buyer that owns the remarketing tag. For a bidder accessing the remarketing tag on behalf of a child seat buyer, {accountId} should represent the ID of the child seat buyer. To fetch the remarketing tag for a specific user list, the name must follow the pattern buyers/{accountId}/userLists/{userListId}. See UserList.name.
array $optParams

Optional parameters.

Return Value

GetRemarketingTagResponse

Exceptions

Exception

at line 130
ListUserListsResponse listBuyersUserLists(string $parent, array $optParams = [])

Lists the user lists visible to the current user.

(userLists.listBuyersUserLists)

Parameters

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.
array $optParams

Optional parameters.

Return Value

ListUserListsResponse

Exceptions

Exception

at line 147
UserList open(string $name, OpenUserListRequest $postBody, array $optParams = [])

Changes the status of a user list to OPEN. This allows new users to be added to the user list. (userLists.open)

Parameters

string $name

Required. The name of the user list to open. See UserList.name
OpenUserListRequest $postBody
array $optParams

Optional parameters.

Return Value

UserList

Exceptions

Exception

at line 168
UserList update(string $name, UserList $postBody, array $optParams = [])

Updates the given user list. Only user lists with URLRestrictions can be updated. (userLists.update)

Parameters

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.
UserList $postBody
array $optParams

Optional parameters.

Return Value

UserList

Exceptions

Exception