Documentation

Google_Service_AdExchangeBuyerII_Resource_AccountsCreatives extends Google_Service_Resource
in package

The "creatives" collection of methods.

Typical usage is: $adexchangebuyer2Service = new Google_Service_AdExchangeBuyerII(...); $creatives = $adexchangebuyer2Service->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_AdExchangeBuyerII_Creative
Creates a creative. (creatives.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_AdExchangeBuyerII_Creative
Gets a creative. (creatives.get)
listAccountsCreatives()  : Google_Service_AdExchangeBuyerII_ListCreativesResponse
Lists creatives. (creatives.listAccountsCreatives)
stopWatching()  : Google_Service_AdExchangeBuyerII_Adexchangebuyer2Empty
Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status. (creatives.stopWatching)
update()  : Google_Service_AdExchangeBuyerII_Creative
Updates a creative. (creatives.update)
watch()  : Google_Service_AdExchangeBuyerII_Adexchangebuyer2Empty
Watches a creative. Will result in push notifications being sent to the topic when the creative changes status. (creatives.watch)
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 $accountId, Google_Service_AdExchangeBuyerII_Creative $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Creative
Parameters
$accountId : string

The account that this creative belongs to. Can be used to filter the response of the creatives.list method.

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

Optional parameters.

Tags
opt_param

string duplicateIdMode Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative).

Return values
Google_Service_AdExchangeBuyerII_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

listAccountsCreatives()

Lists creatives. (creatives.listAccountsCreatives)

public listAccountsCreatives(string $accountId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_ListCreativesResponse
Parameters
$accountId : string

The account to list the creatives from. Specify "-" to list all creatives the current user has access to.

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

Optional parameters.

Tags
opt_param

string query An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=account_id_string - creativeId=creative_id_string - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from DisapprovalReason} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'

opt_param

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

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.

Return values
Google_Service_AdExchangeBuyerII_ListCreativesResponse

stopWatching()

Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status. (creatives.stopWatching)

public stopWatching(string $accountId, string $creativeId, Google_Service_AdExchangeBuyerII_StopWatchingCreativeRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Adexchangebuyer2Empty
Parameters
$accountId : string

The account of the creative to stop notifications for.

$creativeId : string

The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications.

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_Adexchangebuyer2Empty

update()

Updates a creative. (creatives.update)

public update(string $accountId, string $creativeId, Google_Service_AdExchangeBuyerII_Creative $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Creative
Parameters
$accountId : string

The account that this creative belongs to. Can be used to filter the response of the creatives.list method.

$creativeId : string

The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_Creative

watch()

Watches a creative. Will result in push notifications being sent to the topic when the creative changes status. (creatives.watch)

public watch(string $accountId, string $creativeId, Google_Service_AdExchangeBuyerII_WatchCreativeRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AdExchangeBuyerII_Adexchangebuyer2Empty
Parameters
$accountId : string

The account of the creative to watch.

$creativeId : string

The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative- level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic.

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

Optional parameters.

Return values
Google_Service_AdExchangeBuyerII_Adexchangebuyer2Empty

convertToArrayAndStripNulls()

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

Search results