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

Interface ProductPackageItemServiceInterface

public interface ProductPackageItemServiceInterface

Provides methods for creating and retrieving ProductPackageItem objects.

A ProductPackageItem represents a product which will be associated with a ProductPackage.

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<ProductPackageItem>	createProductPackageItems(List<ProductPackageItem> productPackageItems) Creates new ProductPackageItem objects.
ProductPackageItemPage	getProductPackageItemsByStatement(Statement statement) Gets a ProductPackageItemPage of ProductPackageItem objects that satisfy the filtering criteria specified by given Statement.query.
UpdateResult	performProductPackageItemAction(ProductPackageItemAction productPackageItemAction, Statement statement) Performs actions on ProductPackageItem objects that satisfy the given Statement.query.
List<ProductPackageItem>	updateProductPackageItems(List<ProductPackageItem> productPackageItems) Updates the specified ProductPackageItem objects.

Method Detail

createProductPackageItems

@RequestWrapper(localName="createProductPackageItems",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.ProductPackageItemServiceInterfacecreateProductPackageItems")
 @ResponseWrapper(localName="createProductPackageItemsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.ProductPackageItemServiceInterfacecreateProductPackageItemsResponse")
List<ProductPackageItem> createProductPackageItems(List<ProductPackageItem> productPackageItems)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Creates new ProductPackageItem objects.

Parameters:

productPackageItems - the product package items to create

productPackageItems -

Returns:

the created product package items with their IDs filled in

Throws:

ApiException_Exception

getProductPackageItemsByStatement

@RequestWrapper(localName="getProductPackageItemsByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.ProductPackageItemServiceInterfacegetProductPackageItemsByStatement")
 @ResponseWrapper(localName="getProductPackageItemsByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.ProductPackageItemServiceInterfacegetProductPackageItemsByStatementResponse")
ProductPackageItemPage getProductPackageItemsByStatement(Statement statement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

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

PQL Property	Object Property
id	ProductPackageItem.id
productPackageId	ProductPackageItem.productPackageId
productId	ProductPackageItem.productId
productTemplateId	ProductPackageItem#productTemplateId
mandatory	ProductPackageItem#mandatory
archived	ProductPackageItem#archived

Parameters:

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

statement -

Returns:

the product package items that match the given statement

Throws:

ApiException_Exception

performProductPackageItemAction

@RequestWrapper(localName="performProductPackageItemAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.ProductPackageItemServiceInterfaceperformProductPackageItemAction")
 @ResponseWrapper(localName="performProductPackageItemActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.ProductPackageItemServiceInterfaceperformProductPackageItemActionResponse")
UpdateResult performProductPackageItemAction(ProductPackageItemAction productPackageItemAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             Statement statement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      throws ApiException_Exception

Performs actions on ProductPackageItem objects that satisfy the given Statement.query.

Parameters:

productPackageItemAction - the action to perform

statement - a Publisher Query Language statement used to filter a set of product package items

statement -

productPackageItemAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateProductPackageItems

@RequestWrapper(localName="updateProductPackageItems",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.ProductPackageItemServiceInterfaceupdateProductPackageItems")
 @ResponseWrapper(localName="updateProductPackageItemsResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.ProductPackageItemServiceInterfaceupdateProductPackageItemsResponse")
List<ProductPackageItem> updateProductPackageItems(List<ProductPackageItem> productPackageItems)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Updates the specified ProductPackageItem objects.

Parameters:

productPackageItems - the product package items to update

productPackageItems -

Returns:

the updated product package items

Throws:

ApiException_Exception