File "GoogleAudiences.php"
Full Path: /home/u735268861/domains/palsarh.in/public_html/vendor/google/apiclient-services/src/DisplayVideo/Resource/GoogleAudiences.php
File size: 4 KB
MIME-type: text/x-php
Charset: utf-8
<?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\GoogleAudience;
use Google\Service\DisplayVideo\ListGoogleAudiencesResponse;
/**
* The "googleAudiences" collection of methods.
* Typical usage is:
* <code>
* $displayvideoService = new Google\Service\DisplayVideo(...);
* $googleAudiences = $displayvideoService->googleAudiences;
* </code>
*/
class GoogleAudiences extends \Google\Service\Resource
{
/**
* Gets a Google audience. (googleAudiences.get)
*
* @param string $googleAudienceId Required. The ID of the Google audience to
* fetch.
* @param array $optParams Optional parameters.
*
* @opt_param string advertiserId The ID of the advertiser that has access to
* the fetched Google audience.
* @opt_param string partnerId The ID of the partner that has access to the
* fetched Google audience.
* @return GoogleAudience
* @throws \Google\Service\Exception
*/
public function get($googleAudienceId, $optParams = [])
{
$params = ['googleAudienceId' => $googleAudienceId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], GoogleAudience::class);
}
/**
* Lists Google audiences. The order is defined by the order_by parameter.
* (googleAudiences.listGoogleAudiences)
*
* @param array $optParams Optional parameters.
*
* @opt_param string advertiserId The ID of the advertiser that has access to
* the fetched Google audiences.
* @opt_param string filter Allows filtering by Google audience fields.
* Supported syntax: * Filter expressions for Google audiences 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 Google audiences 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: * `googleAudienceId` (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 `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 `ListGoogleAudiences` 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 Google audiences.
* @return ListGoogleAudiencesResponse
* @throws \Google\Service\Exception
*/
public function listGoogleAudiences($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListGoogleAudiencesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleAudiences::class, 'Google_Service_DisplayVideo_Resource_GoogleAudiences');