Skip to main content

decentriq_platform.lookalike_media

Functions​

provision_dataset​

def provision_dataset(
    data: _io.BytesIO,
    *,
    name: str,
    session: decentriq_platform.session.Session,
    key: decentriq_platform.storage.Key,
    data_room_id: str,
    dataset_type: decentriq_platform.lookalike_media.lookalike_media.DatasetType,
    description: str = '',
    secret_store_options: Optional[decentriq_platform.client.SecretStoreOptions] = None,
) ‑> str

Classes​

DatasetType​

DatasetType(
    *args,
    **kwds,
)

Create a collection of name/value pairs.

Example enumeration:

class Color(Enum): ... RED = 1 ... BLUE = 2 ... GREEN = 3

Access them by:

  • attribute access::

Color.RED <Color.RED: 1>

  • value lookup:

Color(1) <Color.RED: 1>

  • name lookup:

Color['RED'] <Color.RED: 1>

Enumerations can be iterated over, and know how many members they have:

len(Color) 3

list(Color) [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes -- see the documentation for details.

Ancestors (in MRO)

  • enum.Enum

LookalikeMediaDcr​

LookalikeMediaDcr(
    client: decentriq_platform.client.Client,
    high_level_representation: str,
    existing_lookalike_media_dcr: Optional[decentriq_platform.lookalike_media.lookalike_media.ExistingLookalikeMediaDcr] = None,
)

Static methods

send_request​

def send_request(
    lmdcr_request: decentriq_dcr_compiler._schemas.lookalike_media_request.LookalikeMediaRequest,
    session: decentriq_platform.session.Session,
) ‑> decentriq_dcr_compiler._schemas.lookalike_media_response.LookalikeMediaResponse

deprovision_data_lab​

def deprovision_data_lab(
    self,
)

Deprovision a DataLab from the Lookalike Media DCR.

generate_insights​

def generate_insights(
    self,
)

Run the overlap insights computation. Use the get_overlap_insights method to retrieve the results of this computation.

get_overlap_insights​

def get_overlap_insights(
    self,
    timeout: Optional[int] = None,
) ‑> Dict[str, str]

Retrieve the results of running the overlap insights computation.

provision_from_data_lab​

def provision_from_data_lab(
    self,
    data_lab_id: str,
)

Provision the DataLab with the given ID to the Lookalike Media DCR.

Parameters:

  • data_lab_id: ID of the DataLab to provision to the Lookalike Media DCR.

retrieve_audit_log​

def retrieve_audit_log(
    self,
) ‑> str

Retrieve the Lookalike Media DCR audit log.

LookalikeMediaDcrBuilder​

LookalikeMediaDcrBuilder(
    client: decentriq_platform.client.Client,
)

A helper class to build a Lookalike Media DCR

build_and_publish​

def build_and_publish(
    self,
) ‑> decentriq_platform.lookalike_media.lookalike_media.LookalikeMediaDcr

Build and publish the Lookalike Media DCR.

from_existing​

def from_existing(
    self,
    lmdcr_id: str,
)

Construct a new Lookalike Media DCR from an existing Lookalike Media DCR with the given ID.

Parameters:

  • lmdcr_id: The ID of the existing Lookalike Media DCR.

with_advertiser_emails​

def with_advertiser_emails(
    self,
    main: str,
    additional: Optional[List[str]] = None,
)

Set the advertiser email addresses.

Parameters:

  • main: The main advertiser email address.
  • additional: Optional list of additional advertiser email addresses.

with_agency_emails​

def with_agency_emails(
    self,
    emails: List[str],
)

Set the agency email addresses.

Parameters:

  • emails: List of agency email addresses.

with_matching_id_format​

def with_matching_id_format(
    self,
    matching_id: decentriq_platform.types.MatchingId,
)

Set the matching ID format. This is required when creating new Lookalike Media DCRs only. When creating from an existing DCR, the existing matching ID will be used.

Parameters:

  • matching_id: The type of matching ID to use.

with_name​

def with_name(
    self,
    name: str,
)

Set the name of the Lookalike Media DCR. This is required when creating new Lookalike Media DCRs only. When creating from an existing DCR, the existing name will be used.

Parameters:

  • name: Name to be used for the Lookalike Media DCR.

with_observer_emails​

def with_observer_emails(
    self,
    emails: List[str],
)

Set the observer email addresses.

Parameters:

  • emails: List of observer email addresses.

with_publisher_emails​

def with_publisher_emails(
    self,
    main: str,
    additional: Optional[List[str]] = None,
)

Set the publisher email addresses.

Parameters:

  • main: The main publisher email address.
  • additional: Optional list of additional publisher email addresses.