source: vendor/google/apiclient-services/src/DisplayVideo/Resource/CustomLists.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 10 days ago

Upload project files

  • Property mode set to 100644
File size: 3.7 KB
Line 
1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\DisplayVideo\Resource;
19
20use Google\Service\DisplayVideo\CustomList;
21use Google\Service\DisplayVideo\ListCustomListsResponse;
22
23/**
24 * The "customLists" collection of methods.
25 * Typical usage is:
26 * <code>
27 * $displayvideoService = new Google\Service\DisplayVideo(...);
28 * $customLists = $displayvideoService->customLists;
29 * </code>
30 */
31class CustomLists extends \Google\Service\Resource
32{
33 /**
34 * Gets a custom list. (customLists.get)
35 *
36 * @param string $customListId Required. The ID of the custom list to fetch.
37 * @param array $optParams Optional parameters.
38 *
39 * @opt_param string advertiserId The ID of the DV360 advertiser that has access
40 * to the fetched custom lists.
41 * @return CustomList
42 * @throws \Google\Service\Exception
43 */
44 public function get($customListId, $optParams = [])
45 {
46 $params = ['customListId' => $customListId];
47 $params = array_merge($params, $optParams);
48 return $this->call('get', [$params], CustomList::class);
49 }
50 /**
51 * Lists custom lists. The order is defined by the order_by parameter.
52 * (customLists.listCustomLists)
53 *
54 * @param array $optParams Optional parameters.
55 *
56 * @opt_param string advertiserId The ID of the DV360 advertiser that has access
57 * to the fetched custom lists.
58 * @opt_param string filter Allows filtering by custom list fields. Supported
59 * syntax: * Filter expressions for custom lists can only contain at most one
60 * restriction. * A restriction has the form of `{field} {operator} {value}`. *
61 * All fields must use the `HAS (:)` operator. Supported fields: * `displayName`
62 * Examples: * All custom lists for which the display name contains "Google":
63 * `displayName:"Google"`. The length of this field should be no more than 500
64 * characters. Reference our [filter `LIST` requests](/display-
65 * video/api/guides/how-tos/filters) guide for more information.
66 * @opt_param string orderBy Field by which to sort the list. Acceptable values
67 * are: * `customListId` (default) * `displayName` The default sorting order is
68 * ascending. To specify descending order for a field, a suffix "desc" should be
69 * added to the field name. Example: `displayName desc`.
70 * @opt_param int pageSize Requested page size. Must be between `1` and `200`.
71 * If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT`
72 * if an invalid value is specified.
73 * @opt_param string pageToken A token identifying a page of results the server
74 * should return. Typically, this is the value of next_page_token returned from
75 * the previous call to `ListCustomLists` method. If not specified, the first
76 * page of results will be returned.
77 * @return ListCustomListsResponse
78 * @throws \Google\Service\Exception
79 */
80 public function listCustomLists($optParams = [])
81 {
82 $params = [];
83 $params = array_merge($params, $optParams);
84 return $this->call('list', [$params], ListCustomListsResponse::class);
85 }
86}
87
88// Adding a class alias for backwards compatibility with the previous class name.
89class_alias(CustomLists::class, 'Google_Service_DisplayVideo_Resource_CustomLists');
Note: See TracBrowser for help on using the repository browser.