com.google.api.ads.dfp.axis.v201306

Interface ProductServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ProductServiceSoapBindingStub

public interface ProductServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
Product	getProduct(String productId) Returns the Product uniquely identified by the given ID.
ProductPage	getProductsByStatement(Statement statement) Gets a ProductPage of Product objects that satisfy the criteria specified by given Statement.query.
UpdateResult	performProductAction(ProductAction productAction, Statement filterStatement) Performs action on Product objects that satisfy the given Statement.
Product	updateProduct(Product product) Updates the specified Product.
Product[]	updateProducts(Product[] products) Updates the specified Product objects.

Method Detail

getProduct

Product getProduct(String productId)
                   throws RemoteException,
                          ApiException

Returns the Product uniquely identified by the given ID.

Parameters:

productId - the ID of the product, which must already exist

Returns:

the Product uniquely identified by ID

Throws:

RemoteException

ApiException

getProductsByStatement

ProductPage getProductsByStatement(Statement statement)
                                   throws RemoteException,
                                          ApiException

Gets a ProductPage of Product objects that satisfy the criteria specified by given Statement.query. The following fields are supported for filtering and/or sorting:

PQL Property	Object Property	Filterable	Sortable
rateCardId	Rate card ID which the product is associated with	Yes	No
status	Product.status	Yes	Yes
lineItemType	Product.lineItemType	Yes	Yes
productType	Product.productType	Yes	Yes
rateType	Product.rateType	Yes	Yes
productTemplateId	Product.productTemplateId	Yes	No
name	Product.name	Yes	Yes
description	Product#description	Yes	No
id	Product.id	Yes	No
lastModifiedDateTime	Product.lastModifiedDateTime	No	Yes

Parameters:

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

Returns:

the products that match the given statement

Throws:

RemoteException

ApiException

performProductAction

UpdateResult performProductAction(ProductAction productAction,
                                Statement filterStatement)
                                  throws RemoteException,
                                         ApiException

Performs action on Product objects that satisfy the given Statement.

Parameters:

productAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of products.

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateProduct

Product updateProduct(Product product)
                      throws RemoteException,
                             ApiException

Updates the specified Product. Note non-updatable fields will not be backfilled.

Parameters:

product - the product to update

Returns:

the updated product

Throws:

RemoteException

ApiException

updateProducts

Product[] updateProducts(Product[] products)
                         throws RemoteException,
                                ApiException

Updates the specified Product objects. Note non-updatable fields will not be backfilled.

Parameters:

products - the products to update

Returns:

the updated products

Throws:

RemoteException

ApiException