com.google.api.ads.dfp.axis.v201708

Interface ProductTemplateServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ProductTemplateServiceSoapBindingStub

public interface ProductTemplateServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
ProductTemplate[]	createProductTemplates(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.
ProductTemplate[]	updateProductTemplates(ProductTemplate[] productTemplates) Updates the specified ProductTemplate objects.

Method Detail

createProductTemplates

ProductTemplate[] createProductTemplates(ProductTemplate[] productTemplates)
                                  throws RemoteException,
                                         ApiException

Creates new ProductTemplate objects.

Parameters:

productTemplates - the productTemplates to create

Returns:

the persisted product templates with their Ids filled in

Throws:

RemoteException

ApiException

getProductTemplatesByStatement

ProductTemplatePage getProductTemplatesByStatement(Statement statement)
                                            throws RemoteException,
                                                   ApiException

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

Returns:

the productTemplates that match the given statement

Throws:

RemoteException

ApiException

performProductTemplateAction

UpdateResult performProductTemplateAction(ProductTemplateAction action,
                                          Statement filterStatement)
                                   throws RemoteException,
                                          ApiException

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateProductTemplates

ProductTemplate[] updateProductTemplates(ProductTemplate[] productTemplates)
                                  throws RemoteException,
                                         ApiException

Updates the specified ProductTemplate objects.

Parameters:

productTemplates - the product templates to update

Returns:

the updated product templates

Throws:

RemoteException

ApiException