source: vendor/google/apiclient-services/src/DisplayVideo/Resource/GoogleAudiences.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: 4.0 KB
RevLine 
[e3d4e0a]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\GoogleAudience;
21use Google\Service\DisplayVideo\ListGoogleAudiencesResponse;
22
23/**
24 * The "googleAudiences" collection of methods.
25 * Typical usage is:
26 * <code>
27 * $displayvideoService = new Google\Service\DisplayVideo(...);
28 * $googleAudiences = $displayvideoService->googleAudiences;
29 * </code>
30 */
31class GoogleAudiences extends \Google\Service\Resource
32{
33 /**
34 * Gets a Google audience. (googleAudiences.get)
35 *
36 * @param string $googleAudienceId Required. The ID of the Google audience to
37 * fetch.
38 * @param array $optParams Optional parameters.
39 *
40 * @opt_param string advertiserId The ID of the advertiser that has access to
41 * the fetched Google audience.
42 * @opt_param string partnerId The ID of the partner that has access to the
43 * fetched Google audience.
44 * @return GoogleAudience
45 * @throws \Google\Service\Exception
46 */
47 public function get($googleAudienceId, $optParams = [])
48 {
49 $params = ['googleAudienceId' => $googleAudienceId];
50 $params = array_merge($params, $optParams);
51 return $this->call('get', [$params], GoogleAudience::class);
52 }
53 /**
54 * Lists Google audiences. The order is defined by the order_by parameter.
55 * (googleAudiences.listGoogleAudiences)
56 *
57 * @param array $optParams Optional parameters.
58 *
59 * @opt_param string advertiserId The ID of the advertiser that has access to
60 * the fetched Google audiences.
61 * @opt_param string filter Allows filtering by Google audience fields.
62 * Supported syntax: * Filter expressions for Google audiences can only contain
63 * at most one restriction. * A restriction has the form of `{field} {operator}
64 * {value}`. * All fields must use the `HAS (:)` operator. Supported fields: *
65 * `displayName` Examples: * All Google audiences for which the display name
66 * contains "Google": `displayName:"Google"`. The length of this field should be
67 * no more than 500 characters. Reference our [filter `LIST` requests](/display-
68 * video/api/guides/how-tos/filters) guide for more information.
69 * @opt_param string orderBy Field by which to sort the list. Acceptable values
70 * are: * `googleAudienceId` (default) * `displayName` The default sorting order
71 * is ascending. To specify descending order for a field, a suffix "desc" should
72 * be added to the field name. Example: `displayName desc`.
73 * @opt_param int pageSize Requested page size. Must be between `1` and `200`.
74 * If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT`
75 * if an invalid value is specified.
76 * @opt_param string pageToken A token identifying a page of results the server
77 * should return. Typically, this is the value of next_page_token returned from
78 * the previous call to `ListGoogleAudiences` method. If not specified, the
79 * first page of results will be returned.
80 * @opt_param string partnerId The ID of the partner that has access to the
81 * fetched Google audiences.
82 * @return ListGoogleAudiencesResponse
83 * @throws \Google\Service\Exception
84 */
85 public function listGoogleAudiences($optParams = [])
86 {
87 $params = [];
88 $params = array_merge($params, $optParams);
89 return $this->call('list', [$params], ListGoogleAudiencesResponse::class);
90 }
91}
92
93// Adding a class alias for backwards compatibility with the previous class name.
94class_alias(GoogleAudiences::class, 'Google_Service_DisplayVideo_Resource_GoogleAudiences');
Note: See TracBrowser for help on using the repository browser.