decentriq_platform.media.lookalike_audience_builder
Classes
LookalikeAudienceBuilder
LookalikeAudienceBuilder(
*,
name: str,
reach: int,
source_audience: AudienceType,
)
Builder for constructing lookalike audience definitions.
Initialise the lookalike audience builder.
Parameters:
name
: Name of the lookalike audience.reach
: The desired reach of the lookalike audience expressed as a percentage between 1-30.source_audience_name
: Name of the source audience that the lookalike audience will be built from.
build
def build(
self,
) ‑> decentriq_platform.media.lookalike_audience_builder.LookalikeAudienceDefinition
Build the lookalike audience definition.
Returns:
- The lookalike audience definition
with_exclude_seed_audience
def with_exclude_seed_audience(
self,
) ‑> typing_extensions.Self
Exclude the seed audience from the lookalike audience.
Returns:
- The updated lookalike audience builder
with_share_with_participants
def with_share_with_participants(
self,
participants: List[Participant],
) ‑> typing_extensions.Self
Make the lookalike audience available to the given participants.
Parameters:
participants
: The participants to share the lookalike audience with
Returns:
- The updated lookalike audience builder
LookalikeAudienceDefinition
LookalikeAudienceDefinition(
*,
name: str,
reach: int,
exclude_seed_audience: bool,
source_audience: Union[SeedAudience, CustomAudience],
shared_with: List[Participant],
)
Class representing the definition of a lookalike audience.
Initialize a lookalike audience definition.
Parameters:
name
: Name of the lookalike audiencereach
: The desired reach percentage (1-30)exclude_seed_audience
: Whether to exclude the seed audiencesource_audience
: The source audience to build fromshared_with
: List of participant groups to share with