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

Interface PackageServiceInterface

public interface PackageServiceInterface

Provides methods for creating, updating and retrieving Package objects.

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<Package>	createPackages(List<Package> packages) Creates new Package objects.
PackagePage	getPackagesByStatement(Statement filterStatement) Gets a PackagePage of Package objects that satisfy the given Statement.query.
UpdateResult	performPackageAction(PackageAction packageAction, Statement filterStatement) Performs actions on Package objects that match the given Statement.
List<Package>	updatePackages(List<Package> packages) Updates the specified Package objects.

Method Detail

createPackages

@RequestWrapper(localName="createPackages",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.PackageServiceInterfacecreatePackages")
 @ResponseWrapper(localName="createPackagesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.PackageServiceInterfacecreatePackagesResponse")
List<Package> createPackages(List<Package> packages)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Creates new Package objects. For each package, the following fields are required:

• Package.proposalId
• Package.productPackageId
• Package.name

Parameters:

packages - the packages to create

packages -

Returns:

the created packages with their IDs filled in

Throws:

ApiException_Exception

getPackagesByStatement

@RequestWrapper(localName="getPackagesByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.PackageServiceInterfacegetPackagesByStatement")
 @ResponseWrapper(localName="getPackagesByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.PackageServiceInterfacegetPackagesByStatementResponse")
PackagePage getPackagesByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

Gets a PackagePage of Package objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	Package.id
name	Package.name
proposalId	Package.proposalId
productPackageId	Package.productPackageId
isArchived	Package#isArchived
lastModifiedDateTime	Package.lastModifiedDateTime

Parameters:

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

filterStatement -

Returns:

the packages that match the given filter

Throws:

ApiException_Exception

performPackageAction

@RequestWrapper(localName="performPackageAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.PackageServiceInterfaceperformPackageAction")
 @ResponseWrapper(localName="performPackageActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.PackageServiceInterfaceperformPackageActionResponse")
UpdateResult performPackageAction(PackageAction packageAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         throws ApiException_Exception

Performs actions on Package objects that match the given Statement.

Parameters:

packageAction - the action to perform

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

filterStatement -

packageAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updatePackages

@RequestWrapper(localName="updatePackages",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.PackageServiceInterfaceupdatePackages")
 @ResponseWrapper(localName="updatePackagesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.PackageServiceInterfaceupdatePackagesResponse")
List<Package> updatePackages(List<Package> packages)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Updates the specified Package objects.

Parameters:

packages - the packages to update

packages -

Returns:

the updated packages

Throws:

ApiException_Exception