Viewing file:  AdvertisersYoutubeAdGroupAds.php (4.08 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\DisplayVideo\Resource;
use Google\Service\DisplayVideo\ListYoutubeAdGroupAdsResponse;
use Google\Service\DisplayVideo\YoutubeAdGroupAd;
/**
* The "youtubeAdGroupAds" collection of methods.
* Typical usage is:
* <code>
* $displayvideoService = new Google\Service\DisplayVideo(...);
* $youtubeAdGroupAds = $displayvideoService->advertisers_youtubeAdGroupAds;
* </code>
*/
class AdvertisersYoutubeAdGroupAds extends \Google\Service\Resource
{
/**
* Gets a YouTube ad group ad. (youtubeAdGroupAds.get)
*
* @param string $advertiserId Required. The ID of the advertiser this ad group
* ad belongs to.
* @param string $youtubeAdGroupAdId Required. The ID of the ad group ad to
* fetch.
* @param array $optParams Optional parameters.
* @return YoutubeAdGroupAd
*/
public function get($advertiserId, $youtubeAdGroupAdId, $optParams = [])
{
$params = ['advertiserId' => $advertiserId, 'youtubeAdGroupAdId' => $youtubeAdGroupAdId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], YoutubeAdGroupAd::class);
}
/**
* Lists YouTube ad group ads.
* (youtubeAdGroupAds.listAdvertisersYoutubeAdGroupAds)
*
* @param string $advertiserId Required. The ID of the advertiser the ad groups
* belongs to.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Allows filtering by custom YouTube ad group ad
* fields. Supported syntax: * Filter expressions are made up of one or more
* restrictions. * Restrictions can be combined by `AND` and `OR`. Only the
* restrictions for * the same field can be combined by `OR`. A sequence of
* restrictions * implicitly uses `AND`. * A restriction has the form of
* `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. *
* Supported properties: - `adGroupId` - `displayName` - `entityStatus` -
* `adGroupAdId` Examples: * All ad group ads under an ad group:
* `adGroupId="1234"` and its * entityStatus is `ENTITY_STATUS_ACTIVE` or
* `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR
* entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of
* this field should be no more than 500 characters.
* @opt_param string orderBy Field by which to sort the list. Acceptable values
* are: * `displayName` (default) * `entityStatus` 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 `ListYoutubeAdGroupAds` method. If not specified, the
* first page of results will be returned.
* @return ListYoutubeAdGroupAdsResponse
*/
public function listAdvertisersYoutubeAdGroupAds($advertiserId, $optParams = [])
{
$params = ['advertiserId' => $advertiserId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListYoutubeAdGroupAdsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AdvertisersYoutubeAdGroupAds::class, 'Google_Service_DisplayVideo_Resource_AdvertisersYoutubeAdGroupAds');
|