Documentation

Google_Service_RealTimeBidding_Resource_BuyersUserLists extends Google_Service_Resource
in package

Application

The "userLists" collection of methods.

Typical usage is: $realtimebiddingService = new Google_Service_RealTimeBidding(...); $userLists = $realtimebiddingService->userLists;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
close() : Google_Service_RealTimeBidding_UserList: Change the status of a user list to CLOSED. This prevents new users from being added to the user list. (userLists.close)
create() : Google_Service_RealTimeBidding_UserList: Create a new user list. (userLists.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_RealTimeBidding_UserList: Gets a user list by its name. (userLists.get)
getRemarketingTag() : Google_Service_RealTimeBidding_GetRemarketingTagResponse: 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.
listBuyersUserLists() : Google_Service_RealTimeBidding_ListUserListsResponse: Lists the user lists visible to the current user.
open() : Google_Service_RealTimeBidding_UserList: Change the status of a user list to OPEN. This allows new users to be added to the user list. (userLists.open)
update() : Google_Service_RealTimeBidding_UserList: Update the given user list. Only user lists with URLRestrictions can be updated. (userLists.update)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

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

Return values

Google_Http_Request|expectedClass —

close()

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


    public
                close(string $name, Google_Service_RealTimeBidding_CloseUserListRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RealTimeBidding_UserList

Parameters

$name : string: Required. The name of the user list to close. See UserList.name
$postBody : Google_Service_RealTimeBidding_CloseUserListRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_RealTimeBidding_UserList —

create()

Create a new user list. (userLists.create)


    public
                create(string $parent, Google_Service_RealTimeBidding_UserList $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RealTimeBidding_UserList

Parameters

$parent : string: 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.
$postBody : Google_Service_RealTimeBidding_UserList
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_RealTimeBidding_UserList —

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>

Return values

string —

$requestUrl

get()

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


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RealTimeBidding_UserList

Parameters

$name : string: Required. The name of the user list to be retrieved. See UserList.name.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_RealTimeBidding_UserList —

getRemarketingTag()

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.


    public
                getRemarketingTag(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RealTimeBidding_GetRemarketingTagResponse

(userLists.getRemarketingTag)

Parameters

$name : string: 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.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_RealTimeBidding_GetRemarketingTagResponse —

listBuyersUserLists()

Lists the user lists visible to the current user.


    public
                listBuyersUserLists(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RealTimeBidding_ListUserListsResponse

(userLists.listBuyersUserLists)

Parameters

$parent : string: 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.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_RealTimeBidding_ListUserListsResponse —

open()

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


    public
                open(string $name, Google_Service_RealTimeBidding_OpenUserListRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RealTimeBidding_UserList

Parameters

$name : string: Required. The name of the user list to open. See UserList.name
$postBody : Google_Service_RealTimeBidding_OpenUserListRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_RealTimeBidding_UserList —

update()

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


    public
                update(string $name, Google_Service_RealTimeBidding_UserList $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RealTimeBidding_UserList

Parameters

$name : string: 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.
$postBody : Google_Service_RealTimeBidding_UserList
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_RealTimeBidding_UserList —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —