AudienceSharingRulesService provides operations for managing audience sharing rules.
- Operations
- WSDL (sandbox)
- WSDL (production)
- About Audience Sharing Rules
- Manage Audience Sharing Rules
About Audience Sharing Rules
An audience sharing rule contains the custom segments and/or custom geographical areas that a publisher wishes to target on another (managed or self-managed) publisher's inventory as part of a guaranteed deal.
Suppose a publisher does not have enough impressions on the publisher's inventory to meet an advertiser's need (to target the publisher's custom audience segments). The publisher can propose a link to another exchange member (a managed or self-managed publisher) to target the publisher's own custom audience segments on the exchange member's inventory. To do this, the publisher must specify the audience segments that the publisher wishes to target in the audience sharing rule included in the guaranteed deal associated with the proposed link. When the exchange member accepts the proposed deal (allowing the publisher to target the publisher's own custom segments and/or custom geographical areas on the exchange member's inventory), the exchange member can set rates and adjustments (in the rate card) for the custom segments and/or custom geographical areas that are part of the active deal.
Use the operations in AudienceSharingRulesService for creating and managing audience sharing rules. Use the operations in CommonTargetingService to retrieve the custom segments and custom geographical areas (that are part of an active deal) and use the operations in RateCardService to set rates and adjustments for the custom segments and custom geographical areas (that are part of an active deal).
Manage Audience Sharing Rules
AudienceSharingRulesService provides operations for adding, updating, retrieving, and deleting audience sharing rules.
Retrieve Targeting Attribute Types for Audience Sharing Rules
To retrieve the list of targeting attribute types that are supported for audience sharing rules, use the getSupportedTargetingAttributeTypes operation.
Create Audience Sharing Rules
To create an audience sharing rule, use the addAudienceSharingRule operation and to create multiple audience sharing rules, use the addAudienceSharingRules operation.
Note: You can specify a mix of custom segments and custom geographical areas in an audience sharing rule.
Update Audience Sharing Rules
To update an audience sharing rule, use the updateAudienceSharingRule operation and to update multiple audience sharing rules, use the updateAudienceSharingRules operation.
Retrieve Audience Sharing Rules
To retrieve an audience sharing rule, use the getAudienceSharingRule operation and to retrieve multiple audience sharing rules, use the getAudienceSharingRules operation. To retrieve the audience sharing rules for an account, use the getAudienceSharingRulesByAccountID operation.
Delete Audience Sharing Rules
To delete an audience sharing rule, use the deleteAudienceSharingRule operation and to delete multiple audience sharing rules, use the deleteAudienceSharingRules operation.
Note: You cannot delete an audience sharing rule that is part of an active deal.