Viewing file:  CombinedAudiences.php (3.71 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.
*/
/**
* The "combinedAudiences" collection of methods.
* Typical usage is:
* <code>
* $displayvideoService = new Google_Service_DisplayVideo(...);
* $combinedAudiences = $displayvideoService->combinedAudiences;
* </code>
*/
class Google_Service_DisplayVideo_Resource_CombinedAudiences extends Google_Service_Resource
{
/**
* Gets a combined audience. (combinedAudiences.get)
*
* @param string $combinedAudienceId Required. The ID of the combined audience
* to fetch.
* @param array $optParams Optional parameters.
*
* @opt_param string advertiserId The ID of the advertiser that has access to
* the fetched combined audience.
* @opt_param string partnerId The ID of the partner that has access to the
* fetched combined audience.
* @return Google_Service_DisplayVideo_CombinedAudience
*/
public function get($combinedAudienceId, $optParams = array())
{
$params = array('combinedAudienceId' => $combinedAudienceId);
$params = array_merge($params, $optParams);
return $this->call('get', array($params), "Google_Service_DisplayVideo_CombinedAudience");
}
/**
* Lists combined audiences. The order is defined by the order_by parameter.
* (combinedAudiences.listCombinedAudiences)
*
* @param array $optParams Optional parameters.
*
* @opt_param string advertiserId The ID of the advertiser that has access to
* the fetched combined audiences.
* @opt_param string filter Allows filtering by combined audience fields.
* Supported syntax: * Filter expressions for combined audiences currently can
* only contain at most one restriction. * A restriction has the form of
* `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. *
* Supported fields: - `displayName` Examples: * All combined audiences for
* which the display name contains "Google": `displayName : "Google"`. 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: * `combinedAudienceId` (default) * `displayName` 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 `ListCombinedAudiences` method. If not specified, the
* first page of results will be returned.
* @opt_param string partnerId The ID of the partner that has access to the
* fetched combined audiences.
* @return Google_Service_DisplayVideo_ListCombinedAudiencesResponse
*/
public function listCombinedAudiences($optParams = array())
{
$params = array();
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_DisplayVideo_ListCombinedAudiencesResponse");
}
}
|