com.google.api.services.displayvideo.v4

Class DisplayVideo.Advertisers.Campaigns

java.lang.Object

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

Enclosing class:

DisplayVideo.Advertisers

public class DisplayVideo.Advertisers.Campaigns
extends Object

The "campaigns" collection of methods.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Campaigns()

Method Summary

Modifier and Type	Method and Description
DisplayVideo.Advertisers.Campaigns.Create	create(Long advertiserId, Campaign content) Creates a new campaign.
DisplayVideo.Advertisers.Campaigns.Delete	delete(Long advertiserId, Long campaignId) Permanently deletes a campaign.
DisplayVideo.Advertisers.Campaigns.Get	get(Long advertiserId, Long campaignId) Gets a campaign.
DisplayVideo.Advertisers.Campaigns.List	list(Long advertiserId) Lists campaigns in an advertiser.
DisplayVideo.Advertisers.Campaigns.Patch	patch(Long advertiserId, Long campaignId, Campaign content) Updates an existing campaign.

Methods inherited from class java.lang.Object

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

Constructor Detail

Campaigns

public Campaigns()

Method Detail

create

public DisplayVideo.Advertisers.Campaigns.Create create(Long advertiserId,
                                                        Campaign content)
                                                 throws IOException

Creates a new campaign. Returns the newly created campaign if successful. Create a request for the method "campaigns.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 campaign belongs to.

content - the Campaign

Returns:

the request

Throws:

IOException

delete

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

Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **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 "campaigns.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 campaign belongs to.

campaignId - The ID of the campaign we need to delete.

Returns:

the request

Throws:

IOException

get

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

Gets a campaign. Create a request for the method "campaigns.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 campaign belongs to.

campaignId - Required. The ID of the campaign to fetch.

Returns:

the request

Throws:

IOException

list

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

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

Returns:

the request

Throws:

IOException

patch

public DisplayVideo.Advertisers.Campaigns.Patch patch(Long advertiserId,
                                                      Long campaignId,
                                                      Campaign content)
                                               throws IOException

Updates an existing campaign. Returns the updated campaign if successful. Create a request for the method "campaigns.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 campaign belongs to.

campaignId - Output only. The unique ID of the campaign. Assigned by the system.

content - the Campaign

Returns:

the request

Throws:

IOException