com.google.api.services.displayvideo.v4

Class DisplayVideo.Advertisers

java.lang.Object

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

Enclosing class:

DisplayVideo

public class DisplayVideo.Advertisers
extends Object

The "advertisers" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DisplayVideo.Advertisers.AdAssets The "adAssets" collection of methods.
class	DisplayVideo.Advertisers.AdGroupAds The "adGroupAds" collection of methods.
class	DisplayVideo.Advertisers.AdGroups The "adGroups" collection of methods.
class	DisplayVideo.Advertisers.Assets The "assets" collection of methods.
class	DisplayVideo.Advertisers.Audit
class	DisplayVideo.Advertisers.Campaigns The "campaigns" collection of methods.
class	DisplayVideo.Advertisers.Channels The "channels" collection of methods.
class	DisplayVideo.Advertisers.Create
class	DisplayVideo.Advertisers.Creatives The "creatives" collection of methods.
class	DisplayVideo.Advertisers.Delete
class	DisplayVideo.Advertisers.EditAssignedTargetingOptions
class	DisplayVideo.Advertisers.Get
class	DisplayVideo.Advertisers.InsertionOrders The "insertionOrders" collection of methods.
class	DisplayVideo.Advertisers.Invoices The "invoices" collection of methods.
class	DisplayVideo.Advertisers.LineItems The "lineItems" collection of methods.
class	DisplayVideo.Advertisers.List
class	DisplayVideo.Advertisers.ListAssignedTargetingOptions
class	DisplayVideo.Advertisers.LocationLists The "locationLists" collection of methods.
class	DisplayVideo.Advertisers.NegativeKeywordLists The "negativeKeywordLists" collection of methods.
class	DisplayVideo.Advertisers.Patch
class	DisplayVideo.Advertisers.TargetingTypes The "targetingTypes" collection of methods.

Constructor Summary

Constructors

Constructor and Description
Advertisers()

Method Summary

Modifier and Type	Method and Description
DisplayVideo.Advertisers.AdAssets	adAssets() An accessor for creating requests from the AdAssets collection.
DisplayVideo.Advertisers.AdGroupAds	adGroupAds() An accessor for creating requests from the AdGroupAds collection.
DisplayVideo.Advertisers.AdGroups	adGroups() An accessor for creating requests from the AdGroups collection.
DisplayVideo.Advertisers.Assets	assets() An accessor for creating requests from the Assets collection.
DisplayVideo.Advertisers.Audit	audit(Long advertiserId) Audits an advertiser.
DisplayVideo.Advertisers.Campaigns	campaigns() An accessor for creating requests from the Campaigns collection.
DisplayVideo.Advertisers.Channels	channels() An accessor for creating requests from the Channels collection.
DisplayVideo.Advertisers.Create	create(Advertiser content) Creates a new advertiser.
DisplayVideo.Advertisers.Creatives	creatives() An accessor for creating requests from the Creatives collection.
DisplayVideo.Advertisers.Delete	delete(Long advertiserId) Deletes an advertiser.
DisplayVideo.Advertisers.EditAssignedTargetingOptions	editAssignedTargetingOptions(Long advertiserId, BulkEditAdvertiserAssignedTargetingOptionsRequest content) Edits targeting options under a single advertiser.
DisplayVideo.Advertisers.Get	get(Long advertiserId) Gets an advertiser.
DisplayVideo.Advertisers.InsertionOrders	insertionOrders() An accessor for creating requests from the InsertionOrders collection.
DisplayVideo.Advertisers.Invoices	invoices() An accessor for creating requests from the Invoices collection.
DisplayVideo.Advertisers.LineItems	lineItems() An accessor for creating requests from the LineItems collection.
DisplayVideo.Advertisers.List	list() Lists advertisers that are accessible to the current user.
DisplayVideo.Advertisers.ListAssignedTargetingOptions	listAssignedTargetingOptions(Long advertiserId) Lists assigned targeting options of an advertiser across targeting types.
DisplayVideo.Advertisers.LocationLists	locationLists() An accessor for creating requests from the LocationLists collection.
DisplayVideo.Advertisers.NegativeKeywordLists	negativeKeywordLists() An accessor for creating requests from the NegativeKeywordLists collection.
DisplayVideo.Advertisers.Patch	patch(Long advertiserId, Advertiser content) Updates an existing advertiser.
DisplayVideo.Advertisers.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

Advertisers

public Advertisers()

Method Detail

audit

public DisplayVideo.Advertisers.Audit audit(Long advertiserId)
                                     throws IOException

Audits an advertiser. Returns the counts of used entities per resource type under the advertiser provided. Used entities count towards their respective resource limit. See https://support.google.com/displayvideo/answer/6071450. Create a request for the method "advertisers.audit". 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 audit.

Returns:

the request

Throws:

IOException

create

public DisplayVideo.Advertisers.Create create(Advertiser content)
                                       throws IOException

