Viewing file:  RealTimeBidding.php (19.54 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service;
use Google\Client;
/**
* Service definition for RealTimeBidding (v1).
*
* <p>
* Allows external bidders to manage their RTB integration with Google. This
* includes managing bidder endpoints, QPS quotas, configuring what ad inventory
* to receive via pretargeting, submitting creatives for verification, and
* accessing creative metadata such as approval status.</p>
*
* <p>
* For more information about this service, see the API
* <a href="https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/" target="_blank">Documentation</a>
* </p>
*
* @author Google, Inc.
*/
class RealTimeBidding extends \Google\Service
{
/** See, create, edit, and delete your Authorized Buyers and Open Bidding account entities. */
const REALTIME_BIDDING =
"https://www.googleapis.com/auth/realtime-bidding";
public $bidders;
public $bidders_creatives;
public $bidders_endpoints;
public $bidders_pretargetingConfigs;
public $bidders_publisherConnections;
public $buyers;
public $buyers_creatives;
public $buyers_userLists;
/**
* Constructs the internal representation of the RealTimeBidding service.
*
* @param Client|array $clientOrConfig The client used to deliver requests, or a
* config array to pass to a new Client instance.
* @param string $rootUrl The root URL used for requests to the service.
*/
public function __construct($clientOrConfig = [], $rootUrl = null)
{
parent::__construct($clientOrConfig);
$this->rootUrl = $rootUrl ?: 'https://realtimebidding.googleapis.com/';
$this->servicePath = '';
$this->batchPath = 'batch';
$this->version = 'v1';
$this->serviceName = 'realtimebidding';
$this->bidders = new RealTimeBidding\Resource\Bidders(
$this,
$this->serviceName,
'bidders',
[
'methods' => [
'get' => [
'path' => 'v1/{+name}',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'list' => [
'path' => 'v1/bidders',
'httpMethod' => 'GET',
'parameters' => [
'pageSize' => [
'location' => 'query',
'type' => 'integer',
],
'pageToken' => [
'location' => 'query',
'type' => 'string',
],
],
],
]
]
);
$this->bidders_creatives = new RealTimeBidding\Resource\BiddersCreatives(
$this,
$this->serviceName,
'creatives',
[
'methods' => [
'list' => [
'path' => 'v1/{+parent}/creatives',
'httpMethod' => 'GET',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'filter' => [
'location' => 'query',
'type' => 'string',
],
'pageSize' => [
'location' => 'query',
'type' => 'integer',
],
'pageToken' => [
'location' => 'query',
'type' => 'string',
],
'view' => [
'location' => 'query',
'type' => 'string',
],
],
],'watch' => [
'path' => 'v1/{+parent}/creatives:watch',
'httpMethod' => 'POST',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],
]
]
);
$this->bidders_endpoints = new RealTimeBidding\Resource\BiddersEndpoints(
$this,
$this->serviceName,
'endpoints',
[
'methods' => [
'get' => [
'path' => 'v1/{+name}',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'list' => [
'path' => 'v1/{+parent}/endpoints',
'httpMethod' => 'GET',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'pageSize' => [
'location' => 'query',
'type' => 'integer',
],
'pageToken' => [
'location' => 'query',
'type' => 'string',
],
],
],'patch' => [
'path' => 'v1/{+name}',
'httpMethod' => 'PATCH',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'updateMask' => [
'location' => 'query',
'type' => 'string',
],
],
],
]
]
);
$this->bidders_pretargetingConfigs = new RealTimeBidding\Resource\BiddersPretargetingConfigs(
$this,
$this->serviceName,
'pretargetingConfigs',
[
'methods' => [
'activate' => [
'path' => 'v1/{+name}:activate',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'addTargetedApps' => [
'path' => 'v1/{+pretargetingConfig}:addTargetedApps',
'httpMethod' => 'POST',
'parameters' => [
'pretargetingConfig' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'addTargetedPublishers' => [
'path' => 'v1/{+pretargetingConfig}:addTargetedPublishers',
'httpMethod' => 'POST',
'parameters' => [
'pretargetingConfig' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'addTargetedSites' => [
'path' => 'v1/{+pretargetingConfig}:addTargetedSites',
'httpMethod' => 'POST',
'parameters' => [
'pretargetingConfig' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'create' => [
'path' => 'v1/{+parent}/pretargetingConfigs',
'httpMethod' => 'POST',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'delete' => [
'path' => 'v1/{+name}',
'httpMethod' => 'DELETE',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'get' => [
'path' => 'v1/{+name}',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'list' => [
'path' => 'v1/{+parent}/pretargetingConfigs',
'httpMethod' => 'GET',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'pageSize' => [
'location' => 'query',
'type' => 'integer',
],
'pageToken' => [
'location' => 'query',
'type' => 'string',
],
],
],'patch' => [
'path' => 'v1/{+name}',
'httpMethod' => 'PATCH',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'updateMask' => [
'location' => 'query',
'type' => 'string',
],
],
],'removeTargetedApps' => [
'path' => 'v1/{+pretargetingConfig}:removeTargetedApps',
'httpMethod' => 'POST',
'parameters' => [
'pretargetingConfig' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'removeTargetedPublishers' => [
'path' => 'v1/{+pretargetingConfig}:removeTargetedPublishers',
'httpMethod' => 'POST',
'parameters' => [
'pretargetingConfig' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'removeTargetedSites' => [
'path' => 'v1/{+pretargetingConfig}:removeTargetedSites',
'httpMethod' => 'POST',
'parameters' => [
'pretargetingConfig' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'suspend' => [
'path' => 'v1/{+name}:suspend',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],
]
]
);
$this->bidders_publisherConnections = new RealTimeBidding\Resource\BiddersPublisherConnections(
$this,
$this->serviceName,
'publisherConnections',
[
'methods' => [
'batchApprove' => [
'path' => 'v1/{+parent}/publisherConnections:batchApprove',
'httpMethod' => 'POST',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'batchReject' => [
'path' => 'v1/{+parent}/publisherConnections:batchReject',
'httpMethod' => 'POST',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'get' => [
'path' => 'v1/{+name}',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'list' => [
'path' => 'v1/{+parent}/publisherConnections',
'httpMethod' => 'GET',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'filter' => [
'location' => 'query',
'type' => 'string',
],
'orderBy' => [
'location' => 'query',
'type' => 'string',
],
'pageSize' => [
'location' => 'query',
'type' => 'integer',
],
'pageToken' => [
'location' => 'query',
'type' => 'string',
],
],
],
]
]
);
$this->buyers = new RealTimeBidding\Resource\Buyers(
$this,
$this->serviceName,
'buyers',
[
'methods' => [
'get' => [
'path' => 'v1/{+name}',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'getRemarketingTag' => [
'path' => 'v1/{+name}:getRemarketingTag',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'list' => [
'path' => 'v1/buyers',
'httpMethod' => 'GET',
'parameters' => [
'pageSize' => [
'location' => 'query',
'type' => 'integer',
],
'pageToken' => [
'location' => 'query',
'type' => 'string',
],
],
],
]
]
);
$this->buyers_creatives = new RealTimeBidding\Resource\BuyersCreatives(
$this,
$this->serviceName,
'creatives',
[
'methods' => [
'create' => [
'path' => 'v1/{+parent}/creatives',
'httpMethod' => 'POST',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'get' => [
'path' => 'v1/{+name}',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'view' => [
'location' => 'query',
'type' => 'string',
],
],
],'list' => [
'path' => 'v1/{+parent}/creatives',
'httpMethod' => 'GET',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'filter' => [
'location' => 'query',
'type' => 'string',
],
'pageSize' => [
'location' => 'query',
'type' => 'integer',
],
'pageToken' => [
'location' => 'query',
'type' => 'string',
],
'view' => [
'location' => 'query',
'type' => 'string',
],
],
],'patch' => [
'path' => 'v1/{+name}',
'httpMethod' => 'PATCH',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'updateMask' => [
'location' => 'query',
'type' => 'string',
],
],
],
]
]
);
$this->buyers_userLists = new RealTimeBidding\Resource\BuyersUserLists(
$this,
$this->serviceName,
'userLists',
[
'methods' => [
'close' => [
'path' => 'v1/{+name}:close',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'create' => [
'path' => 'v1/{+parent}/userLists',
'httpMethod' => 'POST',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'get' => [
'path' => 'v1/{+name}',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'getRemarketingTag' => [
'path' => 'v1/{+name}:getRemarketingTag',
'httpMethod' => 'GET',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'list' => [
'path' => 'v1/{+parent}/userLists',
'httpMethod' => 'GET',
'parameters' => [
'parent' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
'pageSize' => [
'location' => 'query',
'type' => 'integer',
],
'pageToken' => [
'location' => 'query',
'type' => 'string',
],
],
],'open' => [
'path' => 'v1/{+name}:open',
'httpMethod' => 'POST',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],'update' => [
'path' => 'v1/{+name}',
'httpMethod' => 'PUT',
'parameters' => [
'name' => [
'location' => 'path',
'type' => 'string',
'required' => true,
],
],
],
]
]
);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RealTimeBidding::class, 'Google_Service_RealTimeBidding');
|