com.google.api.ads.dfp.axis.v201306

Interface ContentBundleServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ContentBundleServiceSoapBindingStub

public interface ContentBundleServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
ContentBundle	createContentBundle(ContentBundle contentBundle) Creates a new ContentBundle.
ContentBundle[]	createContentBundles(ContentBundle[] contentBundles) Creates new ContentBundle objects.
ContentBundle	getContentBundle(Long contentBundleId) Returns the ContentBundle uniquely identified by the given ID.
ContentBundlePage	getContentBundlesByStatement(Statement filterStatement) Gets a ContentBundlePage of ContentBundle objects that satisfy the given Statement.query.
UpdateResult	performContentBundleAction(ContentBundleAction contentBundleAction, Statement filterStatement) Performs actions on ContentBundle objects that match the given Statement.query.
ContentBundle	updateContentBundle(ContentBundle contentBundle) Updates the specified ContentBundle.
ContentBundle[]	updateContentBundles(ContentBundle[] contentBundles) Updates the specified ContentBundle objects.

Method Detail

createContentBundle

ContentBundle createContentBundle(ContentBundle contentBundle)
                                  throws RemoteException,
                                         ApiException

Creates a new ContentBundle. These fields are required:

• ContentBundle.name
• ContentBundle.description

Parameters:

contentBundle - the content bundle to create

Returns:

the content bundle with its ID filled in

Throws:

RemoteException

ApiException

createContentBundles

ContentBundle[] createContentBundles(ContentBundle[] contentBundles)
                                     throws RemoteException,
                                            ApiException

Creates new ContentBundle objects.

Parameters:

contentBundles - the content bundles to create

Returns:

the created content bundles with their IDs filled in

Throws:

RemoteException

ApiException

getContentBundle

ContentBundle getContentBundle(Long contentBundleId)
                               throws RemoteException,
                                      ApiException

Returns the ContentBundle uniquely identified by the given ID.

Parameters:

contentBundleId - the ID of the content bundle, which must already exist

Returns:

the ContentBundle uniquely identified by the given ID

Throws:

ApiException - if there were errors, such as invalid ID

RemoteException

getContentBundlesByStatement

ContentBundlePage getContentBundlesByStatement(Statement filterStatement)
                                               throws RemoteException,
                                                      ApiException

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

PQL Property	Object Property
id	ContentBundle.id
name	ContentBundle.name
status	ContentBundle.status

Parameters:

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

Returns:

the content bundles that match the given filter

Throws:

RemoteException

ApiException

performContentBundleAction

UpdateResult performContentBundleAction(ContentBundleAction contentBundleAction,
                                      Statement filterStatement)
                                        throws RemoteException,
                                               ApiException

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

Parameters:

contentBundleAction - the action to perform

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateContentBundle

ContentBundle updateContentBundle(ContentBundle contentBundle)
                                  throws RemoteException,
                                         ApiException

Updates the specified ContentBundle.

Parameters:

contentBundle - the content bundle to update

Returns:

the updated content bundle

Throws:

RemoteException

ApiException

updateContentBundles

ContentBundle[] updateContentBundles(ContentBundle[] contentBundles)
                                     throws RemoteException,
                                            ApiException

Updates the specified ContentBundle objects.

Parameters:

contentBundles - the content bundles to update

Returns:

the updated content bundles

Throws:

RemoteException

ApiException