117 lines
5.1 KiB
PHP
Executable File
117 lines
5.1 KiB
PHP
Executable File
<?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\DisplayVideo\Resource;
|
|
|
|
use Google\Service\DisplayVideo\CustomBiddingScript;
|
|
use Google\Service\DisplayVideo\ListCustomBiddingScriptsResponse;
|
|
|
|
/**
|
|
* The "scripts" collection of methods.
|
|
* Typical usage is:
|
|
* <code>
|
|
* $displayvideoService = new Google\Service\DisplayVideo(...);
|
|
* $scripts = $displayvideoService->customBiddingAlgorithms_scripts;
|
|
* </code>
|
|
*/
|
|
class CustomBiddingAlgorithmsScripts extends \Google\Service\Resource
|
|
{
|
|
/**
|
|
* Creates a new custom bidding script. Returns the newly created script if
|
|
* successful. (scripts.create)
|
|
*
|
|
* @param string $customBiddingAlgorithmId Required. The ID of the custom
|
|
* bidding algorithm that owns the script.
|
|
* @param CustomBiddingScript $postBody
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string advertiserId The ID of the advertiser that owns the parent
|
|
* custom bidding algorithm.
|
|
* @opt_param string partnerId The ID of the partner that owns the parent custom
|
|
* bidding algorithm. Only this partner will have write access to this custom
|
|
* bidding script.
|
|
* @return CustomBiddingScript
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function create($customBiddingAlgorithmId, CustomBiddingScript $postBody, $optParams = [])
|
|
{
|
|
$params = ['customBiddingAlgorithmId' => $customBiddingAlgorithmId, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('create', [$params], CustomBiddingScript::class);
|
|
}
|
|
/**
|
|
* Gets a custom bidding script. (scripts.get)
|
|
*
|
|
* @param string $customBiddingAlgorithmId Required. The ID of the custom
|
|
* bidding algorithm owns the script.
|
|
* @param string $customBiddingScriptId Required. The ID of the custom bidding
|
|
* script to fetch.
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string advertiserId The ID of the advertiser that owns the parent
|
|
* custom bidding algorithm.
|
|
* @opt_param string partnerId The ID of the partner that owns the parent custom
|
|
* bidding algorithm. Only this partner will have write access to this custom
|
|
* bidding script.
|
|
* @return CustomBiddingScript
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function get($customBiddingAlgorithmId, $customBiddingScriptId, $optParams = [])
|
|
{
|
|
$params = ['customBiddingAlgorithmId' => $customBiddingAlgorithmId, 'customBiddingScriptId' => $customBiddingScriptId];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('get', [$params], CustomBiddingScript::class);
|
|
}
|
|
/**
|
|
* Lists custom bidding scripts that belong to the given algorithm. The order is
|
|
* defined by the order_by parameter.
|
|
* (scripts.listCustomBiddingAlgorithmsScripts)
|
|
*
|
|
* @param string $customBiddingAlgorithmId Required. The ID of the custom
|
|
* bidding algorithm owns the script.
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string advertiserId The ID of the advertiser that owns the parent
|
|
* custom bidding algorithm.
|
|
* @opt_param string orderBy Field by which to sort the list. Acceptable values
|
|
* are: * `createTime desc` (default) The default sorting order is descending.
|
|
* To specify ascending order for a field, the suffix "desc" should be removed.
|
|
* Example: `createTime`.
|
|
* @opt_param int pageSize Requested page size. Must be between `1` and `200`.
|
|
* If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT`
|
|
* if an invalid value is specified.
|
|
* @opt_param string pageToken A token identifying a page of results the server
|
|
* should return. Typically, this is the value of next_page_token returned from
|
|
* the previous call to `ListCustomBiddingScripts` method. If not specified, the
|
|
* first page of results will be returned.
|
|
* @opt_param string partnerId The ID of the partner that owns the parent custom
|
|
* bidding algorithm. Only this partner will have write access to this custom
|
|
* bidding script.
|
|
* @return ListCustomBiddingScriptsResponse
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function listCustomBiddingAlgorithmsScripts($customBiddingAlgorithmId, $optParams = [])
|
|
{
|
|
$params = ['customBiddingAlgorithmId' => $customBiddingAlgorithmId];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('list', [$params], ListCustomBiddingScriptsResponse::class);
|
|
}
|
|
}
|
|
|
|
// Adding a class alias for backwards compatibility with the previous class name.
|
|
class_alias(CustomBiddingAlgorithmsScripts::class, 'Google_Service_DisplayVideo_Resource_CustomBiddingAlgorithmsScripts');
|