Documentation

Google_Service_AdExchangeBuyerII_Resource_BiddersFilterSets extends Google_Service_Resource
in package

The "filterSets" collection of methods.

Typical usage is: $adexchangebuyer2Service = new Google_Service_AdExchangeBuyerII(...); $filterSets = $adexchangebuyer2Service->filterSets;

Table of Contents

$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.
create()  : Google_Service_AdExchangeBuyerII_FilterSet
Creates the specified filter set for the account with the given account ID.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_AdExchangeBuyerII_Adexchangebuyer2Empty
Deletes the requested filter set from the account with the given account ID.
get()  : Google_Service_AdExchangeBuyerII_FilterSet
Retrieves the requested filter set for the account with the given account ID.
listBiddersFilterSets()  : Google_Service_AdExchangeBuyerII_ListFilterSetsResponse
Lists all filter sets for the account with the given account ID.
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

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

create()

Creates the specified filter set for the account with the given account ID.

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

(filterSets.create)

Parameters
$ownerName : string

Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: bidders/123 - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123 - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456

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

Optional parameters.

Tags
opt_param

bool isTransient Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.

Return values
Google_Service_AdExchangeBuyerII_FilterSet

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

delete()

Deletes the requested filter set from the account with the given account ID.

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

(filterSets.delete)

Parameters
$name : string

Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_Adexchangebuyer2Empty

get()

Retrieves the requested filter set for the account with the given account ID.

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

(filterSets.get)

Parameters
$name : string

Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_FilterSet

listBiddersFilterSets()

Lists all filter sets for the account with the given account ID.

public listBiddersFilterSets(string $ownerName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_ListFilterSetsResponse

(filterSets.listBiddersFilterSets)

Parameters
$ownerName : string

Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: bidders/123 - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123 - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456

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

Optional parameters.

Tags
opt_param

int pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

opt_param

string pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.

Return values
Google_Service_AdExchangeBuyerII_ListFilterSetsResponse

convertToArrayAndStripNulls()

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

Search results