📄 Source: AdvertisersInsertionOrders.php
<?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\DisplayVideo\Resource;
use Google\Service\DisplayVideo\DisplayvideoEmpty;
use Google\Service\DisplayVideo\InsertionOrder;
use Google\Service\DisplayVideo\ListInsertionOrdersResponse;
/**
* The "insertionOrders" collection of methods.
* Typical usage is:
* <code>
* $displayvideoService = new Google\Service\DisplayVideo(...);
* $insertionOrders = $displayvideoService->advertisers_insertionOrders;
* </code>
*/
class AdvertisersInsertionOrders extends \Google\Service\Resource
{
/**
* Creates a new insertion order. Returns the newly created insertion order if
* successful. (insertionOrders.create)
*
* @param string $advertiserId Output only. The unique ID of the advertiser the
* insertion order belongs to.
* @param InsertionOrder $postBody
* @param array $optParams Optional parameters.
* @return InsertionOrder
* @throws \Google\Service\Exception
*/
public function create($advertiserId, InsertionOrder $postBody, $optParams = [])
{
$params = ['advertiserId' => $advertiserId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], InsertionOrder::class);
}
/**
* Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion
* order does not exist. The insertion order should be archived first, i.e. set
* entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it.
* (insertionOrders.delete)
*
* @param string $advertiserId The ID of the advertiser this insertion order
* belongs to.
* @param string $insertionOrderId The ID of the insertion order to delete.
* @param array $optParams Optional parameters.
* @return DisplayvideoEmpty
* @throws \Google\Service\Exception
*/
public function delete($advertiserId, $insertionOrderId, $optParams = [])
{
$params = ['advertiserId' => $advertiserId, 'insertionOrderId' => $insertionOrderId];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], DisplayvideoEmpty::class);
}
/**
* Gets an insertion order. Returns error code `NOT_FOUND` if the insertion
* order does not exist. (insertionOrders.get)
*
* @param string $advertiserId Required. The ID of the advertiser this insertion
* order belongs to.
* @param string $insertionOrderId Required. The ID of the insertion order to
* fetch.
* @param array $optParams Optional parameters.
* @return InsertionOrder
* @throws \Google\Service\Exception
*/
public function get($advertiserId, $insertionOrderId, $optParams = [])
{
$params = ['advertiserId' => $advertiserId, 'insertionOrderId' => $insertionOrderId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], InsertionOrder::class);
}
/**
* Lists insertion orders in an advertiser. The order is defined by the order_by
* parameter. If a filter by entity_status is not specified, insertion orders
* with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
* (insertionOrders.listAdvertisersInsertionOrders)
*
* @param string $advertiserId Required. The ID of the advertiser to list
* insertion orders for.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Allows filtering by insertion order 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 `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. Supported
* fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input
* in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion
* orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or
* `ENTITY_STATUS_PAUSED` insertion orders under an advertiser:
* `(entityStatus="ENTITY_STATUS_ACTIVE" OR
* entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update
* time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601):
* `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders 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: * "displayName" (default) * "entityStatus" * "updateTime" The default
* sorting order is ascending. To specify descending order for a field, a suffix
* "desc" should be added to the field name. Example: `displayName desc`.
* @opt_param int pageSize Requested page size. Must be between `1` and `100`.
* 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 `ListInsertionOrders` method. If not specified, the
* first page of results will be returned.
* @return ListInsertionOrdersResponse
* @throws \Google\Service\Exception
*/
public function listAdvertisersInsertionOrders($advertiserId, $optParams = [])
{
$params = ['advertiserId' => $advertiserId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListInsertionOrdersResponse::class);
}
/**
* Updates an existing insertion order. Returns the updated insertion order if
* successful. (insertionOrders.patch)
*
* @param string $advertiserId Output only. The unique ID of the advertiser the
* insertion order belongs to.
* @param string $insertionOrderId Output only. The unique ID of the insertion
* order. Assigned by the system.
* @param InsertionOrder $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Required. The mask to control which fields to
* update.
* @return InsertionOrder
* @throws \Google\Service\Exception
*/
public function patch($advertiserId, $insertionOrderId, InsertionOrder $postBody, $optParams = [])
{
$params = ['advertiserId' => $advertiserId, 'insertionOrderId' => $insertionOrderId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], InsertionOrder::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AdvertisersInsertionOrders::class, 'Google_Service_DisplayVideo_Resource_AdvertisersInsertionOrders');
← Back