com.google.api.ads.dfp.axis.v201302

Interface CreativeServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

CreativeServiceSoapBindingStub

public interface CreativeServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
Creative	createCreative(Creative creative) Creates a new Creative.
Creative[]	createCreatives(Creative[] creatives) Creates new Creative objects.
Creative	getCreative(Long creativeId) Returns the Creative uniquely identified by the given ID.
CreativePage	getCreativesByStatement(Statement filterStatement) Gets a CreativePage of Creative objects that satisfy the given Statement.query.
Creative	updateCreative(Creative creative) Updates the specified Creative.
Creative[]	updateCreatives(Creative[] creatives) Updates the specified Creative objects.

Method Detail

createCreative

Creative createCreative(Creative creative)
                        throws RemoteException,
                               ApiException

Creates a new Creative. The following fields are required along with the required fields of the sub-class:

• Creative.advertiserId
• Creative.name
• Creative.size

Parameters:

creative - the creative to create

Returns:

the new creative with its ID set

Throws:

RemoteException

ApiException

createCreatives

Creative[] createCreatives(Creative[] creatives)
                           throws RemoteException,
                                  ApiException

Creates new Creative objects.

Parameters:

creatives - the creatives to create

Returns:

the created creatives with their IDs filled in

Throws:

RemoteException

ApiException

getCreative

Creative getCreative(Long creativeId)
                     throws RemoteException,
                            ApiException

Returns the Creative uniquely identified by the given ID.

Parameters:

creativeId - the ID of the creative, which must already exist

Returns:

the Creative uniquely identified by the given ID

Throws:

RemoteException

ApiException

getCreativesByStatement

CreativePage getCreativesByStatement(Statement filterStatement)
                                     throws RemoteException,
                                            ApiException

Gets a CreativePage of Creative objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	Creative.id
name	Creative.name
advertiserId	Creative.advertiserId
width	Creative.size
height	Creative.size
lastModifiedDateTime	Creative.lastModifiedDateTime

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of creatives

Returns:

the creatives that match the given filter

Throws:

RemoteException

ApiException

updateCreative

Creative updateCreative(Creative creative)
                        throws RemoteException,
                               ApiException

Updates the specified Creative.

Parameters:

creative - the creative to update

Returns:

the updated creative

Throws:

RemoteException

ApiException

updateCreatives

Creative[] updateCreatives(Creative[] creatives)
                           throws RemoteException,
                                  ApiException

Updates the specified Creative objects.

Parameters:

creatives - the creatives to update

Returns:

the updated creatives

Throws:

RemoteException

ApiException