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\AdExchangeBuyerII\Resource;
19
20use Google\Service\AdExchangeBuyerII\ListCreativeStatusBreakdownByDetailResponse;
21
22/**
23 * The "details" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $adexchangebuyer2Service = new Google\Service\AdExchangeBuyerII(...);
27 *   $details = $adexchangebuyer2Service->details;
28 *  </code>
29 */
30class BiddersAccountsFilterSetsFilteredBidsDetails extends \Google\Service\Resource
31{
32  /**
33   * List all details associated with a specific reason for which bids were
34   * filtered, with the number of bids filtered for each detail.
35   * (details.listBiddersAccountsFilterSetsFilteredBidsDetails)
36   *
37   * @param string $filterSetName Name of the filter set that should be applied to
38   * the requested metrics. For example: - For a bidder-level filter set for
39   * bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set
40   * for the buyer account representing bidder 123:
41   * `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set
42   * for the child seat buyer account 456 whose bidder is 123:
43   * `bidders/123/accounts/456/filterSets/abc`
44   * @param int $creativeStatusId The ID of the creative status for which to
45   * retrieve a breakdown by detail. See [creative-status-
46   * codes](https://developers.google.com/authorized-buyers/rtb/downloads
47   * /creative-status-codes). Details are only available for statuses 10, 14, 15,
48   * 17, 18, 19, 86, and 87.
49   * @param array $optParams Optional parameters.
50   *
51   * @opt_param int pageSize Requested page size. The server may return fewer
52   * results than requested. If unspecified, the server will pick an appropriate
53   * default.
54   * @opt_param string pageToken A token identifying a page of results the server
55   * should return. Typically, this is the value of
56   * ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the
57   * previous call to the filteredBids.details.list method.
58   * @return ListCreativeStatusBreakdownByDetailResponse
59   */
60  public function listBiddersAccountsFilterSetsFilteredBidsDetails($filterSetName, $creativeStatusId, $optParams = [])
61  {
62    $params = ['filterSetName' => $filterSetName, 'creativeStatusId' => $creativeStatusId];
63    $params = array_merge($params, $optParams);
64    return $this->call('list', [$params], ListCreativeStatusBreakdownByDetailResponse::class);
65  }
66}
67
68// Adding a class alias for backwards compatibility with the previous class name.
69class_alias(BiddersAccountsFilterSetsFilteredBidsDetails::class, 'Google_Service_AdExchangeBuyerII_Resource_BiddersAccountsFilterSetsFilteredBidsDetails');
70