Viewing file:  Creatives.php (5.39 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\AdExchangeBuyer\Resource;
use Google\Service\AdExchangeBuyer\Creative;
use Google\Service\AdExchangeBuyer\CreativeDealIds;
use Google\Service\AdExchangeBuyer\CreativesList;
/**
* The "creatives" collection of methods.
* Typical usage is:
* <code>
* $adexchangebuyerService = new Google\Service\AdExchangeBuyer(...);
* $creatives = $adexchangebuyerService->creatives;
* </code>
*/
class Creatives extends \Google\Service\Resource
{
/**
* Add a deal id association for the creative. (creatives.addDeal)
*
* @param int $accountId The id for the account that will serve this creative.
* @param string $buyerCreativeId The buyer-specific id for this creative.
* @param string $dealId The id of the deal id to associate with this creative.
* @param array $optParams Optional parameters.
*/
public function addDeal($accountId, $buyerCreativeId, $dealId, $optParams = [])
{
$params = ['accountId' => $accountId, 'buyerCreativeId' => $buyerCreativeId, 'dealId' => $dealId];
$params = array_merge($params, $optParams);
return $this->call('addDeal', [$params]);
}
/**
* Gets the status for a single creative. A creative will be available 30-40
* minutes after submission. (creatives.get)
*
* @param int $accountId The id for the account that will serve this creative.
* @param string $buyerCreativeId The buyer-specific id for this creative.
* @param array $optParams Optional parameters.
* @return Creative
*/
public function get($accountId, $buyerCreativeId, $optParams = [])
{
$params = ['accountId' => $accountId, 'buyerCreativeId' => $buyerCreativeId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Creative::class);
}
/**
* Submit a new creative. (creatives.insert)
*
* @param Creative $postBody
* @param array $optParams Optional parameters.
* @return Creative
*/
public function insert(Creative $postBody, $optParams = [])
{
$params = ['postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insert', [$params], Creative::class);
}
/**
* Retrieves a list of the authenticated user's active creatives. A creative
* will be available 30-40 minutes after submission. (creatives.listCreatives)
*
* @param array $optParams Optional parameters.
*
* @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 CreativesList
*/
public function listCreatives($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], CreativesList::class);
}
/**
* Lists the external deal ids associated with the creative.
* (creatives.listDeals)
*
* @param int $accountId The id for the account that will serve this creative.
* @param string $buyerCreativeId The buyer-specific id for this creative.
* @param array $optParams Optional parameters.
* @return CreativeDealIds
*/
public function listDeals($accountId, $buyerCreativeId, $optParams = [])
{
$params = ['accountId' => $accountId, 'buyerCreativeId' => $buyerCreativeId];
$params = array_merge($params, $optParams);
return $this->call('listDeals', [$params], CreativeDealIds::class);
}
/**
* Remove a deal id associated with the creative. (creatives.removeDeal)
*
* @param int $accountId The id for the account that will serve this creative.
* @param string $buyerCreativeId The buyer-specific id for this creative.
* @param string $dealId The id of the deal id to disassociate with this
* creative.
* @param array $optParams Optional parameters.
*/
public function removeDeal($accountId, $buyerCreativeId, $dealId, $optParams = [])
{
$params = ['accountId' => $accountId, 'buyerCreativeId' => $buyerCreativeId, 'dealId' => $dealId];
$params = array_merge($params, $optParams);
return $this->call('removeDeal', [$params]);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Creatives::class, 'Google_Service_AdExchangeBuyer_Resource_Creatives');
|