FilterService provides operations for managing universal and conditional filters.

• Operations
• WSDL (sandbox)
• WSDL (production)
• About Filters
• Manage Filters

About Filters

Filters allows you to set up preferences to block ads and inventory based on the criteria you specify. This way, you can protect advertisers from serving their ads to undesirable sites and publishers from displaying inappropriate or unwanted ads.

Types of Filters

The platform supports two types of filters:

• Universal - use this filter to create and enforce general policies that apply to your company or entire network.
• Conditional - use these filters to create and enforce individual policies for selected customers.

Universal filters allow you to block ads and inventory for all of your customers. You can also customize filtering for selected customers by setting up conditional filters. Conditional filters allow you to set up restrictions for selected advertisers and publishers, sites, site content topics, audience custom segments, and publisher custom data. The blocking preferences you set for a conditional filter are additive—they work in conjunction with the blocking preferences you set for the universal filter.

Blocking Impact

The blocking impact data object conveys a general sense of the percentage of ad blocking for each of your ad blocking preference. This way, you can estimate the potential impact of a filter.

Manage Filters

FilterService provides operations for creating, activating, updating, retrieving, deactivating, and deleting universal and conditional filters.

Manage Universal Filter

As an exchange member, you can configure the universal filter to protect all of your customers from unwanted ads and inventory. By default, the universal filter allows all ads and inventory to participate in ad serving.

To set up your universal filter, define the filter constraints using the setUniversalFilter operation. You can specify one or more of the ad and inventory filtering criteria in your universal filter.

Note: Universal filters applies to all advertisers and publishers in your network.

To retrieve a universal filter, use the getUniversalFilter operation.

To retrieve the blocking impact for an existing universal filter (for the account in the request), use the getBlockingImpactForExistingUniversalFilter operation and to retrieve the blocking impact for a universal filter (settings), use the getBlockingImpactForUniversalFilter operation.

Manage Conditional Filters

If you are a network, you can configure one or more conditional filters to set filter restrictions for selected advertisers and publishers. A conditional filter is a custom filter, in which you can specify:

• Who the filter is for - whether the filter is created for one or more:
  • Advertisers to protect their ads from serving on undesirable sites
  • Publishers to protect their sites from unwanted ads
  • Sites to prevent unwanted ads
  • Site custom sections and/or custom segments
• Who the filter applies to - from:
  • An advertiser's perspective, ads are blocked for only the specified publishers or sites; all other publishers or sites can serve their ads.
  • A publisher's perspective, only ads from the specified advertisers are blocked; all other advertisers can serve their ads.
• Who is exempt from the filter - from
  • An advertiser's perspective, ads are served only to the specified publishers or sites; all other publishers or sites will not serve their ads.
  • A publisher's perspective, only ads from the specified advertisers are served; all other advertisers cannot serve their ads.

In a conditional filter, created for advertisers, you can specify:

• The publishers and networks to block.
• The targeting attributes—inventory domain, site content topic, site content type, audience geography—to block.

In a conditional filter (created for publishers), you can:

• Specify the advertisers and/or networks to block.
• Specify the targeting attributes—ad content topics, ad themes, ad behaviors, and ad landing page URLs—to block.
• Allow only ads that have been reviewed and block ads that have not completed the offline editorial review process.

You can create, activate, update, retrieve, deactivate, and delete conditional filters.

To create a new conditional filter, use the addConditionalFilter operation and to create a list of conditional filters, use the addConditionalFilters operation. You must assign at least one publisher or site and specify at least one ad blocking preference[/url].

To activate a conditional filter by ID, use the activateConditionalFilter operation and to activate a list of conditional filters by IDs, use the activateConditionalFilters operation. To deactivate a conditional filter by its ID, use the deactivateConditionalFilter operation and to deactivate a list of conditional filters by IDs, use the deactivateConditionalFilters operation.

To modify a conditional filter, use the updateConditionalFilter operation and to modify a list of conditional filters, use the updateConditionalFilters operation.

To delete a conditional filter, use the deleteConditionalFilter operation and to remove a list of conditional filters, use the deleteConditionalFilters operation.

Tip: To temporarily suspend filtering, you can deactivate a filter rather than deleting it.

To retrieve a conditional filter, use the getConditionalFilter operation and retrieve a list of conditional filters, use the getConditionalFilters operation. To retrieve all conditional filters for an account, use the getConditionalFiltersByAccountID operation.

To retrieve the conditional filters applied to a publisher (specified by account ID), use the getConditionalFiltersAppliedToPublisherByAccountID operation and to retrieve the conditional filters applied to a site (specified by ID), use the getConditionalFiltersAppliedToSiteBySiteID operation.

Determine Blocking Impact

To retrieve the blocking impact for an existing universal filter (for the account in the request), use the getBlockingImpactForExistingUniversalFilter operation and to retrieve the blocking impact for a universal filter, use the getBlockingImpactForUniversalFilter operation.

To retrieve the blocking impact for a conditional filter, use the getBlockingImpactForConditionalFilter and to retrieve the blocking impact for a list of conditional filters, use the getBlockingImpactForConditionalFilters operation.

To retrieve the blocking impact for an existing conditional filter (specified by ID), use the getBlockingImpactForExistingConditionalFilter operation and to retrieve the blocking impact for a list of existing conditional filters (specified by IDs), use the getBlockingImpactForExistingConditionalFilters operation.