com.google.api.ads.dfp.jaxws.v201805

Interface CreativeWrapperServiceInterface

public interface CreativeWrapperServiceInterface

Provides methods for the creation and management of creative wrappers. CreativeWrappers allow HTML snippets to be served along with creatives.

Creative wrappers must be associated with a LabelType.CREATIVE_WRAPPER label and applied to ad units by AdUnit.appliedLabels. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

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

Method Detail

createCreativeWrappers

@RequestWrapper(localName="createCreativeWrappers",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.CreativeWrapperServiceInterfacecreateCreativeWrappers")
 @ResponseWrapper(localName="createCreativeWrappersResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.CreativeWrapperServiceInterfacecreateCreativeWrappersResponse")
List<CreativeWrapper> createCreativeWrappers(List<CreativeWrapper> creativeWrappers)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

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

creativeWrappers -

Returns:

the creative wrappers with their IDs filled in

Throws:

ApiException

ApiException_Exception

getCreativeWrappersByStatement

@RequestWrapper(localName="getCreativeWrappersByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.CreativeWrapperServiceInterfacegetCreativeWrappersByStatement")
 @ResponseWrapper(localName="getCreativeWrappersByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.CreativeWrapperServiceInterfacegetCreativeWrappersByStatementResponse")
CreativeWrapperPage getCreativeWrappersByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

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.

filterStatement -

Returns:

the creative wrappers that match the given filter

Throws:

ApiException_Exception

performCreativeWrapperAction

@RequestWrapper(localName="performCreativeWrapperAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.CreativeWrapperServiceInterfaceperformCreativeWrapperAction")
 @ResponseWrapper(localName="performCreativeWrapperActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.CreativeWrapperServiceInterfaceperformCreativeWrapperActionResponse")
UpdateResult performCreativeWrapperAction(CreativeWrapperAction creativeWrapperAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException_Exception

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

filterStatement -

creativeWrapperAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateCreativeWrappers

@RequestWrapper(localName="updateCreativeWrappers",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.CreativeWrapperServiceInterfaceupdateCreativeWrappers")
 @ResponseWrapper(localName="updateCreativeWrappersResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.CreativeWrapperServiceInterfaceupdateCreativeWrappersResponse")
List<CreativeWrapper> updateCreativeWrappers(List<CreativeWrapper> creativeWrappers)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Updates the specified CreativeWrapper objects.

Parameters:

creativeWrappers - the creative wrappers to update

creativeWrappers -

Returns:

the updated creative wrapper objects

Throws:

ApiException

ApiException_Exception