Skip to main content

decentriq_platform.media.exclusion_targeting_audience_builder

Classes​

ExclusionTargetingAudienceBuilder​

ExclusionTargetingAudienceBuilder(
    *,
    name: str,
    source_audience_type: str,
)

Builder for constructing exclusion-targeting audience definitions.

Initialise the exclusion-targeting audience builder.

Parameters:

  • name: Name of the exclusion-targeting audience.
  • source_audience_type: The audience type of the seed audience that will be excluded from the base audience.

build​

def build(
    self,
) ‑> decentriq_platform.media.exclusion_targeting_audience_builder.ExclusionTargetingAudienceDefinition

Build the exclusion-targeting audience definition.

Returns:

  • The exclusion-targeting audience definition

with_share_with_participants​

def with_share_with_participants(
    self,
    participants: List[Participant],
) ‑> Self

Make the exclusion-targeting audience available to the given participants.

Parameters:

  • participants: The participants to share the exclusion-targeting audience with

Returns:

  • The updated exclusion-targeting audience builder

ExclusionTargetingAudienceDefinition​

ExclusionTargetingAudienceDefinition(
    *,
    name: str,
    source_audience_type: str,
    shared_with: List[Participant],
)

Class representing the definition of an exclusion-targeting audience.

An exclusion-targeting audience contains the publisher (base) users who are NOT in the overlap for the referenced seed audience — i.e. base \ seed. It complements a remarketing audience (which selects base ∩ seed) and is typically used to reach users who haven't yet been engaged by the advertiser's existing campaign.

Scope: exclusion is per single seed audience, identified by its source_audience_type. If the advertiser has uploaded multiple seed audiences, this excludes only users in the specified one — not the union of all seed audiences.

Initialize an exclusion-targeting audience definition.

Parameters:

  • name: Name of the exclusion-targeting audience
  • source_audience_type: The audience type of the seed audience to exclude
  • shared_with: List of participant groups to share with