com.google.api.ads.dfp.axis.v201208

Interface CreativeSetServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

CreativeSetServiceSoapBindingStub

public interface CreativeSetServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
CreativeSet	createCreativeSet(CreativeSet creativeSet) Creates a new CreativeSet.
CreativeSet	getCreativeSet(Long creativeSetId) Returns the CreativeSet uniquely identified by the given ID.
CreativeSetPage	getCreativeSetsByStatement(Statement statement) Gets a CreativeSetPage of CreativeSet objects that satisfy the given Statement.query.
CreativeSet	updateCreativeSet(CreativeSet creativeSet) Updates the specified CreativeSet.

Method Detail

createCreativeSet

CreativeSet createCreativeSet(CreativeSet creativeSet)
                              throws RemoteException,
                                     ApiException

Creates a new CreativeSet.

Parameters:

creativeSet - the creative set to create

Returns:

the creative set with its ID filled in

Throws:

RemoteException

ApiException

getCreativeSet

CreativeSet getCreativeSet(Long creativeSetId)
                           throws RemoteException,
                                  ApiException

Returns the CreativeSet uniquely identified by the given ID.

Parameters:

creativeSetId - the ID of the creative set, which must already exist

Returns:

the CreativeSet uniquely identified by the given ID

Throws:

RemoteException

ApiException

getCreativeSetsByStatement

CreativeSetPage getCreativeSetsByStatement(Statement statement)
                                           throws RemoteException,
                                                  ApiException

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

PQL Property	Object Property
id	CreativeSet.id
name	CreativeSet.name
masterCreativeId	CreativeSet.masterCreativeId
lastModifiedDateTime	CreativeSet#lastModifiedDateTime

Parameters:

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

Returns:

the creative sets that match the given filter

Throws:

RemoteException

ApiException

updateCreativeSet

CreativeSet updateCreativeSet(CreativeSet creativeSet)
                              throws RemoteException,
                                     ApiException

Updates the specified CreativeSet.

Parameters:

creativeSet - the creative set to update

Returns:

the updated creative set

Throws:

RemoteException

ApiException