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

Interface AdRuleServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

AdRuleServiceSoapBindingStub

public interface AdRuleServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
AdRule	createAdRule(AdRule adRule) Creates a new AdRule.
AdRule[]	createAdRules(AdRule[] adRules) Creates new AdRule objects.
AdRule	getAdRule(Integer adRuleId) Returns the AdRule uniquely identified by the given ID.
AdRulePage	getAdRulesByStatement(Statement statement) Gets an AdRulePage of AdRule objects that satisfy the given Statement.query.
UpdateResult	performAdRuleAction(AdRuleAction adRuleAction, Statement filterStatement) Performs actions on AdRule objects that match the given Statement.query.
AdRule	updateAdRule(AdRule adRule) Updates a previously-created AdRule.
AdRule[]	updateAdRules(AdRule[] adRules) Updates the specified AdRule objects.

Method Detail

createAdRule

AdRule createAdRule(AdRule adRule)
                    throws RemoteException,
                           ApiException

Creates a new AdRule. The following fields are required:

• AdRule.id
• AdRule.name
• AdRule.priority
• AdRule.startDateTime
• AdRule.endDateTime
• AdRule.preroll
• AdRule.midroll
• AdRule.postroll

Parameters:

adRule - the ad rule to create

Returns:

the ad rule with its ID filled in

Throws:

ApiException - if there the ad rule is invalid or there is another error

RemoteException

createAdRules

AdRule[] createAdRules(AdRule[] adRules)
                       throws RemoteException,
                              ApiException

Creates new AdRule objects.

Parameters:

adRules - the ad rules to create

Returns:

the created ad rules with their IDs filled in

Throws:

RemoteException

ApiException

getAdRule

AdRule getAdRule(Integer adRuleId)
                 throws RemoteException,
                        ApiException

Returns the AdRule uniquely identified by the given ID.

Parameters:

adRuleId - the ID of the ad rule, which must already exist

Returns:

the AdRule uniquely identified by the given ID

Throws:

ApiException - if there is an error retrieving the ad rule or the ID is invalid

RemoteException

getAdRulesByStatement

AdRulePage getAdRulesByStatement(Statement statement)
                                 throws RemoteException,
                                        ApiException

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

PQL Property	Object Property
id	AdRule.id
name	AdRule.name
priority	AdRule.priority
status	AdRule.status

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of ad rules

Returns:

the ad rules that match the given filter

Throws:

ApiException - if the ID of the active network does not exist or there is a backend error

RemoteException

performAdRuleAction

UpdateResult performAdRuleAction(AdRuleAction adRuleAction,
                               Statement filterStatement)
                                 throws RemoteException,
                                        ApiException

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

Parameters:

adRuleAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of ad rules

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateAdRule

AdRule updateAdRule(AdRule adRule)
                    throws RemoteException,
                           ApiException

Updates a previously-created AdRule.

Parameters:

adRule - the ad rule that should be updated

Returns:

the updated ad rule

Throws:

ApiException - if there is an error updating the ad rule

RemoteException

updateAdRules

AdRule[] updateAdRules(AdRule[] adRules)
                       throws RemoteException,
                              ApiException

Updates the specified AdRule objects.

Parameters:

adRules - the ad rules to update

Returns:

the updated ad rules

Throws:

ApiException - if there is an error updating the ad rules

RemoteException