Initial commit

This commit is contained in:
Local Administrator
2025-04-18 10:32:42 +02:00
commit b83134aca3
29643 changed files with 3045897 additions and 0 deletions
@@ -0,0 +1,72 @@
<?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\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\Bidder;
use Google\Service\RealTimeBidding\ListBiddersResponse;
/**
* The "bidders" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $bidders = $realtimebiddingService->bidders;
* </code>
*/
class Bidders extends \Google\Service\Resource
{
/**
* Gets a bidder account by its name. (bidders.get)
*
* @param string $name Required. Name of the bidder to get. Format:
* `bidders/{bidderAccountId}`
* @param array $optParams Optional parameters.
* @return Bidder
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Bidder::class);
}
/**
* Lists all the bidder accounts that belong to the caller.
* (bidders.listBidders)
*
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of bidders to return. If
* unspecified, at most 100 bidders will be returned. The maximum value is 500;
* values above 500 will be coerced to 500.
* @opt_param string pageToken A token identifying a page of results the server
* should return. This value is received from a previous `ListBidders` call in
* ListBiddersResponse.nextPageToken.
* @return ListBiddersResponse
* @throws \Google\Service\Exception
*/
public function listBidders($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListBiddersResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Bidders::class, 'Google_Service_RealTimeBidding_Resource_Bidders');
@@ -0,0 +1,108 @@
<?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\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\ListCreativesResponse;
use Google\Service\RealTimeBidding\WatchCreativesRequest;
use Google\Service\RealTimeBidding\WatchCreativesResponse;
/**
* The "creatives" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $creatives = $realtimebiddingService->bidders_creatives;
* </code>
*/
class BiddersCreatives extends \Google\Service\Resource
{
/**
* Lists creatives as they are at the time of the initial request. This call may
* take multiple hours to complete. For large, paginated requests, this method
* returns a snapshot of creatives at the time of request for the first page.
* `lastStatusUpdate` and `creativeServingDecision` may be outdated for
* creatives on sequential pages. We recommend [Google Cloud
* Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.
* (creatives.listBiddersCreatives)
*
* @param string $parent Required. Name of the parent buyer that owns the
* creatives. The pattern for this resource is either `buyers/{buyerAccountId}`
* or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the
* `buyerAccountId` can be one of the following: 1. The ID of the buyer that is
* accessing their own creatives. 2. The ID of the child seat buyer under a
* bidder account. So for listing creatives pertaining to the child seat buyer
* (`456`) under bidder account (`123`), you would use the pattern:
* `buyers/456`. 3. The ID of the bidder itself. So for listing creatives
* pertaining to bidder (`123`), you would use `buyers/123`. If you want to
* access all creatives pertaining to both the bidder and all of its child seat
* accounts, you would use `bidders/{bidderAccountId}`, for example, for all
* creatives pertaining to bidder (`123`), use `bidders/123`.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Query string to filter creatives. If no filter is
* specified, all active creatives will be returned. Example: 'accountId=12345
* AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR
* declaredAttributes:IS_COOKIE_TARGETED'
* @opt_param int pageSize Requested page size. The server may return fewer
* creatives than requested (due to timeout constraint) even if more are
* available through another call. If unspecified, server will pick an
* appropriate default. Acceptable values are 1 to 1000, inclusive.
* @opt_param string pageToken A token identifying a page of results the server
* should return. Typically, this is the value of
* ListCreativesResponse.nextPageToken returned from the previous call to the
* 'ListCreatives' method. Page tokens for continued pages are valid for up to
* five hours, counting from the call to 'ListCreatives' for the first page.
* @opt_param string view Controls the amount of information included in the
* response. By default only creativeServingDecision is included. To retrieve
* the entire creative resource (including the declared fields and the creative
* content) specify the view as "FULL".
* @return ListCreativesResponse
* @throws \Google\Service\Exception
*/
public function listBiddersCreatives($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListCreativesResponse::class);
}
/**
* Watches all creatives pertaining to a bidder. It is sufficient to invoke this
* endpoint once per bidder. A Pub/Sub topic will be created and notifications
* will be pushed to the topic when any of the bidder's creatives change status.
* All of the bidder's service accounts will have access to read from the topic.
* Subsequent invocations of this method will return the existing Pub/Sub
* configuration. (creatives.watch)
*
* @param string $parent Required. To watch all creatives pertaining to the
* bidder and all its child seat accounts, the bidder must follow the pattern
* `bidders/{bidderAccountId}`.
* @param WatchCreativesRequest $postBody
* @param array $optParams Optional parameters.
* @return WatchCreativesResponse
* @throws \Google\Service\Exception
*/
public function watch($parent, WatchCreativesRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('watch', [$params], WatchCreativesResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BiddersCreatives::class, 'Google_Service_RealTimeBidding_Resource_BiddersCreatives');
@@ -0,0 +1,93 @@
<?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\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\Endpoint;
use Google\Service\RealTimeBidding\ListEndpointsResponse;
/**
* The "endpoints" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $endpoints = $realtimebiddingService->bidders_endpoints;
* </code>
*/
class BiddersEndpoints extends \Google\Service\Resource
{
/**
* Gets a bidder endpoint by its name. (endpoints.get)
*
* @param string $name Required. Name of the bidder endpoint to get. Format:
* `bidders/{bidderAccountId}/endpoints/{endpointId}`
* @param array $optParams Optional parameters.
* @return Endpoint
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Endpoint::class);
}
/**
* Lists all the bidder's endpoints. (endpoints.listBiddersEndpoints)
*
* @param string $parent Required. Name of the bidder whose endpoints will be
* listed. Format: `bidders/{bidderAccountId}`
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of endpoints to return. If
* unspecified, at most 100 endpoints will be returned. The maximum value is
* 500; values above 500 will be coerced to 500.
* @opt_param string pageToken A token identifying a page of results the server
* should return. This value is received from a previous `ListEndpoints` call in
* ListEndpointsResponse.nextPageToken.
* @return ListEndpointsResponse
* @throws \Google\Service\Exception
*/
public function listBiddersEndpoints($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListEndpointsResponse::class);
}
/**
* Updates a bidder's endpoint. (endpoints.patch)
*
* @param string $name Output only. Name of the endpoint resource that must
* follow the pattern `bidders/{bidderAccountId}/endpoints/{endpointId}`, where
* {bidderAccountId} is the account ID of the bidder who operates this endpoint,
* and {endpointId} is a unique ID assigned by the server.
* @param Endpoint $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Field mask to use for partial in-place updates.
* @return Endpoint
* @throws \Google\Service\Exception
*/
public function patch($name, Endpoint $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Endpoint::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BiddersEndpoints::class, 'Google_Service_RealTimeBidding_Resource_BiddersEndpoints');
@@ -0,0 +1,278 @@
<?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\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\ActivatePretargetingConfigRequest;
use Google\Service\RealTimeBidding\AddTargetedAppsRequest;
use Google\Service\RealTimeBidding\AddTargetedPublishersRequest;
use Google\Service\RealTimeBidding\AddTargetedSitesRequest;
use Google\Service\RealTimeBidding\ListPretargetingConfigsResponse;
use Google\Service\RealTimeBidding\PretargetingConfig;
use Google\Service\RealTimeBidding\RealtimebiddingEmpty;
use Google\Service\RealTimeBidding\RemoveTargetedAppsRequest;
use Google\Service\RealTimeBidding\RemoveTargetedPublishersRequest;
use Google\Service\RealTimeBidding\RemoveTargetedSitesRequest;
use Google\Service\RealTimeBidding\SuspendPretargetingConfigRequest;
/**
* The "pretargetingConfigs" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $pretargetingConfigs = $realtimebiddingService->bidders_pretargetingConfigs;
* </code>
*/
class BiddersPretargetingConfigs extends \Google\Service\Resource
{
/**
* Activates a pretargeting configuration. (pretargetingConfigs.activate)
*
* @param string $name Required. The name of the pretargeting configuration.
* Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param ActivatePretargetingConfigRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function activate($name, ActivatePretargetingConfigRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('activate', [$params], PretargetingConfig::class);
}
/**
* Adds targeted apps to the pretargeting configuration.
* (pretargetingConfigs.addTargetedApps)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param AddTargetedAppsRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function addTargetedApps($pretargetingConfig, AddTargetedAppsRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('addTargetedApps', [$params], PretargetingConfig::class);
}
/**
* Adds targeted publishers to the pretargeting config.
* (pretargetingConfigs.addTargetedPublishers)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param AddTargetedPublishersRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function addTargetedPublishers($pretargetingConfig, AddTargetedPublishersRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('addTargetedPublishers', [$params], PretargetingConfig::class);
}
/**
* Adds targeted sites to the pretargeting configuration.
* (pretargetingConfigs.addTargetedSites)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param AddTargetedSitesRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function addTargetedSites($pretargetingConfig, AddTargetedSitesRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('addTargetedSites', [$params], PretargetingConfig::class);
}
/**
* Creates a pretargeting configuration. A pretargeting configuration's state
* (PretargetingConfig.state) is active upon creation, and it will start to
* affect traffic shortly after. A bidder may create a maximum of 10
* pretargeting configurations. Attempts to exceed this maximum results in a 400
* bad request error. (pretargetingConfigs.create)
*
* @param string $parent Required. Name of the bidder to create the pretargeting
* configuration for. Format: bidders/{bidderAccountId}
* @param PretargetingConfig $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function create($parent, PretargetingConfig $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], PretargetingConfig::class);
}
/**
* Deletes a pretargeting configuration. (pretargetingConfigs.delete)
*
* @param string $name Required. The name of the pretargeting configuration to
* delete. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param array $optParams Optional parameters.
* @return RealtimebiddingEmpty
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], RealtimebiddingEmpty::class);
}
/**
* Gets a pretargeting configuration. (pretargetingConfigs.get)
*
* @param string $name Required. Name of the pretargeting configuration to get.
* Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], PretargetingConfig::class);
}
/**
* Lists all pretargeting configurations for a single bidder.
* (pretargetingConfigs.listBiddersPretargetingConfigs)
*
* @param string $parent Required. Name of the bidder whose pretargeting
* configurations will be listed. Format: bidders/{bidderAccountId}
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of pretargeting configurations to
* return. If unspecified, at most 10 pretargeting configurations will be
* returned. The maximum value is 100; values above 100 will be coerced to 100.
* @opt_param string pageToken A token identifying a page of results the server
* should return. This value is received from a previous
* `ListPretargetingConfigs` call in
* ListPretargetingConfigsResponse.nextPageToken.
* @return ListPretargetingConfigsResponse
* @throws \Google\Service\Exception
*/
public function listBiddersPretargetingConfigs($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListPretargetingConfigsResponse::class);
}
/**
* Updates a pretargeting configuration. (pretargetingConfigs.patch)
*
* @param string $name Output only. Name of the pretargeting configuration that
* must follow the pattern
* `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`
* @param PretargetingConfig $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Field mask to use for partial in-place updates.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function patch($name, PretargetingConfig $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], PretargetingConfig::class);
}
/**
* Removes targeted apps from the pretargeting configuration.
* (pretargetingConfigs.removeTargetedApps)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param RemoveTargetedAppsRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function removeTargetedApps($pretargetingConfig, RemoveTargetedAppsRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('removeTargetedApps', [$params], PretargetingConfig::class);
}
/**
* Removes targeted publishers from the pretargeting config.
* (pretargetingConfigs.removeTargetedPublishers)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param RemoveTargetedPublishersRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function removeTargetedPublishers($pretargetingConfig, RemoveTargetedPublishersRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('removeTargetedPublishers', [$params], PretargetingConfig::class);
}
/**
* Removes targeted sites from the pretargeting configuration.
* (pretargetingConfigs.removeTargetedSites)
*
* @param string $pretargetingConfig Required. The name of the pretargeting
* configuration. Format:
* bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param RemoveTargetedSitesRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function removeTargetedSites($pretargetingConfig, RemoveTargetedSitesRequest $postBody, $optParams = [])
{
$params = ['pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('removeTargetedSites', [$params], PretargetingConfig::class);
}
/**
* Suspends a pretargeting configuration. (pretargetingConfigs.suspend)
*
* @param string $name Required. The name of the pretargeting configuration.
* Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param SuspendPretargetingConfigRequest $postBody
* @param array $optParams Optional parameters.
* @return PretargetingConfig
* @throws \Google\Service\Exception
*/
public function suspend($name, SuspendPretargetingConfigRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('suspend', [$params], PretargetingConfig::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BiddersPretargetingConfigs::class, 'Google_Service_RealTimeBidding_Resource_BiddersPretargetingConfigs');
@@ -0,0 +1,130 @@
<?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\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\BatchApprovePublisherConnectionsRequest;
use Google\Service\RealTimeBidding\BatchApprovePublisherConnectionsResponse;
use Google\Service\RealTimeBidding\BatchRejectPublisherConnectionsRequest;
use Google\Service\RealTimeBidding\BatchRejectPublisherConnectionsResponse;
use Google\Service\RealTimeBidding\ListPublisherConnectionsResponse;
use Google\Service\RealTimeBidding\PublisherConnection;
/**
* The "publisherConnections" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $publisherConnections = $realtimebiddingService->bidders_publisherConnections;
* </code>
*/
class BiddersPublisherConnections extends \Google\Service\Resource
{
/**
* Batch approves multiple publisher connections.
* (publisherConnections.batchApprove)
*
* @param string $parent Required. The bidder for whom publisher connections
* will be approved. Format: `bidders/{bidder}` where `{bidder}` is the account
* ID of the bidder.
* @param BatchApprovePublisherConnectionsRequest $postBody
* @param array $optParams Optional parameters.
* @return BatchApprovePublisherConnectionsResponse
* @throws \Google\Service\Exception
*/
public function batchApprove($parent, BatchApprovePublisherConnectionsRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchApprove', [$params], BatchApprovePublisherConnectionsResponse::class);
}
/**
* Batch rejects multiple publisher connections.
* (publisherConnections.batchReject)
*
* @param string $parent Required. The bidder for whom publisher connections
* will be rejected. Format: `bidders/{bidder}` where `{bidder}` is the account
* ID of the bidder.
* @param BatchRejectPublisherConnectionsRequest $postBody
* @param array $optParams Optional parameters.
* @return BatchRejectPublisherConnectionsResponse
* @throws \Google\Service\Exception
*/
public function batchReject($parent, BatchRejectPublisherConnectionsRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('batchReject', [$params], BatchRejectPublisherConnectionsResponse::class);
}
/**
* Gets a publisher connection. (publisherConnections.get)
*
* @param string $name Required. Name of the publisher whose connection
* information is to be retrieved. In the pattern
* `bidders/{bidder}/publisherConnections/{publisher}` where `{bidder}` is the
* account ID of the bidder, and `{publisher}` is the ads.txt/app-ads.txt
* publisher ID. See publisherConnection.name.
* @param array $optParams Optional parameters.
* @return PublisherConnection
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], PublisherConnection::class);
}
/**
* Lists publisher connections for a given bidder.
* (publisherConnections.listBiddersPublisherConnections)
*
* @param string $parent Required. Name of the bidder for which publishers have
* initiated connections. The pattern for this resource is `bidders/{bidder}`
* where `{bidder}` represents the account ID of the bidder.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Query string to filter publisher connections.
* Connections can be filtered by `displayName`, `publisherPlatform`, and
* `biddingState`. If no filter is specified, all publisher connections will be
* returned. Example: 'displayName="Great Publisher*" AND
* publisherPlatform=ADMOB AND biddingState != PENDING' See
* https://google.aip.dev/160 for more information about filtering syntax.
* @opt_param string orderBy Order specification by which results should be
* sorted. If no sort order is specified, the results will be returned in
* alphabetic order based on the publisher's publisher code. Results can be
* sorted by `createTime`. Example: 'createTime DESC'.
* @opt_param int pageSize Requested page size. The server may return fewer
* results than requested (due to timeout constraint) even if more are available
* through another call. If unspecified, the server will pick an appropriate
* default. Acceptable values are 1 to 5000, inclusive.
* @opt_param string pageToken A token identifying a page of results the server
* should return. Typically, this is the value of
* ListPublisherConnectionsResponse.nextPageToken returned from the previous
* call to the 'ListPublisherConnections' method.
* @return ListPublisherConnectionsResponse
* @throws \Google\Service\Exception
*/
public function listBiddersPublisherConnections($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListPublisherConnectionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BiddersPublisherConnections::class, 'Google_Service_RealTimeBidding_Resource_BiddersPublisherConnections');
@@ -0,0 +1,99 @@
<?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\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\Buyer;
use Google\Service\RealTimeBidding\GetRemarketingTagResponse;
use Google\Service\RealTimeBidding\ListBuyersResponse;
/**
* The "buyers" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $buyers = $realtimebiddingService->buyers;
* </code>
*/
class Buyers extends \Google\Service\Resource
{
/**
* Gets a buyer account by its name. (buyers.get)
*
* @param string $name Required. Name of the buyer to get. Format:
* `buyers/{buyerId}`
* @param array $optParams Optional parameters.
* @return Buyer
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Buyer::class);
}
/**
* This has been sunset as of October 2023, and will return an error response if
* called. For more information, see the release notes:
* https://developers.google.com/authorized-buyers/apis/relnotes#real-time-
* bidding-api Gets remarketing tag for a buyer. A remarketing tag is a piece of
* JavaScript code that can be placed on a web page. When a user visits a page
* containing a remarketing tag, Google adds the user to a user list.
* (buyers.getRemarketingTag)
*
* @param string $name Required. To fetch the remarketing tag for an account,
* the name must follow the pattern `buyers/{accountId}`, where `{accountId}`
* represents the ID of the buyer that owns the remarketing tag. For a bidder
* accessing the remarketing tag on behalf of a child seat buyer, `{accountId}`
* should represent the ID of the child seat buyer. To fetch the remarketing tag
* for a specific user list, the name must follow the pattern
* `buyers/{accountId}/userLists/{userListId}`. See UserList.name.
* @param array $optParams Optional parameters.
* @return GetRemarketingTagResponse
* @throws \Google\Service\Exception
*/
public function getRemarketingTag($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getRemarketingTag', [$params], GetRemarketingTagResponse::class);
}
/**
* Lists all buyer account information the calling buyer user or service account
* is permissioned to manage. (buyers.listBuyers)
*
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of buyers to return. If
* unspecified, at most 100 buyers will be returned. The maximum value is 500;
* values above 500 will be coerced to 500.
* @opt_param string pageToken A token identifying a page of results the server
* should return. This value is received from a previous `ListBuyers` call in
* ListBuyersResponse.nextPageToken.
* @return ListBuyersResponse
* @throws \Google\Service\Exception
*/
public function listBuyers($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListBuyersResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Buyers::class, 'Google_Service_RealTimeBidding_Resource_Buyers');
@@ -0,0 +1,144 @@
<?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\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\Creative;
use Google\Service\RealTimeBidding\ListCreativesResponse;
/**
* The "creatives" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $creatives = $realtimebiddingService->buyers_creatives;
* </code>
*/
class BuyersCreatives extends \Google\Service\Resource
{
/**
* Creates a creative. (creatives.create)
*
* @param string $parent Required. The name of the parent buyer that the new
* creative belongs to that must follow the pattern `buyers/{buyerAccountId}`,
* where `{buyerAccountId}` represents the account ID of the buyer who owns a
* creative. For a bidder accessing creatives on behalf of a child seat buyer,
* `{buyerAccountId}` should represent the account ID of the child seat buyer.
* @param Creative $postBody
* @param array $optParams Optional parameters.
* @return Creative
* @throws \Google\Service\Exception
*/
public function create($parent, Creative $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Creative::class);
}
/**
* Gets a creative. (creatives.get)
*
* @param string $name Required. Name of the creative to retrieve. See
* creative.name.
* @param array $optParams Optional parameters.
*
* @opt_param string view Controls the amount of information included in the
* response. By default only creativeServingDecision is included. To retrieve
* the entire creative resource (including the declared fields and the creative
* content) specify the view as "FULL".
* @return Creative
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Creative::class);
}
/**
* Lists creatives as they are at the time of the initial request. This call may
* take multiple hours to complete. For large, paginated requests, this method
* returns a snapshot of creatives at the time of request for the first page.
* `lastStatusUpdate` and `creativeServingDecision` may be outdated for
* creatives on sequential pages. We recommend [Google Cloud
* Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.
* (creatives.listBuyersCreatives)
*
* @param string $parent Required. Name of the parent buyer that owns the
* creatives. The pattern for this resource is either `buyers/{buyerAccountId}`
* or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the
* `buyerAccountId` can be one of the following: 1. The ID of the buyer that is
* accessing their own creatives. 2. The ID of the child seat buyer under a
* bidder account. So for listing creatives pertaining to the child seat buyer
* (`456`) under bidder account (`123`), you would use the pattern:
* `buyers/456`. 3. The ID of the bidder itself. So for listing creatives
* pertaining to bidder (`123`), you would use `buyers/123`. If you want to
* access all creatives pertaining to both the bidder and all of its child seat
* accounts, you would use `bidders/{bidderAccountId}`, for example, for all
* creatives pertaining to bidder (`123`), use `bidders/123`.
* @param array $optParams Optional parameters.
*
* @opt_param string filter Query string to filter creatives. If no filter is
* specified, all active creatives will be returned. Example: 'accountId=12345
* AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR
* declaredAttributes:IS_COOKIE_TARGETED'
* @opt_param int pageSize Requested page size. The server may return fewer
* creatives than requested (due to timeout constraint) even if more are
* available through another call. If unspecified, server will pick an
* appropriate default. Acceptable values are 1 to 1000, inclusive.
* @opt_param string pageToken A token identifying a page of results the server
* should return. Typically, this is the value of
* ListCreativesResponse.nextPageToken returned from the previous call to the
* 'ListCreatives' method. Page tokens for continued pages are valid for up to
* five hours, counting from the call to 'ListCreatives' for the first page.
* @opt_param string view Controls the amount of information included in the
* response. By default only creativeServingDecision is included. To retrieve
* the entire creative resource (including the declared fields and the creative
* content) specify the view as "FULL".
* @return ListCreativesResponse
* @throws \Google\Service\Exception
*/
public function listBuyersCreatives($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListCreativesResponse::class);
}
/**
* Updates a creative. (creatives.patch)
*
* @param string $name Output only. Name of the creative. Follows the pattern
* `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account
* ID of the buyer who owns the creative, and `{creative}` is the buyer-specific
* creative ID that references this creative in the bid response.
* @param Creative $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Field mask to use for partial in-place updates.
* @return Creative
* @throws \Google\Service\Exception
*/
public function patch($name, Creative $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Creative::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BuyersCreatives::class, 'Google_Service_RealTimeBidding_Resource_BuyersCreatives');
@@ -0,0 +1,177 @@
<?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\RealTimeBidding\Resource;
use Google\Service\RealTimeBidding\CloseUserListRequest;
use Google\Service\RealTimeBidding\GetRemarketingTagResponse;
use Google\Service\RealTimeBidding\ListUserListsResponse;
use Google\Service\RealTimeBidding\OpenUserListRequest;
use Google\Service\RealTimeBidding\UserList;
/**
* The "userLists" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google\Service\RealTimeBidding(...);
* $userLists = $realtimebiddingService->buyers_userLists;
* </code>
*/
class BuyersUserLists extends \Google\Service\Resource
{
/**
* Changes the status of a user list to CLOSED. This prevents new users from
* being added to the user list. (userLists.close)
*
* @param string $name Required. The name of the user list to close. See
* UserList.name
* @param CloseUserListRequest $postBody
* @param array $optParams Optional parameters.
* @return UserList
* @throws \Google\Service\Exception
*/
public function close($name, CloseUserListRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('close', [$params], UserList::class);
}
/**
* Creates a new user list. (userLists.create)
*
* @param string $parent Required. The name of the parent buyer of the user list
* to be retrieved, which must follow the pattern `buyers/{buyerAccountId}`,
* where `{buyerAccountId}` represents the account ID of the buyer who owns the
* user list. For a bidder accessing user lists on behalf of a child seat buyer,
* `{buyerAccountId}` should represent the account ID of the child seat buyer.
* @param UserList $postBody
* @param array $optParams Optional parameters.
* @return UserList
* @throws \Google\Service\Exception
*/
public function create($parent, UserList $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], UserList::class);
}
/**
* Gets a user list by its name. (userLists.get)
*
* @param string $name Required. The name of the user list to be retrieved. See
* UserList.name.
* @param array $optParams Optional parameters.
* @return UserList
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], UserList::class);
}
/**
* This has been sunset as of October 2023, and will return an error response if
* called. For more information, see the release notes:
* https://developers.google.com/authorized-buyers/apis/relnotes#real-time-
* bidding-api Gets remarketing tag for a buyer. A remarketing tag is a piece of
* JavaScript code that can be placed on a web page. When a user visits a page
* containing a remarketing tag, Google adds the user to a user list.
* (userLists.getRemarketingTag)
*
* @param string $name Required. To fetch the remarketing tag for an account,
* the name must follow the pattern `buyers/{accountId}`, where `{accountId}`
* represents the ID of the buyer that owns the remarketing tag. For a bidder
* accessing the remarketing tag on behalf of a child seat buyer, `{accountId}`
* should represent the ID of the child seat buyer. To fetch the remarketing tag
* for a specific user list, the name must follow the pattern
* `buyers/{accountId}/userLists/{userListId}`. See UserList.name.
* @param array $optParams Optional parameters.
* @return GetRemarketingTagResponse
* @throws \Google\Service\Exception
*/
public function getRemarketingTag($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('getRemarketingTag', [$params], GetRemarketingTagResponse::class);
}
/**
* Lists the user lists visible to the current user.
* (userLists.listBuyersUserLists)
*
* @param string $parent Required. The name of the parent buyer for the user
* lists to be returned that must follow the pattern `buyers/{buyerAccountId}`,
* where `{buyerAccountId}` represents the account ID of the buyer who owns user
* lists. For a bidder accessing user lists on behalf of a child seat buyer ,
* `{buyerAccountId}` should represent the account ID of the child seat buyer.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The number of results to return per page.
* @opt_param string pageToken Continuation page token as received from a
* previous response.
* @return ListUserListsResponse
* @throws \Google\Service\Exception
*/
public function listBuyersUserLists($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListUserListsResponse::class);
}
/**
* Changes the status of a user list to OPEN. This allows new users to be added
* to the user list. (userLists.open)
*
* @param string $name Required. The name of the user list to open. See
* UserList.name
* @param OpenUserListRequest $postBody
* @param array $optParams Optional parameters.
* @return UserList
* @throws \Google\Service\Exception
*/
public function open($name, OpenUserListRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('open', [$params], UserList::class);
}
/**
* Updates the given user list. Only user lists with URLRestrictions can be
* updated. (userLists.update)
*
* @param string $name Output only. Name of the user list that must follow the
* pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents
* the account ID of the buyer who owns the user list. For a bidder accessing
* user lists on behalf of a child seat buyer, `{buyer}` represents the account
* ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by
* Google to uniquely identify a user list.
* @param UserList $postBody
* @param array $optParams Optional parameters.
* @return UserList
* @throws \Google\Service\Exception
*/
public function update($name, UserList $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], UserList::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BuyersUserLists::class, 'Google_Service_RealTimeBidding_Resource_BuyersUserLists');