Viewing file:  Buyers.php (3.51 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\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
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Buyer::class);
}
/**
* 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 remarketing tag for an account, name
* must follow the pattern `buyers/{accountId}` where `{accountId}` represents
* ID of a buyer that owns the remarketing tag. For a bidder accessing
* remarketing tag on behalf of a child seat buyer, `{accountId}` should
* represent the ID of the child seat buyer. To fetch remarketing tag for a
* specific user list, name must follow the pattern
* `buyers/{accountId}/userLists/{userListId}`. See UserList.name.
* @param array $optParams Optional parameters.
* @return GetRemarketingTagResponse
*/
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
*/
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');
|