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