Creates a new advertiser. Returns the newly created advertiser if successful. **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 "advertisers.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 Advertiser

Returns:

the request

Throws:

IOException

delete

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

Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered. Create a request for the method "advertisers.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 we need to delete.

Returns:

the request

Throws:

IOException

editAssignedTargetingOptions

public DisplayVideo.Advertisers.EditAssignedTargetingOptions editAssignedTargetingOptions(Long advertiserId,
                                                                                          BulkEditAdvertiserAssignedTargetingOptionsRequest content)
                                                                                   throws IOException

Edits targeting options under a single advertiser. The operation will delete the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAdvertiserAssignedTargetingOptionsRequest.create_requests . Create a request for the method "advertisers.editAssignedTargetingOptions". 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.

content - the BulkEditAdvertiserAssignedTargetingOptionsRequest

Returns:

the request

Throws:

IOException

get

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

Gets an advertiser. Create a request for the method "advertisers.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 to fetch.

Returns:

the request

Throws:

IOException

list

public DisplayVideo.Advertisers.List list()
                                   throws IOException

Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported. Create a request for the method "advertisers.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

listAssignedTargetingOptions

public DisplayVideo.Advertisers.ListAssignedTargetingOptions listAssignedTargetingOptions(Long advertiserId)
                                                                                   throws IOException

Lists assigned targeting options of an advertiser across targeting types. Create a request for the method "advertisers.listAssignedTargetingOptions". 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 item belongs to.

Returns:

the request

Throws:

IOException

patch

public DisplayVideo.Advertisers.Patch patch(Long advertiserId,
                                            Advertiser content)
                                     throws IOException

Updates an existing advertiser. Returns the updated advertiser if successful. Create a request for the method "advertisers.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. Assigned by the system.

content - the Advertiser

Returns:

the request

Throws:

IOException

adAssets

public DisplayVideo.Advertisers.AdAssets adAssets()

An accessor for creating requests from the AdAssets collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.AdAssets.List request = displayvideo.adAssets().list(parameters ...)
 

Returns:

the resource collection

adGroupAds

public DisplayVideo.Advertisers.AdGroupAds adGroupAds()

An accessor for creating requests from the AdGroupAds collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.AdGroupAds.List request = displayvideo.adGroupAds().list(parameters ...)
 

Returns:

the resource collection

adGroups

public DisplayVideo.Advertisers.AdGroups adGroups()

An accessor for creating requests from the AdGroups collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.AdGroups.List request = displayvideo.adGroups().list(parameters ...)
 

Returns:

the resource collection

assets

public DisplayVideo.Advertisers.Assets assets()

An accessor for creating requests from the Assets collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.Assets.List request = displayvideo.assets().list(parameters ...)
 

Returns:

the resource collection

campaigns

public DisplayVideo.Advertisers.Campaigns campaigns()

An accessor for creating requests from the Campaigns collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.Campaigns.List request = displayvideo.campaigns().list(parameters ...)
 

Returns:

the resource collection

channels

public DisplayVideo.Advertisers.Channels channels()

An accessor for creating requests from the Channels collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.Channels.List request = displayvideo.channels().list(parameters ...)
 

Returns:

the resource collection

creatives

public DisplayVideo.Advertisers.Creatives creatives()

An accessor for creating requests from the Creatives collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.Creatives.List request = displayvideo.creatives().list(parameters ...)
 

Returns:

the resource collection

insertionOrders

public DisplayVideo.Advertisers.InsertionOrders insertionOrders()

An accessor for creating requests from the InsertionOrders collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.InsertionOrders.List request = displayvideo.insertionOrders().list(parameters ...)
 

Returns:

the resource collection

invoices

public DisplayVideo.Advertisers.Invoices invoices()

An accessor for creating requests from the Invoices collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.Invoices.List request = displayvideo.invoices().list(parameters ...)
 

Returns:

the resource collection

lineItems

public DisplayVideo.Advertisers.LineItems lineItems()

An accessor for creating requests from the LineItems collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.LineItems.List request = displayvideo.lineItems().list(parameters ...)
 

Returns:

the resource collection

locationLists

public DisplayVideo.Advertisers.LocationLists locationLists()

An accessor for creating requests from the LocationLists collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.LocationLists.List request = displayvideo.locationLists().list(parameters ...)
 

Returns:

the resource collection

negativeKeywordLists

public DisplayVideo.Advertisers.NegativeKeywordLists negativeKeywordLists()

An accessor for creating requests from the NegativeKeywordLists collection.

The typical use is:

    DisplayVideo displayvideo = new DisplayVideo(...);
    DisplayVideo.NegativeKeywordLists.List request = displayvideo.negativeKeywordLists().list(parameters ...)
 

Returns:

the resource collection

targetingTypes

public DisplayVideo.Advertisers.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