com.google.api.services.displayvideo.v4

Class DisplayVideo.CustomBiddingAlgorithms

java.lang.Object

com.google.api.services.displayvideo.v4.DisplayVideo.CustomBiddingAlgorithms

Enclosing class:

DisplayVideo

public class DisplayVideo.CustomBiddingAlgorithms
extends Object

The "customBiddingAlgorithms" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DisplayVideo.CustomBiddingAlgorithms.Create
class	DisplayVideo.CustomBiddingAlgorithms.Get
class	DisplayVideo.CustomBiddingAlgorithms.List
class	DisplayVideo.CustomBiddingAlgorithms.Patch
class	DisplayVideo.CustomBiddingAlgorithms.Rules The "rules" collection of methods.
class	DisplayVideo.CustomBiddingAlgorithms.Scripts The "scripts" collection of methods.
class	DisplayVideo.CustomBiddingAlgorithms.UploadRules
class	DisplayVideo.CustomBiddingAlgorithms.UploadScript

Constructor Summary

Constructors

Constructor and Description
CustomBiddingAlgorithms()

Method Summary

Modifier and Type	Method and Description
DisplayVideo.CustomBiddingAlgorithms.Create	create(CustomBiddingAlgorithm content) Creates a new custom bidding algorithm.
DisplayVideo.CustomBiddingAlgorithms.Get	get(Long customBiddingAlgorithmId) Gets a custom bidding algorithm.
DisplayVideo.CustomBiddingAlgorithms.List	list() Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies.
DisplayVideo.CustomBiddingAlgorithms.Patch	patch(Long customBiddingAlgorithmId, CustomBiddingAlgorithm content) Updates an existing custom bidding algorithm.
DisplayVideo.CustomBiddingAlgorithms.Rules	rules() An accessor for creating requests from the Rules collection.
DisplayVideo.CustomBiddingAlgorithms.Scripts	scripts() An accessor for creating requests from the Scripts collection.
DisplayVideo.CustomBiddingAlgorithms.UploadRules	uploadRules(Long customBiddingAlgorithmId) Creates a rules reference object for an AlgorithmRules file.
DisplayVideo.CustomBiddingAlgorithms.UploadScript	uploadScript(Long customBiddingAlgorithmId) Creates a custom bidding script reference object for a script file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomBiddingAlgorithms

public CustomBiddingAlgorithms()

Method Detail

create

public DisplayVideo.CustomBiddingAlgorithms.Create create(CustomBiddingAlgorithm content)
                                                   throws IOException

Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful. Create a request for the method "customBiddingAlgorithms.create". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the CustomBiddingAlgorithm

Returns:

the request

Throws:

IOException

get

public DisplayVideo.CustomBiddingAlgorithms.Get get(Long customBiddingAlgorithmId)
                                             throws IOException

Gets a custom bidding algorithm. Create a request for the method "customBiddingAlgorithms.get". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

list

public DisplayVideo.CustomBiddingAlgorithms.List list()
                                               throws IOException

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. Create a request for the method "customBiddingAlgorithms.list". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

patch

public DisplayVideo.CustomBiddingAlgorithms.Patch patch(Long customBiddingAlgorithmId,
                                                        CustomBiddingAlgorithm content)
                                                 throws IOException

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error. Create a request for the method "customBiddingAlgorithms.patch". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the CustomBiddingAlgorithm

Returns:

the request

Throws:

IOException

uploadRules

public DisplayVideo.CustomBiddingAlgorithms.UploadRules uploadRules(Long customBiddingAlgorithmId)
                                                             throws IOException

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. Create a request for the method "customBiddingAlgorithms.uploadRules". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

uploadScript

public DisplayVideo.CustomBiddingAlgorithms.UploadScript uploadScript(Long customBiddingAlgorithmId)
                                                               throws IOException

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. Create a request for the method "customBiddingAlgorithms.uploadScript". This request holds the parameters needed by the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

rules

public DisplayVideo.CustomBiddingAlgorithms.Rules rules()

An accessor for creating requests from the Rules collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.Rules.List request = displayvideo.rules().list(parameters ...)
 

Returns:

the resource collection

scripts

public DisplayVideo.CustomBiddingAlgorithms.Scripts scripts()

An accessor for creating requests from the Scripts collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.Scripts.List request = displayvideo.scripts().list(parameters ...)
 

Returns:

the resource collection