Skip to main content

decentriq_platform.ab_media

Sub-modules​

  • decentriq_platform.ab_media.advertiser_api
  • decentriq_platform.ab_media.advertiser_computations
  • decentriq_platform.ab_media.audience_definitions
  • decentriq_platform.ab_media.audience_statistics_definition
  • decentriq_platform.ab_media.helper
  • decentriq_platform.ab_media.lookalike_audience_builder
  • decentriq_platform.ab_media.publisher_api
  • decentriq_platform.ab_media.publisher_computations
  • decentriq_platform.ab_media.request
  • decentriq_platform.ab_media.rule_based_builder
  • decentriq_platform.ab_media.tests

Classes​

AbMediaDcr​

AbMediaDcr(
    dcr_id: str,
    high_level: Dict[str, Any],
    session: Session,
    *,
    client: Client,
)

Class representing an Audience Builder DCR.

Initialise an Audience Builder DCR.

Parameters:

  • dcr_id: ID of the Audience Builder DCR.
  • high_level: High level representation of the Audience Builder DCR.
  • session: A Session object which can be used for communication with the enclave.
  • client: A Client object which can be used to perform operations such as uploading data and retrieving computation results.

participants​

def participants(
    self,
) ‑> Dict[str, Any]

Retrieve the participants of the Audience Builder DCR. This returns a dictionary of roles (keys) mapped to participants (email addresses).

retrieve_audit_log​

def retrieve_audit_log(
    self,
) ‑> str

Retrieve the audit log.

stop​

def stop(
    self,
)

Stop the Audience Builder DCR.

AbMediaDcrBuilder​

AbMediaDcrBuilder(
    *,
    client: Client,
    name: str,
    publisher_emails: list[str],
    advertiser_emails: list[str],
    matching_id_format: MatchingId,
    enclave_specs: Optional[dict[str, EnclaveSpecification]] = None,
)

A helper class to build an Audience Builder Media DCR.

Required arguments for building a DCR are passed via the constructor of this class. Optional arguments, instead, can be passed through the various builder methods.

Initialise an Audience Builder Media DCR builder.

Parameters:

  • client: A Client object that can be used to retrieve information about the platform.
  • name: The name of the DCR.
  • publisher_emails: A list with all publisher participants.
  • advertiser_emails: A list with all advertiser participants.
  • matching_id_format: The format of the matching ids, i.e. the ids that are used to match users between the publisher's and advertiser's datasets.
  • enclave_specs: Determines the types of enclaves that will supported by this Data Clean Room. If not specified, the latest enclave specifications known to this SDK version will be used.

build​

def build(
    self,
) ‑> decentriq_platform.ab_media.ab_media.AbMediaDcrDefinition

Build the Data Clean Room.

In order to use the DCR, the output of this method should be passed to client.publish_media_dcr.

with_advertiser_audience_download​

def with_advertiser_audience_download(
    self,
) ‑> typing_extensions.Self

Allow the advertiser to download the user ids for an audience.

with_agency_emails​

def with_agency_emails(
    self,
    emails: List[str],
) ‑> typing_extensions.Self

Set the agency email addresses.

Parameters:

  • emails: List of agency email addresses.

with_data_partner_emails​

def with_data_partner_emails(
    self,
    emails: List[str],
) ‑> typing_extensions.Self

Set the data partner email addresses.

Parameters:

  • emails: List of data partner email addresses.

with_hide_absolute_values_from_insights​

def with_hide_absolute_values_from_insights(
    self,
) ‑> typing_extensions.Self

Ensure absolute values are not included in the output of the insights computation.

with_insights​

def with_insights(
    self,
) ‑> typing_extensions.Self

Enable the "insights" feature set.

with_lookalike​

def with_lookalike(
    self,
) ‑> typing_extensions.Self

Enable the "lookalike" feature set.

with_observer_emails​

def with_observer_emails(
    self,
    emails: List[str],
) ‑> typing_extensions.Self

Set the observer email addresses.

Parameters:

  • emails: List of observer email addresses.

with_remarketing​

def with_remarketing(
    self,
) ‑> typing_extensions.Self

Enable the "remarketing" feature set.

with_rule_based​

def with_rule_based(
    self,
) ‑> typing_extensions.Self

Enable the "rule-based" feature set.

AbMediaDcrDefinition​

AbMediaDcrDefinition(
    name: str,
    high_level: Dict[str, Any],
    enclave_specs: Optional[Dict[str, EnclaveSpecification]] = None,
)

Class representing an Audience Builder DCR Definition.