Skip to main content

decentriq_platform.admin

This module provides classes for interacting with the Decentriq platform as a Decentriq Admin.

Sub-modules​

  • decentriq_platform.admin.media

Classes​

AdminMediaDcr​

AdminMediaDcr(
    dcr_id: str,
    client: Client,
)

Admin-only view of a Media DCR.

Restricts usage to DQ admins only.

Static methods

from_existing​

def from_existing(
    dcr_id: str,
    client: Client,
) ‑> 'AdminMediaDcr'

Load an existing MDCR for admin inspection and compute.

are_seed_audiences_provisioned​

def are_seed_audiences_provisioned(
    self,
) ‑> bool

get_audience_size​

def get_audience_size(
    self,
    audience: Union[SeedAudience, CustomAudience],
) ‑> decentriq_platform.media.compute_job.MediaEstimateAudienceSizeJob

get_audiences​

def get_audiences(
    self,
    as_participant_email: str,
) ‑> decentriq_platform.media.compute_job.MediaGetAudiencesJob

Get audiences from a specific participant's perspective.

Unlike the participant-facing MediaDcr.get_audiences(), the admin is not itself a participant, so the caller must declare which participant's view to retrieve. Use get_owner_email() or get_participants() to pick one.

get_audit_log​

def get_audit_log(
    self,
) ‑> List[decentriq_platform.archv2.client.DataRoomAuditLog]

get_base_audience_validation_reports​

def get_base_audience_validation_reports(
    self,
) ‑> decentriq_platform.media.compute_job.MediaBaseAudienceValidationReportsJob

get_configuration​

def get_configuration(
    self,
) ‑> decentriq_platform.media.media.DcrConfiguration

get_data_attributes​

def get_data_attributes(
    self,
) ‑> decentriq_platform.media.compute_job.MediaDataAttributesJob

get_insights​

def get_insights(
    self,
) ‑> decentriq_platform.media.compute_job.MediaInsightsJob

get_lookalike_audience_statistics​

def get_lookalike_audience_statistics(
    self,
    audience: AudienceType,
) ‑> decentriq_platform.media.compute_job.MediaLookalikeAudienceStatisticsJob

get_overlap_statistics​

def get_overlap_statistics(
    self,
) ‑> decentriq_platform.media.compute_job.MediaOverlapStatisticsJob

get_owner_email​

def get_owner_email(
    self,
) ‑> str

get_participants​

def get_participants(
    self,
) ‑> List[decentriq_platform.media.participant.Participant]

get_seed_audiences_validation_report​

def get_seed_audiences_validation_report(
    self,
) ‑> decentriq_platform.media.compute_job.MediaAudiencesValidationReportJob

is_base_audience_provisioned​

def is_base_audience_provisioned(
    self,
) ‑> bool