com.google.api.ads.dfp.axis.v201302

Interface ActivityGroupServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

ActivityGroupServiceSoapBindingStub

public interface ActivityGroupServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
ActivityGroup	createActivityGroup(ActivityGroup activityGroup) Creates a new ActivityGroup.
ActivityGroup[]	createActivityGroups(ActivityGroup[] activityGroups) Creates a new ActivityGroup objects.
ActivityGroup	getActivityGroup(Integer activityGroupId) Returns the ActivityGroup uniquely identified by the given ID.
ActivityGroupPage	getActivityGroupsByStatement(Statement filterStatement) Gets an ActivityGroupPage of ActivityGroup objects that satisfy the given Statement.query.
ActivityGroup	updateActivityGroup(ActivityGroup activityGroup) Updates the specified ActivityGroup.
ActivityGroup[]	updateActivityGroups(ActivityGroup[] activityGroups) Updates the specified ActivityGroup objects.

Method Detail

createActivityGroup

ActivityGroup createActivityGroup(ActivityGroup activityGroup)
                                  throws RemoteException,
                                         ApiException

Creates a new ActivityGroup.

Parameters:

activityGroup - the activity group to be created.

Returns:

the created activity group with its ID filled in.

Throws:

RemoteException

ApiException

createActivityGroups

ActivityGroup[] createActivityGroups(ActivityGroup[] activityGroups)
                                     throws RemoteException,
                                            ApiException

Creates a new ActivityGroup objects.

Parameters:

activityGroups - the activity groups to be created.

Returns:

the created activity groups with their IDs filled in.

Throws:

RemoteException

ApiException

getActivityGroup

ActivityGroup getActivityGroup(Integer activityGroupId)
                               throws RemoteException,
                                      ApiException

Returns the ActivityGroup uniquely identified by the given ID.

Parameters:

activityGroupId - the ID of the activity group, which must already exist.

Returns:

the ActivityGroup uniquely identified by the given ID.

Throws:

RemoteException

ApiException

getActivityGroupsByStatement

ActivityGroupPage getActivityGroupsByStatement(Statement filterStatement)
                                               throws RemoteException,
                                                      ApiException

Gets an ActivityGroupPage of ActivityGroup objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	ActivityGroup.id
name	ActivityGroup.name
impressionsLookback	ActivityGroup.impressionsLookback
clicksLookback	ActivityGroup.clicksLookback
status	ActivityGroup.status

Parameters:

filterStatement - a statement used to filter a set of activity groups

Returns:

the activity groups that match the given filter

Throws:

RemoteException

ApiException

updateActivityGroup

ActivityGroup updateActivityGroup(ActivityGroup activityGroup)
                                  throws RemoteException,
                                         ApiException

Updates the specified ActivityGroup.

Parameters:

activityGroup - the activity group to update.

Returns:

the updated activity group.

Throws:

RemoteException

ApiException

updateActivityGroups

ActivityGroup[] updateActivityGroups(ActivityGroup[] activityGroups)
                                     throws RemoteException,
                                            ApiException

Updates the specified ActivityGroup objects.

Parameters:

activityGroups - the activity groups to update.

Returns:

the updated activity groups.

Throws:

RemoteException

ApiException