Viewing file:  BiddersPretargetingConfigs.php (11.95 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.
*/
/**
* The "pretargetingConfigs" collection of methods.
* Typical usage is:
* <code>
* $realtimebiddingService = new Google_Service_RealTimeBidding(...);
* $pretargetingConfigs = $realtimebiddingService->pretargetingConfigs;
* </code>
*/
class Google_Service_RealTimeBidding_Resource_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 Google_Service_RealTimeBidding_ActivatePretargetingConfigRequest $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_RealTimeBidding_PretargetingConfig
*/
public function activate($name, Google_Service_RealTimeBidding_ActivatePretargetingConfigRequest $postBody, $optParams = array())
{
$params = array('name' => $name, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('activate', array($params), "Google_Service_RealTimeBidding_PretargetingConfig");
}
/**
* 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 Google_Service_RealTimeBidding_AddTargetedAppsRequest $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_RealTimeBidding_PretargetingConfig
*/
public function addTargetedApps($pretargetingConfig, Google_Service_RealTimeBidding_AddTargetedAppsRequest $postBody, $optParams = array())
{
$params = array('pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('addTargetedApps', array($params), "Google_Service_RealTimeBidding_PretargetingConfig");
}
/**
* 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 Google_Service_RealTimeBidding_AddTargetedPublishersRequest $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_RealTimeBidding_PretargetingConfig
*/
public function addTargetedPublishers($pretargetingConfig, Google_Service_RealTimeBidding_AddTargetedPublishersRequest $postBody, $optParams = array())
{
$params = array('pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('addTargetedPublishers', array($params), "Google_Service_RealTimeBidding_PretargetingConfig");
}
/**
* 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 Google_Service_RealTimeBidding_AddTargetedSitesRequest $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_RealTimeBidding_PretargetingConfig
*/
public function addTargetedSites($pretargetingConfig, Google_Service_RealTimeBidding_AddTargetedSitesRequest $postBody, $optParams = array())
{
$params = array('pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('addTargetedSites', array($params), "Google_Service_RealTimeBidding_PretargetingConfig");
}
/**
* 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 Google_Service_RealTimeBidding_PretargetingConfig $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_RealTimeBidding_PretargetingConfig
*/
public function create($parent, Google_Service_RealTimeBidding_PretargetingConfig $postBody, $optParams = array())
{
$params = array('parent' => $parent, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('create', array($params), "Google_Service_RealTimeBidding_PretargetingConfig");
}
/**
* 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 Google_Service_RealTimeBidding_RealtimebiddingEmpty
*/
public function delete($name, $optParams = array())
{
$params = array('name' => $name);
$params = array_merge($params, $optParams);
return $this->call('delete', array($params), "Google_Service_RealTimeBidding_RealtimebiddingEmpty");
}
/**
* 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 Google_Service_RealTimeBidding_PretargetingConfig
*/
public function get($name, $optParams = array())
{
$params = array('name' => $name);
$params = array_merge($params, $optParams);
return $this->call('get', array($params), "Google_Service_RealTimeBidding_PretargetingConfig");
}
/**
* 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 Google_Service_RealTimeBidding_ListPretargetingConfigsResponse
*/
public function listBiddersPretargetingConfigs($parent, $optParams = array())
{
$params = array('parent' => $parent);
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_RealTimeBidding_ListPretargetingConfigsResponse");
}
/**
* 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 Google_Service_RealTimeBidding_PretargetingConfig $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Field mask to use for partial in-place updates.
* @return Google_Service_RealTimeBidding_PretargetingConfig
*/
public function patch($name, Google_Service_RealTimeBidding_PretargetingConfig $postBody, $optParams = array())
{
$params = array('name' => $name, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('patch', array($params), "Google_Service_RealTimeBidding_PretargetingConfig");
}
/**
* 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 Google_Service_RealTimeBidding_RemoveTargetedAppsRequest $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_RealTimeBidding_PretargetingConfig
*/
public function removeTargetedApps($pretargetingConfig, Google_Service_RealTimeBidding_RemoveTargetedAppsRequest $postBody, $optParams = array())
{
$params = array('pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('removeTargetedApps', array($params), "Google_Service_RealTimeBidding_PretargetingConfig");
}
/**
* 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 Google_Service_RealTimeBidding_RemoveTargetedPublishersRequest $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_RealTimeBidding_PretargetingConfig
*/
public function removeTargetedPublishers($pretargetingConfig, Google_Service_RealTimeBidding_RemoveTargetedPublishersRequest $postBody, $optParams = array())
{
$params = array('pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('removeTargetedPublishers', array($params), "Google_Service_RealTimeBidding_PretargetingConfig");
}
/**
* 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 Google_Service_RealTimeBidding_RemoveTargetedSitesRequest $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_RealTimeBidding_PretargetingConfig
*/
public function removeTargetedSites($pretargetingConfig, Google_Service_RealTimeBidding_RemoveTargetedSitesRequest $postBody, $optParams = array())
{
$params = array('pretargetingConfig' => $pretargetingConfig, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('removeTargetedSites', array($params), "Google_Service_RealTimeBidding_PretargetingConfig");
}
/**
* Suspends a pretargeting configuration. (pretargetingConfigs.suspend)
*
* @param string $name Required. The name of the pretargeting configuration.
* Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}
* @param Google_Service_RealTimeBidding_SuspendPretargetingConfigRequest $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_RealTimeBidding_PretargetingConfig
*/
public function suspend($name, Google_Service_RealTimeBidding_SuspendPretargetingConfigRequest $postBody, $optParams = array())
{
$params = array('name' => $name, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('suspend', array($params), "Google_Service_RealTimeBidding_PretargetingConfig");
}
}
|