Documentation

Google_Service_RealTimeBidding_Resource_BuyersCreatives extends Google_Service_Resource
in package

The "creatives" collection of methods.

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

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_RealTimeBidding_Creative
Creates a creative. (creatives.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_RealTimeBidding_Creative
Gets a creative. (creatives.get)
listBuyersCreatives()  : Google_Service_RealTimeBidding_ListCreativesResponse
Lists creatives. (creatives.listBuyersCreatives)
patch()  : Google_Service_RealTimeBidding_Creative
Updates a creative. (creatives.patch)
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 a creative. (creatives.create)

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

Required. The name of the parent buyer that the new creative belongs to that must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns a creative. For a bidder accessing creatives on behalf of a child seat buyer, {buyerAccountId} should represent the account ID of the child seat buyer.

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

Optional parameters.

Return values
Google_Service_RealTimeBidding_Creative

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 a creative. (creatives.get)

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

Required. Name of the creative to retrieve. See creative.name.

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

Optional parameters.

Tags
opt_param

string view Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".

Return values
Google_Service_RealTimeBidding_Creative

listBuyersCreatives()

Lists creatives. (creatives.listBuyersCreatives)

public listBuyersCreatives(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RealTimeBidding_ListCreativesResponse
Parameters
$parent : string

Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either buyers/{buyerAccountId} or bidders/{bidderAccountId}. For buyers/{buyerAccountId}, the buyerAccountId can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (456) under bidder account (123), you would use the pattern: buyers/456. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (123), you would use buyers/123. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use bidders/{bidderAccountId}, e.g., for all creatives pertaining to bidder (123), use bidders/123.

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

Optional parameters.

Tags
opt_param

string view Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".

opt_param

string filter Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'

opt_param

int pageSize Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.

opt_param

string pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method.

Return values
Google_Service_RealTimeBidding_ListCreativesResponse

patch()

Updates a creative. (creatives.patch)

public patch(string $name, Google_Service_RealTimeBidding_Creative $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_RealTimeBidding_Creative
Parameters
$name : string

Name of the creative. Follows the pattern buyers/{buyer}/creatives/{creative}, where {buyer} represents the account ID of the buyer who owns the creative, and {creative} is the buyer-specific creative ID that references this creative in the bid response.

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

Optional parameters.

Tags
opt_param

string updateMask Field mask to use for partial in-place updates.

Return values
Google_Service_RealTimeBidding_Creative

convertToArrayAndStripNulls()

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

Search results