com.google.api.ads.admanager.axis.v201808

Interface CreativeWrapperServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

CreativeWrapperServiceSoapBindingStub

public interface CreativeWrapperServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
CreativeWrapper[]	createCreativeWrappers(CreativeWrapper[] creativeWrappers) Creates a new CreativeWrapper objects.
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[]	updateCreativeWrappers(CreativeWrapper[] creativeWrappers) Updates the specified CreativeWrapper objects.

Method Detail

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

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

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