Documentation

Google_Service_DisplayVideo_Resource_CustomBiddingAlgorithms extends Google_Service_Resource
in package

The "customBiddingAlgorithms" collection of methods.

Typical usage is: $displayvideoService = new Google_Service_DisplayVideo(...); $customBiddingAlgorithms = $displayvideoService->customBiddingAlgorithms;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_DisplayVideo_CustomBiddingAlgorithm
Gets a custom bidding algorithm. (customBiddingAlgorithms.get)
listCustomBiddingAlgorithms()  : Google_Service_DisplayVideo_ListCustomBiddingAlgorithmsResponse
Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter. (customBiddingAlgorithms.listCustomBiddingAlgorithms)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

Gets a custom bidding algorithm. (customBiddingAlgorithms.get)

public get(string $customBiddingAlgorithmId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_CustomBiddingAlgorithm
Parameters
$customBiddingAlgorithmId : string

Required. The ID of the custom bidding algorithm to fetch.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string partnerId The ID of the DV360 partner that has access to the custom bidding algorithm.

opt_param

string advertiserId The ID of the DV360 partner that has access to the custom bidding algorithm.

Return values
Google_Service_DisplayVideo_CustomBiddingAlgorithm —

listCustomBiddingAlgorithms()

Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter. (customBiddingAlgorithms.listCustomBiddingAlgorithms)

public listCustomBiddingAlgorithms([array<string|int, mixed> $optParams = array() ]) : Google_Service_DisplayVideo_ListCustomBiddingAlgorithmsResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND. A sequence of restrictions * implicitly uses AND. * A restriction has the form of {field} {operator} {value}. * The operator must be CONTAINS (:) or EQUALS (=). * The operator must be CONTAINS (:) for the following field:

  • displayName * The operator must be EQUALS (=) for the following field:
  • customBiddingAlgorithmType * For displayName, the value is a string. We return all custom bidding algorithms whose display_name contains such string.
  • For customBiddingAlgorithmType, the value is a string. We return all algorithms whose custom_bidding_algorithm_type is equal to the given type. Examples: * All custom bidding algorithms for which the display name contains "politics": displayName:politics. * All custom bidding algorithms for which the type is "SCRIPT_BASED": customBiddingAlgorithmType=SCRIPT_BASED The length of this field should be no more than 500 characters.
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 ListCustomBiddingAlgorithms method. If not specified, the first page of results will be returned.

opt_param

int pageSize Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

opt_param

string orderBy Field by which to sort the list. Acceptable values are: * displayName (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

opt_param

string partnerId The ID of the DV360 partner that has access to the custom bidding algorithm.

opt_param

string advertiserId The ID of the DV360 advertiser that has access to the custom bidding algorithm.

Return values
Google_Service_DisplayVideo_ListCustomBiddingAlgorithmsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results