com.google.api.ads.admanager.axis.v201902

Interface AdRuleServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

AdRuleServiceSoapBindingStub

public interface AdRuleServiceInterface
extends Remote

Method Summary

Modifier and Type	Method and Description
AdRule[]	createAdRules(AdRule[] adRules) Creates new AdRule objects.
AdRulePage	getAdRulesByStatement(Statement statement) Gets an AdRulePage of AdRule objects that satisfy the given Statement.query.
AdSpotPage	getAdSpotsByStatement(Statement filterStatement) Gets a AdSpotPage of AdSpot 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[]	updateAdRules(AdRule[] adRules) Updates the specified AdRule objects.

Method Detail

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

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 (AdRule.adRuleId beginning in v201702)
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

getAdSpotsByStatement

AdSpotPage getAdSpotsByStatement(Statement filterStatement)
                          throws RemoteException,
                                 ApiException

Gets a AdSpotPage of AdSpot objects that satisfy the given Statement.query.

Parameters:

filterStatement - a Publisher Query Language statement to filter a list of ad spots

Returns:

the ad spots that match the filter

Throws:

RemoteException

ApiException

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

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