com.google.api.services.displayvideo.v4

Class DisplayVideo.Advertisers.InsertionOrders

java.lang.Object

com.google.api.services.displayvideo.v4.DisplayVideo.Advertisers.InsertionOrders

Enclosing class:

DisplayVideo.Advertisers

public class DisplayVideo.Advertisers.InsertionOrders
extends Object

The "insertionOrders" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DisplayVideo.Advertisers.InsertionOrders.Create
class	DisplayVideo.Advertisers.InsertionOrders.Delete
class	DisplayVideo.Advertisers.InsertionOrders.Get
class	DisplayVideo.Advertisers.InsertionOrders.List
class	DisplayVideo.Advertisers.InsertionOrders.Patch

Constructor Summary

Constructors

Constructor and Description
InsertionOrders()

Method Summary

Modifier and Type	Method and Description
DisplayVideo.Advertisers.InsertionOrders.Create	create(Long advertiserId, InsertionOrder content) Creates a new insertion order.
DisplayVideo.Advertisers.InsertionOrders.Delete	delete(Long advertiserId, Long insertionOrderId) Deletes an insertion order.
DisplayVideo.Advertisers.InsertionOrders.Get	get(Long advertiserId, Long insertionOrderId) Gets an insertion order.
DisplayVideo.Advertisers.InsertionOrders.List	list(Long advertiserId) Lists insertion orders in an advertiser.
DisplayVideo.Advertisers.InsertionOrders.Patch	patch(Long advertiserId, Long insertionOrderId, InsertionOrder content) Updates an existing insertion order.

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertionOrders

public InsertionOrders()

Method Detail

create

public DisplayVideo.Advertisers.InsertionOrders.Create create(Long advertiserId,
                                                              InsertionOrder content)
                                                       throws IOException

Creates a new insertion order. Returns the newly created insertion order if successful. Create a request for the method "insertionOrders.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:

advertiserId - Output only. The unique ID of the advertiser the insertion order belongs to.

content - the InsertionOrder

Returns:

the request

Throws:

IOException

delete

public DisplayVideo.Advertisers.InsertionOrders.Delete delete(Long advertiserId,
                                                              Long insertionOrderId)
                                                       throws IOException

Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. Create a request for the method "insertionOrders.delete". 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:

advertiserId - The ID of the advertiser this insertion order belongs to.

insertionOrderId - The ID of the insertion order to delete.

Returns:

the request

Throws:

IOException

get

public DisplayVideo.Advertisers.InsertionOrders.Get get(Long advertiserId,
                                                        Long insertionOrderId)
                                                 throws IOException

Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. Create a request for the method "insertionOrders.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:

advertiserId - Required. The ID of the advertiser this insertion order belongs to.

insertionOrderId - Required. The ID of the insertion order to fetch.

Returns:

the request

Throws:

IOException

list

public DisplayVideo.Advertisers.InsertionOrders.List list(Long advertiserId)
                                                   throws IOException

Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results. Create a request for the method "insertionOrders.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.

Parameters:

advertiserId - Required. The ID of the advertiser to list insertion orders for.

Returns:

the request

Throws:

IOException

patch

public DisplayVideo.Advertisers.InsertionOrders.Patch patch(Long advertiserId,
                                                            Long insertionOrderId,
                                                            InsertionOrder content)
                                                     throws IOException

Updates an existing insertion order. Returns the updated insertion order if successful. Create a request for the method "insertionOrders.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:

advertiserId - Output only. The unique ID of the advertiser the insertion order belongs to.

insertionOrderId - Output only. The unique ID of the insertion order. Assigned by the system.

content - the InsertionOrder

Returns:

the request

Throws:

IOException