com.google.api.ads.dfp.axis.v201306

Interface CreativeWrapperServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

CreativeWrapperServiceSoapBindingStub

public interface CreativeWrapperServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
CreativeWrapper	createCreativeWrapper(CreativeWrapper creativeWrapper) Creates a new CreativeWrapper.
CreativeWrapper[]	createCreativeWrappers(CreativeWrapper[] creativeWrappers) Creates a new CreativeWrapper objects.
CreativeWrapper	getCreativeWrapper(Long creativeWrapperId) Returns the CreativeWrapper uniquely identified by the given ID.
CreativeWrapperPage	getCreativeWrappersByStatement(Statement filterStatement) Gets a CreativeWrapperPage of CreativeWrapper objects that satisfy the given Statement.query.
UpdateResult	performCreativeWrapperAction(CreativeWrapperAction creativeWrapperAction, Statement filterStatement) Performs actions on CreativeWrapper objects that match the given Statement.query.
CreativeWrapper	updateCreativeWrapper(CreativeWrapper creativeWrapper) Updates the specified CreativeWrapper.
CreativeWrapper[]	updateCreativeWrappers(CreativeWrapper[] creativeWrappers) Updates the specified CreativeWrapper objects.

Method Detail

createCreativeWrapper

CreativeWrapper createCreativeWrapper(CreativeWrapper creativeWrapper)
                                      throws RemoteException,
                                             ApiException

Creates a new CreativeWrapper. The following fields are required:

• CreativeWrapper.labelId
• CreativeWrapper.ordering
• CreativeWrapper.header or CreativeWrapper.footer

Parameters:

creativeWrapper - the creative wrapper to create

Returns:

the creative wrapper with its ID filled in

Throws:

ApiException

RemoteException

createCreativeWrappers

CreativeWrapper[] createCreativeWrappers(CreativeWrapper[] creativeWrappers)
                                         throws RemoteException,
                                                ApiException

Creates a new CreativeWrapper objects. The following fields are required:

• CreativeWrapper.labelId
• CreativeWrapper.ordering
• CreativeWrapper.header or CreativeWrapper.footer

Parameters:

creativeWrappers - the creative wrappers to create

Returns:

the creative wrappers with their IDs filled in

Throws:

ApiException

RemoteException

getCreativeWrapper

CreativeWrapper getCreativeWrapper(Long creativeWrapperId)
                                   throws RemoteException,
                                          ApiException

Returns the CreativeWrapper uniquely identified by the given ID.

Parameters:

creativeWrapperId - the ID of the creative wrapper, which must already exist

Returns:

the CreativeWrapper uniquely identified by the given ID

Throws:

ApiException

RemoteException

getCreativeWrappersByStatement

CreativeWrapperPage getCreativeWrappersByStatement(Statement filterStatement)
                                                   throws RemoteException,
                                                          ApiException

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

PQL Property	Object Property
id	CreativeWrapper.id
labelId	CreativeWrapper.labelId
status	CreativeWrapper.status
ordering	CreativeWrapper.ordering

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of creative wrappers.

Returns:

the creative wrappers that match the given filter

Throws:

RemoteException

ApiException

performCreativeWrapperAction

UpdateResult performCreativeWrapperAction(CreativeWrapperAction creativeWrapperAction,
                                        Statement filterStatement)
                                          throws RemoteException,
                                                 ApiException

Performs actions on CreativeWrapper objects that match the given Statement.query.

Parameters:

creativeWrapperAction - the action to perform

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateCreativeWrapper

CreativeWrapper updateCreativeWrapper(CreativeWrapper creativeWrapper)
                                      throws RemoteException,
                                             ApiException

Updates the specified CreativeWrapper.

Parameters:

creativeWrapper - the creative wrapper to update

Returns:

the updated creative wrapper

Throws:

ApiException

RemoteException

updateCreativeWrappers

CreativeWrapper[] updateCreativeWrappers(CreativeWrapper[] creativeWrappers)
                                         throws RemoteException,
                                                ApiException

Updates the specified CreativeWrapper objects.

Parameters:

creativeWrappers - the creative wrappers to update

Returns:

the updated creative wrapper objects

Throws:

ApiException

RemoteException