com.google.api.ads.dfp.jaxws.v201711

Interface ProductServiceInterface

public interface ProductServiceInterface

Provides methods for updating and retrieving Product objects.

A Product represents a line item proposal. Products are generated from product templates on a periodic basis using the product template's attributes. Products are typically used by inventory managers to restrict 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<Product>	createProducts(List<Product> products) Creates new Product objects.
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.
List<Product>	updateProducts(List<Product> products) Updates the specified Product objects.

Method Detail

createProducts

@RequestWrapper(localName="createProducts",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.ProductServiceInterfacecreateProducts")
 @ResponseWrapper(localName="createProductsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.ProductServiceInterfacecreateProductsResponse")
List<Product> createProducts(List<Product> products)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Creates new Product objects. This method is only available when creating programmatic guaranteed products when not using sales management.

Parameters:

products - the products to create

products -

Returns:

the created products with their IDs filled in

Throws:

ApiException_Exception

getProductsByStatement

@RequestWrapper(localName="getProductsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.ProductServiceInterfacegetProductsByStatement")
 @ResponseWrapper(localName="getProductsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.ProductServiceInterfacegetProductsByStatementResponse")
ProductPage getProductsByStatement(Statement statement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

Gets a ProductPage of Product objects that satisfy the criteria specified by given Statement.query.

When using sales management, 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	Yes
lastModifiedDateTime	Product.lastModifiedDateTime	Yes	Yes

Parameters:

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

statement -

Returns:

the products that match the given statement

Throws:

ApiException_Exception

performProductAction

@RequestWrapper(localName="performProductAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.ProductServiceInterfaceperformProductAction")
 @ResponseWrapper(localName="performProductActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.ProductServiceInterfaceperformProductActionResponse")
UpdateResult performProductAction(ProductAction productAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         throws ApiException_Exception

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.

filterStatement -

productAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateProducts

@RequestWrapper(localName="updateProducts",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.ProductServiceInterfaceupdateProducts")
 @ResponseWrapper(localName="updateProductsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.ProductServiceInterfaceupdateProductsResponse")
List<Product> updateProducts(List<Product> products)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

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

Parameters:

products - the products to update

products -

Returns:

the updated products

Throws:

ApiException_Exception