* $displayvideoService = new Google\Service\DisplayVideo(...); * $creatives = $displayvideoService->advertisers_creatives; * */ class AdvertisersCreatives extends \Google\Service\Resource { /** * Creates a new creative. Returns the newly created creative if successful. A * ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or * greater for the parent advertiser or partner is required to make this * request. (creatives.create) * * @param string $advertiserId Output only. The unique ID of the advertiser the * creative belongs to. * @param Creative $postBody * @param array $optParams Optional parameters. * @return Creative * @throws \Google\Service\Exception */ public function create($advertiserId, Creative $postBody, $optParams = []) { $params = ['advertiserId' => $advertiserId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], Creative::class); } /** * Deletes a creative. Returns error code `NOT_FOUND` if the creative does not * exist. The creative should be archived first, i.e. set entity_status to * `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user * role](//support.google.com/displayvideo/answer/2723011) or greater for the * parent advertiser or partner is required to make this request. * (creatives.delete) * * @param string $advertiserId The ID of the advertiser this creative belongs * to. * @param string $creativeId The ID of the creative to be deleted. * @param array $optParams Optional parameters. * @return DisplayvideoEmpty * @throws \Google\Service\Exception */ public function delete($advertiserId, $creativeId, $optParams = []) { $params = ['advertiserId' => $advertiserId, 'creativeId' => $creativeId]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], DisplayvideoEmpty::class); } /** * Gets a creative. (creatives.get) * * @param string $advertiserId Required. The ID of the advertiser this creative * belongs to. * @param string $creativeId Required. The ID of the creative to fetch. * @param array $optParams Optional parameters. * @return Creative * @throws \Google\Service\Exception */ public function get($advertiserId, $creativeId, $optParams = []) { $params = ['advertiserId' => $advertiserId, 'creativeId' => $creativeId]; $params = array_merge($params, $optParams); return $this->call('get', [$params], Creative::class); } /** * Lists creatives in an advertiser. The order is defined by the order_by * parameter. If a filter by entity_status is not specified, creatives with * `ENTITY_STATUS_ARCHIVED` will not be included in the results. * (creatives.listAdvertisersCreatives) * * @param string $advertiserId Required. The ID of the advertiser to list * creatives for. * @param array $optParams Optional parameters. * * @opt_param string filter Allows filtering by creative fields. Supported * syntax: * Filter expressions are made up of one or more restrictions. * * Restrictions can be combined by `AND` or `OR` logical operators. A sequence * of restrictions implicitly uses `AND`. * A restriction has the form of * `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS * (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL * TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must * use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, * `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one * restriction. Supported Fields: * `approvalStatus` * `creativeId` * * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of * `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the * form of `{duration}s`. Only seconds are supported) * `minDuration` (input in * the form of `{duration}s`. Only seconds are supported) * `updateTime` (input * in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a * creative resource's field value reflects the last time that a creative has * been updated, which includes updates made by the system (e.g. creative review * updates). Examples: * All native creatives: * `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or * 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND * (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that * are approved by AdX or AppNexus, with a minimum duration of 5 seconds and * 200ms: `dynamic="true" AND minDuration="5.2s" AND * (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR * exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video * creatives that are associated with line item ID 1 or 2: * `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All * creatives with an update time greater than or equal to 2020-11-04T18:54:47Z * (format of ISO 8601): `updateTime>="2020-11-04T18:54:47Z"` The length of this * field should be no more than 500 characters. Reference our [filter `LIST` * requests](/display-video/api/guides/how-tos/filters) guide for more * information. * @opt_param string orderBy Field by which to sort the list. Acceptable values * are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` * (sorts by width first, then by height) The default sorting order is * ascending. To specify descending order for a field, a suffix "desc" should be * added to the field name. Example: `createTime desc`. * @opt_param int pageSize Requested page size. Must be between `1` and `200`. * If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` * if an invalid value is specified. * @opt_param string pageToken A token identifying a page of results the server * should return. Typically, this is the value of next_page_token returned from * the previous call to `ListCreatives` method. If not specified, the first page * of results will be returned. * @return ListCreativesResponse * @throws \Google\Service\Exception */ public function listAdvertisersCreatives($advertiserId, $optParams = []) { $params = ['advertiserId' => $advertiserId]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListCreativesResponse::class); } /** * Updates an existing creative. Returns the updated creative if successful. A * ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or * greater for the parent advertiser or partner is required to make this * request. (creatives.patch) * * @param string $advertiserId Output only. The unique ID of the advertiser the * creative belongs to. * @param string $creativeId Output only. The unique ID of the creative. * Assigned by the system. * @param Creative $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask Required. The mask to control which fields to * update. * @return Creative * @throws \Google\Service\Exception */ public function patch($advertiserId, $creativeId, Creative $postBody, $optParams = []) { $params = ['advertiserId' => $advertiserId, 'creativeId' => $creativeId, '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(AdvertisersCreatives::class, 'Google_Service_DisplayVideo_Resource_AdvertisersCreatives');