com.google.api.ads.dfp.jaxws.v201805

Interface AdExclusionRuleServiceInterface

public interface AdExclusionRuleServiceInterface

Provides methods for creating, updating and retrieving AdExclusionRule objects.

An AdExclusionRule provides a way to block specified ads from showing on portions of your site. Each rule specifies the inventory on which the rule is in effect, and the labels to block on that inventory. 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<AdExclusionRule>	createAdExclusionRules(List<AdExclusionRule> adExclusionRules) Creates new AdExclusionRule objects.
AdExclusionRulePage	getAdExclusionRulesByStatement(Statement filterStatement) Gets a AdExclusionRulePage of AdExclusionRule objects that satisfy the given Statement.query.
UpdateResult	performAdExclusionRuleAction(AdExclusionRuleAction adExclusionRuleAction, Statement filterStatement) Performs action on AdExclusionRule objects that satisfy the given Statement.query.
List<AdExclusionRule>	updateAdExclusionRules(List<AdExclusionRule> adExclusionRules) Updates the specified AdExclusionRule objects.

Method Detail

createAdExclusionRules

@RequestWrapper(localName="createAdExclusionRules",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.AdExclusionRuleServiceInterfacecreateAdExclusionRules")
 @ResponseWrapper(localName="createAdExclusionRulesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.AdExclusionRuleServiceInterfacecreateAdExclusionRulesResponse")
List<AdExclusionRule> createAdExclusionRules(List<AdExclusionRule> adExclusionRules)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Creates new AdExclusionRule objects.

Parameters:

adExclusionRules - the ad exclusion rules to create

adExclusionRules -

Returns:

the created rules with their IDs filled in

Throws:

ApiException_Exception

getAdExclusionRulesByStatement

@RequestWrapper(localName="getAdExclusionRulesByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.AdExclusionRuleServiceInterfacegetAdExclusionRulesByStatement")
 @ResponseWrapper(localName="getAdExclusionRulesByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.AdExclusionRuleServiceInterfacegetAdExclusionRulesByStatementResponse")
AdExclusionRulePage getAdExclusionRulesByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

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

PQL Property	Object Property
id	AdExclusionRule.id
name	AdExclusionRule.name
status	AdExclusionRule#status

Parameters:

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

filterStatement -

Returns:

the rules that match the given filter

Throws:

ApiException_Exception

performAdExclusionRuleAction

@RequestWrapper(localName="performAdExclusionRuleAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.AdExclusionRuleServiceInterfaceperformAdExclusionRuleAction")
 @ResponseWrapper(localName="performAdExclusionRuleActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.AdExclusionRuleServiceInterfaceperformAdExclusionRuleActionResponse")
UpdateResult performAdExclusionRuleAction(AdExclusionRuleAction adExclusionRuleAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException_Exception

Performs action on AdExclusionRule objects that satisfy the given Statement.query.

Parameters:

adExclusionRuleAction - the action to perform

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

adExclusionRuleAction -

filterStatement -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateAdExclusionRules

@RequestWrapper(localName="updateAdExclusionRules",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                className="com.google.api.ads.dfp.jaxws.v201805.AdExclusionRuleServiceInterfaceupdateAdExclusionRules")
 @ResponseWrapper(localName="updateAdExclusionRulesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201805",
                 className="com.google.api.ads.dfp.jaxws.v201805.AdExclusionRuleServiceInterfaceupdateAdExclusionRulesResponse")
List<AdExclusionRule> updateAdExclusionRules(List<AdExclusionRule> adExclusionRules)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Updates the specified AdExclusionRule objects.

Parameters:

adExclusionRules - the ad exclusion rules to update

adExclusionRules -

Returns:

the updated rules

Throws:

ApiException_Exception