* $realtimebiddingService = new Google\Service\RealTimeBidding(...); * $creatives = $realtimebiddingService->buyers_creatives; * */ class BuyersCreatives extends \Google\Service\Resource { /** * Creates a creative. (creatives.create) * * @param string $parent 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. * @param Creative $postBody * @param array $optParams Optional parameters. * @return Creative * @throws \Google\Service\Exception */ public function create($parent, Creative $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], Creative::class); } /** * Gets a creative. (creatives.get) * * @param string $name Required. Name of the creative to retrieve. See * creative.name. * @param array $optParams Optional parameters. * * @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 Creative * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], Creative::class); } /** * Lists creatives as they are at the time of the initial request. This call may * take multiple hours to complete. For large, paginated requests, this method * returns a snapshot of creatives at the time of request for the first page. * `lastStatusUpdate` and `creativeServingDecision` may be outdated for * creatives on sequential pages. We recommend [Google Cloud * Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status. * (creatives.listBuyersCreatives) * * @param string $parent 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}`, for example, for all * creatives pertaining to bidder (`123`), use `bidders/123`. * @param array $optParams Optional parameters. * * @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 through 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. Page tokens for continued pages are valid for up to * five hours, counting from the call to 'ListCreatives' for the first page. * @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 ListCreativesResponse * @throws \Google\Service\Exception */ public function listBuyersCreatives($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListCreativesResponse::class); } /** * Updates a creative. (creatives.patch) * * @param string $name Output only. 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. * @param Creative $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask Field mask to use for partial in-place updates. * @return Creative * @throws \Google\Service\Exception */ public function patch($name, Creative $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], Creative::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(BuyersCreatives::class, 'Google_Service_RealTimeBidding_Resource_BuyersCreatives');