com.google.api.ads.admanager.axis.v201711

Interface ProductPackageServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ProductPackageServiceSoapBindingStub

public interface ProductPackageServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
ProductPackage[]	createProductPackages(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.
ProductPackage[]	updateProductPackages(ProductPackage[] productPackages) Updates the specified ProductPackage objects.

Method Detail

createProductPackages

ProductPackage[] createProductPackages(ProductPackage[] productPackages)
                                throws RemoteException,
                                       ApiException

Creates new ProductPackage objects.

Parameters:

productPackages - the product packages to create

Returns:

the persisted product packages with their ID filled in

Throws:

RemoteException

ApiException

getProductPackagesByStatement

ProductPackagePage getProductPackagesByStatement(Statement statement)
                                          throws RemoteException,
                                                 ApiException

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

Returns:

the product packages that match the given statement

Throws:

RemoteException

ApiException

performProductPackageAction

UpdateResult performProductPackageAction(ProductPackageAction action,
                                         Statement statement)
                                  throws RemoteException,
                                         ApiException

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateProductPackages

ProductPackage[] updateProductPackages(ProductPackage[] productPackages)
                                throws RemoteException,
                                       ApiException

Updates the specified ProductPackage objects.

Parameters:

productPackages - the product packages to update

Returns:

the updated product packages

Throws:

RemoteException

ApiException