[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\RealTimeBidding\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\RealTimeBidding\Endpoint;
|
---|
| 21 | use Google\Service\RealTimeBidding\ListEndpointsResponse;
|
---|
| 22 |
|
---|
| 23 | /**
|
---|
| 24 | * The "endpoints" collection of methods.
|
---|
| 25 | * Typical usage is:
|
---|
| 26 | * <code>
|
---|
| 27 | * $realtimebiddingService = new Google\Service\RealTimeBidding(...);
|
---|
| 28 | * $endpoints = $realtimebiddingService->bidders_endpoints;
|
---|
| 29 | * </code>
|
---|
| 30 | */
|
---|
| 31 | class BiddersEndpoints extends \Google\Service\Resource
|
---|
| 32 | {
|
---|
| 33 | /**
|
---|
| 34 | * Gets a bidder endpoint by its name. (endpoints.get)
|
---|
| 35 | *
|
---|
| 36 | * @param string $name Required. Name of the bidder endpoint to get. Format:
|
---|
| 37 | * `bidders/{bidderAccountId}/endpoints/{endpointId}`
|
---|
| 38 | * @param array $optParams Optional parameters.
|
---|
| 39 | * @return Endpoint
|
---|
| 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], Endpoint::class);
|
---|
| 47 | }
|
---|
| 48 | /**
|
---|
| 49 | * Lists all the bidder's endpoints. (endpoints.listBiddersEndpoints)
|
---|
| 50 | *
|
---|
| 51 | * @param string $parent Required. Name of the bidder whose endpoints will be
|
---|
| 52 | * listed. Format: `bidders/{bidderAccountId}`
|
---|
| 53 | * @param array $optParams Optional parameters.
|
---|
| 54 | *
|
---|
| 55 | * @opt_param int pageSize The maximum number of endpoints to return. If
|
---|
| 56 | * unspecified, at most 100 endpoints will be returned. The maximum value is
|
---|
| 57 | * 500; values above 500 will be coerced to 500.
|
---|
| 58 | * @opt_param string pageToken A token identifying a page of results the server
|
---|
| 59 | * should return. This value is received from a previous `ListEndpoints` call in
|
---|
| 60 | * ListEndpointsResponse.nextPageToken.
|
---|
| 61 | * @return ListEndpointsResponse
|
---|
| 62 | * @throws \Google\Service\Exception
|
---|
| 63 | */
|
---|
| 64 | public function listBiddersEndpoints($parent, $optParams = [])
|
---|
| 65 | {
|
---|
| 66 | $params = ['parent' => $parent];
|
---|
| 67 | $params = array_merge($params, $optParams);
|
---|
| 68 | return $this->call('list', [$params], ListEndpointsResponse::class);
|
---|
| 69 | }
|
---|
| 70 | /**
|
---|
| 71 | * Updates a bidder's endpoint. (endpoints.patch)
|
---|
| 72 | *
|
---|
| 73 | * @param string $name Output only. Name of the endpoint resource that must
|
---|
| 74 | * follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where
|
---|
| 75 | * {bidderAccountId} is the account ID of the bidder who operates this endpoint,
|
---|
| 76 | * and {endpointId} is a unique ID assigned by the server.
|
---|
| 77 | * @param Endpoint $postBody
|
---|
| 78 | * @param array $optParams Optional parameters.
|
---|
| 79 | *
|
---|
| 80 | * @opt_param string updateMask Field mask to use for partial in-place updates.
|
---|
| 81 | * @return Endpoint
|
---|
| 82 | * @throws \Google\Service\Exception
|
---|
| 83 | */
|
---|
| 84 | public function patch($name, Endpoint $postBody, $optParams = [])
|
---|
| 85 | {
|
---|
| 86 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
| 87 | $params = array_merge($params, $optParams);
|
---|
| 88 | return $this->call('patch', [$params], Endpoint::class);
|
---|
| 89 | }
|
---|
| 90 | }
|
---|
| 91 |
|
---|
| 92 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 93 | class_alias(BiddersEndpoints::class, 'Google_Service_RealTimeBidding_Resource_BiddersEndpoints');
|
---|