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\RealTimeBidding\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\RealTimeBidding\Bidder;
|
---|
21 | use Google\Service\RealTimeBidding\ListBiddersResponse;
|
---|
22 |
|
---|
23 | /**
|
---|
24 | * The "bidders" collection of methods.
|
---|
25 | * Typical usage is:
|
---|
26 | * <code>
|
---|
27 | * $realtimebiddingService = new Google\Service\RealTimeBidding(...);
|
---|
28 | * $bidders = $realtimebiddingService->bidders;
|
---|
29 | * </code>
|
---|
30 | */
|
---|
31 | class Bidders extends \Google\Service\Resource
|
---|
32 | {
|
---|
33 | /**
|
---|
34 | * Gets a bidder account by its name. (bidders.get)
|
---|
35 | *
|
---|
36 | * @param string $name Required. Name of the bidder to get. Format:
|
---|
37 | * `bidders/{bidderAccountId}`
|
---|
38 | * @param array $optParams Optional parameters.
|
---|
39 | * @return Bidder
|
---|
40 | * @throws \Google\Service\Exception
|
---|
41 | */
|
---|
42 | public function get($name, $optParams = [])
|
---|
43 | {
|
---|
44 | $params = ['name' => $name];
|
---|
45 | $params = array_merge($params, $optParams);
|
---|
46 | return $this->call('get', [$params], Bidder::class);
|
---|
47 | }
|
---|
48 | /**
|
---|
49 | * Lists all the bidder accounts that belong to the caller.
|
---|
50 | * (bidders.listBidders)
|
---|
51 | *
|
---|
52 | * @param array $optParams Optional parameters.
|
---|
53 | *
|
---|
54 | * @opt_param int pageSize The maximum number of bidders to return. If
|
---|
55 | * unspecified, at most 100 bidders will be returned. The maximum value is 500;
|
---|
56 | * values above 500 will be coerced to 500.
|
---|
57 | * @opt_param string pageToken A token identifying a page of results the server
|
---|
58 | * should return. This value is received from a previous `ListBidders` call in
|
---|
59 | * ListBiddersResponse.nextPageToken.
|
---|
60 | * @return ListBiddersResponse
|
---|
61 | * @throws \Google\Service\Exception
|
---|
62 | */
|
---|
63 | public function listBidders($optParams = [])
|
---|
64 | {
|
---|
65 | $params = [];
|
---|
66 | $params = array_merge($params, $optParams);
|
---|
67 | return $this->call('list', [$params], ListBiddersResponse::class);
|
---|
68 | }
|
---|
69 | }
|
---|
70 |
|
---|
71 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
72 | class_alias(Bidders::class, 'Google_Service_RealTimeBidding_Resource_Bidders');
|
---|