com.google.api.services.displayvideo.v2

Class DisplayVideo.Advertisers.Creatives

java.lang.Object

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

Enclosing class:

DisplayVideo.Advertisers

public class DisplayVideo.Advertisers.Creatives
extends Object

The "creatives" collection of methods.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Creatives()

Method Summary

Modifier and Type	Method and Description
DisplayVideo.Advertisers.Creatives.Create	create(Long advertiserId, Creative content) Creates a new creative.
DisplayVideo.Advertisers.Creatives.Delete	delete(Long advertiserId, Long creativeId) Deletes a creative.
DisplayVideo.Advertisers.Creatives.Get	get(Long advertiserId, Long creativeId) Gets a creative.
DisplayVideo.Advertisers.Creatives.List	list(Long advertiserId) Lists creatives in an advertiser.
DisplayVideo.Advertisers.Creatives.Patch	patch(Long advertiserId, Long creativeId, Creative content) Updates an existing creative.

Methods inherited from class java.lang.Object

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

Constructor Detail

Creatives

public Creatives()

Method Detail

create

public DisplayVideo.Advertisers.Creatives.Create create(Long advertiserId,
                                                        Creative content)
                                                 throws IOException

Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. Create a request for the method "creatives.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 creative belongs to.

content - the Creative

Returns:

the request

Throws:

IOException

delete

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

Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. Create a request for the method "creatives.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 creative belongs to.

creativeId - The ID of the creative to be deleted.

Returns:

the request

Throws:

IOException

get

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

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

creativeId - Required. The ID of the creative to fetch.

Returns:

the request

Throws:

IOException

list

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

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

Returns:

the request

Throws:

IOException

patch

public DisplayVideo.Advertisers.Creatives.Patch patch(Long advertiserId,
                                                      Long creativeId,
                                                      Creative content)
                                               throws IOException

Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. Create a request for the method "creatives.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 creative belongs to.

creativeId - Output only. The unique ID of the creative. Assigned by the system.

content - the Creative

Returns:

the request

Throws:

IOException