File "CustomLists.php"
Full Path: /home/u735268861/domains/palsarh.in/public_html/vendor/google/apiclient-services/src/DisplayVideo/Resource/CustomLists.php
File size: 3.68 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\CustomList;
use Google\Service\DisplayVideo\ListCustomListsResponse;
/**
* The "customLists" collection of methods.
* Typical usage is:
* <code>
* $displayvideoService = new Google\Service\DisplayVideo(...);
* $customLists = $displayvideoService->customLists;
* </code>
*/
class CustomLists extends \Google\Service\Resource
{
/**
* Gets a custom list. (customLists.get)
*
* @param string $customListId Required. The ID of the custom list to fetch.
* @param array $optParams Optional parameters.
*
* @opt_param string advertiserId The ID of the DV360 advertiser that has access
* to the fetched custom lists.
* @return CustomList
* @throws \Google\Service\Exception
*/
public function get($customListId, $optParams = [])
{
$params = ['customListId' => $customListId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], CustomList::class);
}
/**
* Lists custom lists. The order is defined by the order_by parameter.
* (customLists.listCustomLists)
*
* @param array $optParams Optional parameters.
*
* @opt_param string advertiserId The ID of the DV360 advertiser that has access
* to the fetched custom lists.
* @opt_param string filter Allows filtering by custom list fields. Supported
* syntax: * Filter expressions for custom lists 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 custom lists 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: * `customListId` (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 `ListCustomLists` method. If not specified, the first
* page of results will be returned.
* @return ListCustomListsResponse
* @throws \Google\Service\Exception
*/
public function listCustomLists($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListCustomListsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CustomLists::class, 'Google_Service_DisplayVideo_Resource_CustomLists');