class CustomBiddingAlgorithms extends Resource (View source)

The "customBiddingAlgorithms" collection of methods.

Typical usage is:

 $displayvideoService = new Google\Service\DisplayVideo(...);
 $customBiddingAlgorithms = $displayvideoService->customBiddingAlgorithms;

Methods

create(CustomBiddingAlgorithm $postBody, array $optParams = [])

Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful. (customBiddingAlgorithms.create)

get(string $customBiddingAlgorithmId, array $optParams = [])

Gets a custom bidding algorithm. (customBiddingAlgorithms.get)

listCustomBiddingAlgorithms(array $optParams = [])

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)

patch(string $customBiddingAlgorithmId, CustomBiddingAlgorithm $postBody, array $optParams = [])

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. (customBiddingAlgorithms.patch)

uploadRules(string $customBiddingAlgorithmId, array $optParams = [])

Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.

uploadScript(string $customBiddingAlgorithmId, array $optParams = [])

Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object. (customBiddingAlgorithms.uploadScript)

Details

CustomBiddingAlgorithm create(CustomBiddingAlgorithm $postBody, array $optParams = [])

Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful. (customBiddingAlgorithms.create)

Parameters

CustomBiddingAlgorithm $postBody
array $optParams

Optional parameters.

Return Value

CustomBiddingAlgorithm

Exceptions

Exception

CustomBiddingAlgorithm get(string $customBiddingAlgorithmId, array $optParams = [])

Gets a custom bidding algorithm. (customBiddingAlgorithms.get)

Parameters

string $customBiddingAlgorithmId

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

array $optParams

Optional parameters.

Return Value

CustomBiddingAlgorithm

Exceptions

Exception

ListCustomBiddingAlgorithmsResponse listCustomBiddingAlgorithms(array $optParams = [])

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)

Parameters

array $optParams

Optional parameters.

Return Value

ListCustomBiddingAlgorithmsResponse

Exceptions

Exception

CustomBiddingAlgorithm patch(string $customBiddingAlgorithmId, CustomBiddingAlgorithm $postBody, array $optParams = [])

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. (customBiddingAlgorithms.patch)

Parameters

string $customBiddingAlgorithmId

Output only. The unique ID of the custom bidding algorithm. Assigned by the system.

CustomBiddingAlgorithm $postBody
array $optParams

Optional parameters.

Return Value

CustomBiddingAlgorithm

Exceptions

Exception

CustomBiddingAlgorithmRulesRef uploadRules(string $customBiddingAlgorithmId, array $optParams = [])

Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.

(customBiddingAlgorithms.uploadRules)

Parameters

string $customBiddingAlgorithmId

Required. The ID of the custom bidding algorithm that owns the rules resource.

array $optParams

Optional parameters.

Return Value

CustomBiddingAlgorithmRulesRef

Exceptions

Exception

CustomBiddingScriptRef uploadScript(string $customBiddingAlgorithmId, array $optParams = [])

Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object. (customBiddingAlgorithms.uploadScript)

Parameters

string $customBiddingAlgorithmId

Required. The ID of the custom bidding algorithm owns the script.

array $optParams

Optional parameters.

Return Value

CustomBiddingScriptRef

Exceptions

Exception