com.google.api.ads.admanager.axis.v201808

Interface PackageServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

PackageServiceSoapBindingStub

public interface PackageServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
Package[]	createPackages(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.
Package[]	updatePackages(Package[] packages) Updates the specified Package objects.

Method Detail

createPackages

Package[] createPackages(Package[] packages)
                  throws RemoteException,
                         ApiException

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

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

Parameters:

packages - the packages to create

Returns:

the created packages with their IDs filled in

Throws:

RemoteException

ApiException

getPackagesByStatement

PackagePage getPackagesByStatement(Statement filterStatement)
                            throws RemoteException,
                                   ApiException

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

Returns:

the packages that match the given filter

Throws:

RemoteException

ApiException

performPackageAction

UpdateResult performPackageAction(PackageAction packageAction,
                                  Statement filterStatement)
                           throws RemoteException,
                                  ApiException

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updatePackages

Package[] updatePackages(Package[] packages)
                  throws RemoteException,
                         ApiException

Updates the specified Package objects.

Parameters:

packages - the packages to update

Returns:

the updated packages

Throws:

RemoteException

ApiException