* $displayvideoService = new Google\Service\DisplayVideo(...); * $channels = $displayvideoService->advertisers_channels; * */ class AdvertisersChannels extends \Google\Service\Resource { /** * Creates a new channel. Returns the newly created channel if successful. * (channels.create) * * @param string $advertiserId The ID of the advertiser that owns the created * channel. * @param Channel $postBody * @param array $optParams Optional parameters. * * @opt_param string partnerId The ID of the partner that owns the created * channel. * @return Channel * @throws \Google\Service\Exception */ public function create($advertiserId, Channel $postBody, $optParams = []) { $params = ['advertiserId' => $advertiserId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], Channel::class); } /** * Gets a channel for a partner or advertiser. (channels.get) * * @param string $advertiserId The ID of the advertiser that owns the fetched * channel. * @param string $channelId Required. The ID of the channel to fetch. * @param array $optParams Optional parameters. * * @opt_param string partnerId The ID of the partner that owns the fetched * channel. * @return Channel * @throws \Google\Service\Exception */ public function get($advertiserId, $channelId, $optParams = []) { $params = ['advertiserId' => $advertiserId, 'channelId' => $channelId]; $params = array_merge($params, $optParams); return $this->call('get', [$params], Channel::class); } /** * Lists channels for a partner or advertiser. * (channels.listAdvertisersChannels) * * @param string $advertiserId The ID of the advertiser that owns the channels. * @param array $optParams Optional parameters. * * @opt_param string filter Allows filtering by channel fields. Supported * syntax: * Filter expressions for channel can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` * Examples: * All channels for which the display name contains "google": * `displayName : "google"`. 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) * `channelId` 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 `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 `ListChannels` method. If not specified, the first page * of results will be returned. * @opt_param string partnerId The ID of the partner that owns the channels. * @return ListChannelsResponse * @throws \Google\Service\Exception */ public function listAdvertisersChannels($advertiserId, $optParams = []) { $params = ['advertiserId' => $advertiserId]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListChannelsResponse::class); } /** * Updates a channel. Returns the updated channel if successful. * (channels.patch) * * @param string $advertiserId The ID of the advertiser that owns the created * channel. * @param string $channelId Output only. The unique ID of the channel. Assigned * by the system. * @param Channel $postBody * @param array $optParams Optional parameters. * * @opt_param string partnerId The ID of the partner that owns the created * channel. * @opt_param string updateMask Required. The mask to control which fields to * update. * @return Channel * @throws \Google\Service\Exception */ public function patch($advertiserId, $channelId, Channel $postBody, $optParams = []) { $params = ['advertiserId' => $advertiserId, 'channelId' => $channelId, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], Channel::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(AdvertisersChannels::class, 'Google_Service_DisplayVideo_Resource_AdvertisersChannels');