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

Interface ProductPackageItemServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ProductPackageItemServiceSoapBindingStub

public interface ProductPackageItemServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
ProductPackageItem[]	createProductPackageItems(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.
ProductPackageItem[]	updateProductPackageItems(ProductPackageItem[] productPackageItems) Updates the specified ProductPackageItem objects.

Method Detail

createProductPackageItems

ProductPackageItem[] createProductPackageItems(ProductPackageItem[] productPackageItems)
                                        throws RemoteException,
                                               ApiException

Creates new ProductPackageItem objects.

Parameters:

productPackageItems - the product package items to create

Returns:

the created product package items with their IDs filled in

Throws:

RemoteException

ApiException

getProductPackageItemsByStatement

ProductPackageItemPage getProductPackageItemsByStatement(Statement statement)
                                                  throws RemoteException,
                                                         ApiException

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

Returns:

the product package items that match the given statement

Throws:

RemoteException

ApiException

performProductPackageItemAction

UpdateResult performProductPackageItemAction(ProductPackageItemAction productPackageItemAction,
                                             Statement statement)
                                      throws RemoteException,
                                             ApiException

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateProductPackageItems

ProductPackageItem[] updateProductPackageItems(ProductPackageItem[] productPackageItems)
                                        throws RemoteException,
                                               ApiException

Updates the specified ProductPackageItem objects.

Parameters:

productPackageItems - the product package items to update

Returns:

the updated product package items

Throws:

RemoteException

ApiException