com.google.api.ads.dfp.jaxws.v201708

Interface ProductTemplateServiceInterface

public interface ProductTemplateServiceInterface

Provides methods for creating, updating and retrieving ProductTemplate objects.

A product template is used to generate a set of products. Products allow inventory managers to control what salespeople can sell.

To use this service, you need to have the new sales management solution enabled on your network. If you do not see a "Sales" tab in DoubleClick for Publishers (DFP), you will not be able to use this service. 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<ProductTemplate>	createProductTemplates(List<ProductTemplate> productTemplates) Creates new ProductTemplate objects.
ProductTemplatePage	getProductTemplatesByStatement(Statement statement) Gets a ProductTemplatePage of ProductTemplate objects that satisfy the filtering criteria specified by given Statement.query.
UpdateResult	performProductTemplateAction(ProductTemplateAction action, Statement filterStatement) Performs action on ProductTemplate objects that satisfy the given Statement.query.
List<ProductTemplate>	updateProductTemplates(List<ProductTemplate> productTemplates) Updates the specified ProductTemplate objects.

Method Detail

createProductTemplates

@RequestWrapper(localName="createProductTemplates",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.ProductTemplateServiceInterfacecreateProductTemplates")
 @ResponseWrapper(localName="createProductTemplatesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.ProductTemplateServiceInterfacecreateProductTemplatesResponse")
List<ProductTemplate> createProductTemplates(List<ProductTemplate> productTemplates)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Creates new ProductTemplate objects.

Parameters:

productTemplates - the productTemplates to create

productTemplates -

Returns:

the persisted product templates with their Ids filled in

Throws:

ApiException_Exception

getProductTemplatesByStatement

@RequestWrapper(localName="getProductTemplatesByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.ProductTemplateServiceInterfacegetProductTemplatesByStatement")
 @ResponseWrapper(localName="getProductTemplatesByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.ProductTemplateServiceInterfacegetProductTemplatesByStatementResponse")
ProductTemplatePage getProductTemplatesByStatement(Statement statement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

Gets a ProductTemplatePage of ProductTemplate objects that satisfy the filtering criteria specified by given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	ProductTemplate.id
name	ProductTemplate.name
nameMacro	ProductTemplate.nameMacro
description	ProductTemplate.description
status	ProductTemplate.status
lastModifiedDateTime	ProductTemplate.lastModifiedDateTime
lineItemType	LineItemType
productType	ProductType
rateType	RateType

Parameters:

statement - a Publisher Query Language statement which specifies the filtering criteria over productTemplates

statement -

Returns:

the productTemplates that match the given statement

Throws:

ApiException_Exception

performProductTemplateAction

@RequestWrapper(localName="performProductTemplateAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.ProductTemplateServiceInterfaceperformProductTemplateAction")
 @ResponseWrapper(localName="performProductTemplateActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.ProductTemplateServiceInterfaceperformProductTemplateActionResponse")
UpdateResult performProductTemplateAction(ProductTemplateAction action,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException_Exception

Performs action on ProductTemplate objects that satisfy the given Statement.query.

Parameters:

action - the action to perform

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

filterStatement -

action -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateProductTemplates

@RequestWrapper(localName="updateProductTemplates",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                className="com.google.api.ads.dfp.jaxws.v201708.ProductTemplateServiceInterfaceupdateProductTemplates")
 @ResponseWrapper(localName="updateProductTemplatesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201708",
                 className="com.google.api.ads.dfp.jaxws.v201708.ProductTemplateServiceInterfaceupdateProductTemplatesResponse")
List<ProductTemplate> updateProductTemplates(List<ProductTemplate> productTemplates)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Updates the specified ProductTemplate objects.

Parameters:

productTemplates - the product templates to update

productTemplates -

Returns:

the updated product templates

Throws:

ApiException_Exception