com.google.api.services.displayvideo.v2

Class DisplayVideo.Advertisers.LineItems

java.lang.Object

com.google.api.services.displayvideo.v2.DisplayVideo.Advertisers.LineItems

Enclosing class:

DisplayVideo.Advertisers

public class DisplayVideo.Advertisers.LineItems
extends Object

The "lineItems" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DisplayVideo.Advertisers.LineItems.BulkEditAssignedTargetingOptions
class	DisplayVideo.Advertisers.LineItems.BulkListAssignedTargetingOptions
class	DisplayVideo.Advertisers.LineItems.BulkUpdate
class	DisplayVideo.Advertisers.LineItems.Create
class	DisplayVideo.Advertisers.LineItems.Delete
class	DisplayVideo.Advertisers.LineItems.Duplicate
class	DisplayVideo.Advertisers.LineItems.Get
class	DisplayVideo.Advertisers.LineItems.List
class	DisplayVideo.Advertisers.LineItems.Patch
class	DisplayVideo.Advertisers.LineItems.TargetingTypes The "targetingTypes" collection of methods.

Constructor Summary

Constructors

Constructor and Description
LineItems()

Method Summary

Modifier and Type	Method and Description
DisplayVideo.Advertisers.LineItems.BulkEditAssignedTargetingOptions	bulkEditAssignedTargetingOptions(Long advertiserId, BulkEditAssignedTargetingOptionsRequest content) Bulk edits targeting options under multiple line items.
DisplayVideo.Advertisers.LineItems.BulkListAssignedTargetingOptions	bulkListAssignedTargetingOptions(Long advertiserId) Lists assigned targeting options for multiple line items across targeting types.
DisplayVideo.Advertisers.LineItems.BulkUpdate	bulkUpdate(Long advertiserId, BulkUpdateLineItemsRequest content) Updates multiple line items.
DisplayVideo.Advertisers.LineItems.Create	create(Long advertiserId, LineItem content) Creates a new line item.
DisplayVideo.Advertisers.LineItems.Delete	delete(Long advertiserId, Long lineItemId) Deletes a line item.
DisplayVideo.Advertisers.LineItems.Duplicate	duplicate(Long advertiserId, Long lineItemId, DuplicateLineItemRequest content) Duplicates a line item.
DisplayVideo.Advertisers.LineItems.Get	get(Long advertiserId, Long lineItemId) Gets a line item.
DisplayVideo.Advertisers.LineItems.List	list(Long advertiserId) Lists line items in an advertiser.
DisplayVideo.Advertisers.LineItems.Patch	patch(Long advertiserId, Long lineItemId, LineItem content) Updates an existing line item.
DisplayVideo.Advertisers.LineItems.TargetingTypes	targetingTypes() An accessor for creating requests from the TargetingTypes collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

LineItems

public LineItems()

Method Detail

bulkEditAssignedTargetingOptions

public DisplayVideo.Advertisers.LineItems.BulkEditAssignedTargetingOptions bulkEditAssignedTargetingOptions(Long advertiserId,
                                                                                                            BulkEditAssignedTargetingOptionsRequest content)
                                                                                                     throws IOException

Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. Create a request for the method "lineItems.bulkEditAssignedTargetingOptions". 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 the line items belong to.

content - the BulkEditAssignedTargetingOptionsRequest

Returns:

the request

Throws:

IOException

bulkListAssignedTargetingOptions

public DisplayVideo.Advertisers.LineItems.BulkListAssignedTargetingOptions bulkListAssignedTargetingOptions(Long advertiserId)
                                                                                                     throws IOException

Lists assigned targeting options for multiple line items across targeting types. Create a request for the method "lineItems.bulkListAssignedTargetingOptions". 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 the line items belongs to.

Returns:

the request

Throws:

IOException

bulkUpdate

public DisplayVideo.Advertisers.LineItems.BulkUpdate bulkUpdate(Long advertiserId,
                                                                BulkUpdateLineItemsRequest content)
                                                         throws IOException

Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. Create a request for the method "lineItems.bulkUpdate". 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 line item belongs to.

content - the BulkUpdateLineItemsRequest

Returns:

the request

Throws:

IOException

create

public DisplayVideo.Advertisers.LineItems.Create create(Long advertiserId,
                                                        LineItem content)
                                                 throws IOException

Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API. Create a request for the method "lineItems.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 line item belongs to.

content - the LineItem

Returns:

the request

Throws:

IOException

delete

public DisplayVideo.Advertisers.LineItems.Delete delete(Long advertiserId,
                                                        Long lineItemId)
                                                 throws IOException

Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API. Create a request for the method "lineItems.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 line item belongs to.

lineItemId - The ID of the line item to delete.

Returns:

the request

Throws:

IOException

duplicate

public DisplayVideo.Advertisers.LineItems.Duplicate duplicate(Long advertiserId,
                                                              Long lineItemId,
                                                              DuplicateLineItemRequest content)
                                                       throws IOException

Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best- practices/timeouts#client_library_timeout) to avoid errors. Create a request for the method "lineItems.duplicate". 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 line item belongs to.

lineItemId - Required. The ID of the line item to duplicate.

content - the DuplicateLineItemRequest

Returns:

the request

Throws:

IOException

get

public DisplayVideo.Advertisers.LineItems.Get get(Long advertiserId,
                                                  Long lineItemId)
                                           throws IOException

Gets a line item. Create a request for the method "lineItems.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 line item belongs to.

lineItemId - Required. The ID of the line item to fetch.

Returns:

the request

Throws:

IOException

list

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

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

Returns:

the request

Throws:

IOException

patch

public DisplayVideo.Advertisers.LineItems.Patch patch(Long advertiserId,
                                                      Long lineItemId,
                                                      LineItem content)
                                               throws IOException

Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. Create a request for the method "lineItems.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 line item belongs to.

lineItemId - Output only. The unique ID of the line item. Assigned by the system.

content - the LineItem

Returns:

the request

Throws:

IOException

targetingTypes

public DisplayVideo.Advertisers.LineItems.TargetingTypes targetingTypes()

An accessor for creating requests from the TargetingTypes collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.TargetingTypes.List request = displayvideo.targetingTypes().list(parameters ...)
 

Returns:

the resource collection