source: vendor/google/apiclient-services/src/AuthorizedBuyersMarketplace/Resource/BiddersAuctionPackages.php

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

Upload project files

  • Property mode set to 100644
File size: 3.3 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\AuthorizedBuyersMarketplace\Resource;
19
20use Google\Service\AuthorizedBuyersMarketplace\ListAuctionPackagesResponse;
21
22/**
23 * The "auctionPackages" collection of methods.
24 * Typical usage is:
25 * <code>
26 * $authorizedbuyersmarketplaceService = new Google\Service\AuthorizedBuyersMarketplace(...);
27 * $auctionPackages = $authorizedbuyersmarketplaceService->bidders_auctionPackages;
28 * </code>
29 */
30class BiddersAuctionPackages extends \Google\Service\Resource
31{
32 /**
33 * List the auction packages. Buyers can use the URL path
34 * "/v1/buyers/{accountId}/auctionPackages" to list auction packages for the
35 * current buyer and its clients. Bidders can use the URL path
36 * "/v1/bidders/{accountId}/auctionPackages" to list auction packages for the
37 * bidder, its media planners, its buyers, and all their clients.
38 * (auctionPackages.listBiddersAuctionPackages)
39 *
40 * @param string $parent Required. Name of the parent buyer that can access the
41 * auction package. Format: `buyers/{accountId}`. When used with a bidder
42 * account, the auction packages that the bidder, its media planners, its buyers
43 * and clients are subscribed to will be listed, in the format
44 * `bidders/{accountId}`.
45 * @param array $optParams Optional parameters.
46 *
47 * @opt_param string filter Optional. Optional query string using the [Cloud API
48 * list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only
49 * supported when parent is bidder. Supported columns for filtering are: *
50 * displayName * createTime * updateTime * eligibleSeatIds
51 * @opt_param string orderBy Optional. An optional query string to sort auction
52 * packages using the [Cloud API sorting
53 * syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
54 * If no sort order is specified, results will be returned in an arbitrary
55 * order. Only supported when parent is bidder. Supported columns for sorting
56 * are: * displayName * createTime * updateTime
57 * @opt_param int pageSize Requested page size. The server may return fewer
58 * results than requested. Max allowed page size is 500.
59 * @opt_param string pageToken The page token as returned.
60 * ListAuctionPackagesResponse.nextPageToken
61 * @return ListAuctionPackagesResponse
62 * @throws \Google\Service\Exception
63 */
64 public function listBiddersAuctionPackages($parent, $optParams = [])
65 {
66 $params = ['parent' => $parent];
67 $params = array_merge($params, $optParams);
68 return $this->call('list', [$params], ListAuctionPackagesResponse::class);
69 }
70}
71
72// Adding a class alias for backwards compatibility with the previous class name.
73class_alias(BiddersAuctionPackages::class, 'Google_Service_AuthorizedBuyersMarketplace_Resource_BiddersAuctionPackages');
Note: See TracBrowser for help on using the repository browser.