@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface SyncAudiencesSuccess

    Success response - sync operation processed audiences

    interface SyncAudiencesSuccess {
        audiences: {
            audience_id: string;
            name?: string;
            seller_id?: string;
            action: "failed" | "created" | "updated" | "unchanged" | "deleted";
            status?: AudienceStatus;
            uploaded_count?: number;
            total_uploaded_count?: number;
            matched_count?: number;
            effective_match_rate?: number;
            match_breakdown?: {
                id_type: MatchIDType;
                submitted: number;
                matched: number;
                match_rate: number;
            }[];
            last_synced_at?: string;
            minimum_size?: number;
            errors?: Error[];
        }[];
        sandbox?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    audiences: {
        audience_id: string;
        name?: string;
        seller_id?: string;
        action: "failed" | "created" | "updated" | "unchanged" | "deleted";
        status?: AudienceStatus;
        uploaded_count?: number;
        total_uploaded_count?: number;
        matched_count?: number;
        effective_match_rate?: number;
        match_breakdown?: {
            id_type: MatchIDType;
            submitted: number;
            matched: number;
            match_rate: number;
        }[];
        last_synced_at?: string;
        minimum_size?: number;
        errors?: Error[];
    }[]

    Results for each audience on the account

    Type Declaration

    • audience_id: string

      Audience ID from the request (buyer's identifier)

    • Optionalname?: string

      Name of the audience

    • Optionalseller_id?: string

      Seller-assigned identifier for this audience in their ad platform

    • action: "failed" | "created" | "updated" | "unchanged" | "deleted"

      Action taken for this audience. 'status' is present when action is created, updated, or unchanged. 'status' is absent when action is deleted or failed.

    • Optionalstatus?: AudienceStatus
    • Optionaluploaded_count?: number

      Number of members submitted in this sync operation (delta, not cumulative). In discovery-only calls (no audiences array), this is 0.

      0

    • Optionaltotal_uploaded_count?: number

      Cumulative number of members uploaded across all syncs for this audience. Compare with matched_count to calculate match rate (matched_count / total_uploaded_count). Populated when the seller tracks cumulative upload counts.

      0

    • Optionalmatched_count?: number

      Total members matched to platform users across all syncs (cumulative, not just this call). Populated when status is 'ready'.

      0

    • Optionaleffective_match_rate?: number

      Deduplicated match rate across all identifier types (matched_count / total_uploaded_count after deduplication). A single number for reach estimation. Populated when status is 'ready'.

      0

      1

    • Optionalmatch_breakdown?: { id_type: MatchIDType; submitted: number; matched: number; match_rate: number }[]

      Per-identifier-type match results. Shows which ID types are resolving and at what rate. Helps buyers decide which identifiers to prioritize. Populated when the seller can report per-type matching. Omitted when the seller only supports aggregate match counts.

    • Optionallast_synced_at?: string

      ISO 8601 timestamp of when the most recent sync operation was accepted by the platform. Useful for agents reasoning about audience freshness. Omitted if the seller does not track this.

      date-time

    • Optionalminimum_size?: number

      Minimum matched audience size required for targeting on this platform. Populated when status is 'too_small'. Helps agents know how many more members are needed.

      1

    • Optionalerrors?: Error[]

      Errors for this audience (only present when action='failed')

    sandbox?: boolean

    When true, this response contains simulated data from sandbox mode.

    context?: ContextObject
    ext?: ExtensionObject