@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Type Alias PlannedDelivery

    PlannedDelivery: {} & {
        media_buy_id?: string;
        proposal_id?: string;
        proposal_terms_digest?: string;
        geo?: { countries?: string[]; regions?: string[] };
        channels?: MediaChannel[];
        start_time?: string;
        end_time?: string;
        frequency_cap?: FrequencyCap;
        audience_summary?: string;
        audience_targeting?: [AudienceSelector, ...AudienceSelector[]];
        total_budget?: number;
        daily_budget_cap?: number;
        budget_cap_timezone?: string;
        currency?: string;
        budget_allocation?: BudgetAllocation;
        pacing?: Pacing;
        bidding?: BiddingPolicy;
        enforced_policies?: string[];
        ext?: ExtensionObject;
    }

    The seller's interpreted delivery parameters. Describes what the seller will actually run -- geo, channels, flight dates, frequency caps, and budget. Present when the account has governance_agents or when the seller chooses to provide delivery transparency.

    Type Declaration

      • Optionalmedia_buy_id?: string

        Seller-assigned media buy identifier. Optional on a purchase-phase prepare/check because the service may not assign the identifier until commit; required on modification and delivery lifecycle checks.

      • Optionalproposal_id?: string

        Proposal snapshot being executed or currently governing the MediaBuy.

      • Optionalproposal_terms_digest?: string

        Digest of the proposal commercial_terms. The governance agent compares it to the digest bound during the intent check.

      • Optionalgeo?: { countries?: string[]; regions?: string[] }

        Geographic targeting the seller will apply.

        • Optionalcountries?: string[]

          ISO 3166-1 alpha-2 country codes where ads will deliver.

        • Optionalregions?: string[]

          ISO 3166-2 subdivision codes where ads will deliver.

      • Optionalchannels?: MediaChannel[]

        Channels the seller will deliver on.

      • Optionalstart_time?: string

        Actual flight start the seller will use.

      • Optionalend_time?: string

        Actual flight end the seller will use.

      • Optionalfrequency_cap?: FrequencyCap
      • Optionalaudience_summary?: string

        Human-readable summary of the audience the seller will target.

      • Optionalaudience_targeting?: [AudienceSelector, ...AudienceSelector[]]

        Structured audience targeting the seller will activate. Each entry is either a signal reference or a descriptive criterion. When present, governance agents MUST use this for bias/fairness validation and SHOULD ignore audience_summary for validation purposes. The audience_summary field is a human-readable rendering of this array, not an independent declaration.

        1

      • Optionaltotal_budget?: number

        Total budget the seller will deliver against.

      • Optionaldaily_budget_cap?: number

        Hard aggregate daily spend ceiling the seller will enforce. Governance checks compare it with the authorized execution controls; it does not allocate spend to packages.

      • Optionalbudget_cap_timezone?: string

        IANA timezone defining the calendar-day boundary for every daily cap on the planned media buy.

      • Optionalcurrency?: string

        ISO 4217 currency code for the budget. Governance execution checks require it whenever total_budget is present and require it to match the intent-authorized currency.

      • Optionalbudget_allocation?: BudgetAllocation

        Seller-accepted cross-package allocation authority and goals. Presence with seller_optimized mode means automatic within-buy reallocations are part of the committed delivery, not separate modification actions.

      • Optionalpacing?: Pacing
      • Optionalbidding?: BiddingPolicy

        Seller-interpreted media-buy bidding policy used for governance and delivery transparency. Goal-bound controls follow budget-allocation scope semantics and monetary fields use the planned delivery currency. Package-authored overrides, including explicit automatic overrides, remain on packages rather than being copied into this aggregate field.

      • Optionalenforced_policies?: string[]

        Registry policy IDs the seller will enforce for this delivery.

      • Optionalext?: ExtensionObject

      Settings

      Member Visibility