com.google.api.ads.dfp.jaxws.v201802

Interface AdRuleServiceInterface

public interface AdRuleServiceInterface

Provides methods for creating, updating and retrieving AdRule objects.

Ad rules contain data that the ad server uses to generate a playlist of video ads. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
List<AdRule>	createAdRules(List<AdRule> adRules) Creates new AdRule objects.
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.
List<AdRule>	updateAdRules(List<AdRule> adRules) Updates the specified AdRule objects.

Method Detail

createAdRules

@RequestWrapper(localName="createAdRules",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.AdRuleServiceInterfacecreateAdRules")
 @ResponseWrapper(localName="createAdRulesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.AdRuleServiceInterfacecreateAdRulesResponse")
List<AdRule> createAdRules(List<AdRule> adRules)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Creates new AdRule objects.

Parameters:

adRules - the ad rules to create

adRules -

Returns:

the created ad rules with their IDs filled in

Throws:

ApiException_Exception

getAdRulesByStatement

@RequestWrapper(localName="getAdRulesByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.AdRuleServiceInterfacegetAdRulesByStatement")
 @ResponseWrapper(localName="getAdRulesByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.AdRuleServiceInterfacegetAdRulesByStatementResponse")
AdRulePage getAdRulesByStatement(Statement statement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

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

statement -

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

ApiException_Exception

performAdRuleAction

@RequestWrapper(localName="performAdRuleAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.AdRuleServiceInterfaceperformAdRuleAction")
 @ResponseWrapper(localName="performAdRuleActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.AdRuleServiceInterfaceperformAdRuleActionResponse")
UpdateResult performAdRuleAction(AdRuleAction adRuleAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

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

filterStatement -

adRuleAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateAdRules

@RequestWrapper(localName="updateAdRules",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                className="com.google.api.ads.dfp.jaxws.v201802.AdRuleServiceInterfaceupdateAdRules")
 @ResponseWrapper(localName="updateAdRulesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201802",
                 className="com.google.api.ads.dfp.jaxws.v201802.AdRuleServiceInterfaceupdateAdRulesResponse")
List<AdRule> updateAdRules(List<AdRule> adRules)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Updates the specified AdRule objects.

Parameters:

adRules - the ad rules to update

adRules -

Returns:

the updated ad rules

Throws:

ApiException - if there is an error updating the ad rules

ApiException_Exception