Documentation

Google_Service_AdExchangeBuyer_Resource_Creatives extends Google_Service_Resource
in package

The "creatives" collection of methods.

Typical usage is: $adexchangebuyerService = new Google_Service_AdExchangeBuyer(...); $creatives = $adexchangebuyerService->creatives;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
addDeal()  : mixed
Add a deal id association for the creative. (creatives.addDeal)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_AdExchangeBuyer_Creative
Gets the status for a single creative. A creative will be available 30-40 minutes after submission. (creatives.get)
insert()  : Google_Service_AdExchangeBuyer_Creative
Submit a new creative. (creatives.insert)
listCreatives()  : Google_Service_AdExchangeBuyer_CreativesList
Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission. (creatives.listCreatives)
listDeals()  : Google_Service_AdExchangeBuyer_CreativeDealIds
Lists the external deal ids associated with the creative.
removeDeal()  : mixed
Remove a deal id associated with the creative. (creatives.removeDeal)
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

addDeal()

Add a deal id association for the creative. (creatives.addDeal)

public addDeal(int $accountId, string $buyerCreativeId, string $dealId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$accountId : int

The id for the account that will serve this creative.

$buyerCreativeId : string

The buyer-specific id for this creative.

$dealId : string

The id of the deal id to associate with this creative.

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

Optional parameters.

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

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

get()

Gets the status for a single creative. A creative will be available 30-40 minutes after submission. (creatives.get)

public get(int $accountId, string $buyerCreativeId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyer_Creative
Parameters
$accountId : int

The id for the account that will serve this creative.

$buyerCreativeId : string

The buyer-specific id for this creative.

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyer_Creative

listCreatives()

Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission. (creatives.listCreatives)

public listCreatives([array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyer_CreativesList
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int accountId When specified, only creatives for the given account ids are returned.

opt_param

string buyerCreativeId When specified, only creatives for the given buyer creative ids are returned.

opt_param

string dealsStatusFilter When specified, only creatives having the given deals status are returned.

opt_param

string maxResults Maximum number of entries returned on one result page. If not set, the default is 100. Optional.

opt_param

string openAuctionStatusFilter When specified, only creatives having the given open auction status are returned.

opt_param

string pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.

Return values
Google_Service_AdExchangeBuyer_CreativesList

listDeals()

Lists the external deal ids associated with the creative.

public listDeals(int $accountId, string $buyerCreativeId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyer_CreativeDealIds

(creatives.listDeals)

Parameters
$accountId : int

The id for the account that will serve this creative.

$buyerCreativeId : string

The buyer-specific id for this creative.

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyer_CreativeDealIds

removeDeal()

Remove a deal id associated with the creative. (creatives.removeDeal)

public removeDeal(int $accountId, string $buyerCreativeId, string $dealId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$accountId : int

The id for the account that will serve this creative.

$buyerCreativeId : string

The buyer-specific id for this creative.

$dealId : string

The id of the deal id to disassociate with this creative.

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

Optional parameters.

Return values
mixed

convertToArrayAndStripNulls()

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

Search results