com.google.api.ads.dfp.jaxws.v201802

Interface ProductPackageServiceInterface

public interface ProductPackageServiceInterface

Provides methods for updating and retrieving ProductPackage objects.

A ProductPackage represents a group of products which will be sold together.

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<ProductPackage>	createProductPackages(List<ProductPackage> productPackages) Creates new ProductPackage objects.
ProductPackagePage	getProductPackagesByStatement(Statement statement) Gets a ProductPackagePage of ProductPackage objects that satisfy the filtering criteria specified by given Statement.query.
UpdateResult	performProductPackageAction(ProductPackageAction action, Statement statement) Performs actions on ProductPackage objects that match the given Statement.query.
List<ProductPackage>	updateProductPackages(List<ProductPackage> productPackages) Updates the specified ProductPackage objects.

Method Detail

createProductPackages

@RequestWrapper(localName="createProductPackages",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProductPackageServiceInterfacecreateProductPackages")
 @ResponseWrapper(localName="createProductPackagesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProductPackageServiceInterfacecreateProductPackagesResponse")
List<ProductPackage> createProductPackages(List<ProductPackage> productPackages)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Creates new ProductPackage objects.

Parameters:

productPackages - the product packages to create

productPackages -

Returns:

the persisted product packages with their ID filled in

Throws:

ApiException_Exception

getProductPackagesByStatement

@RequestWrapper(localName="getProductPackagesByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProductPackageServiceInterfacegetProductPackagesByStatement")
 @ResponseWrapper(localName="getProductPackagesByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProductPackageServiceInterfacegetProductPackagesByStatementResponse")
ProductPackagePage getProductPackagesByStatement(Statement statement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

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

PQL Property	Object Property
id	ProductPackage.id
name	ProductPackage.name
notes	ProductPackage.notes
status	ProductPackage.status
isArchived	ProductPackage.isArchived
lastModifiedDateTime	ProductPackage.lastModifiedDateTime

Parameters:

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

statement -

Returns:

the product packages that match the given statement

Throws:

ApiException_Exception

performProductPackageAction

@RequestWrapper(localName="performProductPackageAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProductPackageServiceInterfaceperformProductPackageAction")
 @ResponseWrapper(localName="performProductPackageActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProductPackageServiceInterfaceperformProductPackageActionResponse")
UpdateResult performProductPackageAction(ProductPackageAction action,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 Statement statement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

Performs actions on ProductPackage objects that match the given Statement.query.

Parameters:

action - the action to perform

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

statement -

action -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateProductPackages

@RequestWrapper(localName="updateProductPackages",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.ProductPackageServiceInterfaceupdateProductPackages")
 @ResponseWrapper(localName="updateProductPackagesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.ProductPackageServiceInterfaceupdateProductPackagesResponse")
List<ProductPackage> updateProductPackages(List<ProductPackage> productPackages)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Updates the specified ProductPackage objects.

Parameters:

productPackages - the product packages to update

productPackages -

Returns:

the updated product packages

Throws:

ApiException_Exception