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

    Interface AcquireRightsRequest

    Binding contractual request to acquire rights from a brand agent. Parallels create_media_buy — the buyer selects a pricing_option_id from a get_rights response and provides campaign details. The agent clears against existing contracts and returns terms, generation credentials, and disclosure requirements.

    interface AcquireRightsRequest {
        adcp_major_version?: number;
        rights_id: string;
        pricing_option_id: string;
        buyer: BrandReference;
        campaign: {
            description: string;
            uses: RightUse[];
            countries?: string[];
            format_ids?: FormatReferenceStructuredObject[];
            estimated_impressions?: number;
            start_date?: string;
            end_date?: string;
        };
        revocation_webhook: PushNotificationConfig;
        push_notification_config?: PushNotificationConfig;
        idempotency_key: string;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_major_version?: number

    The AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    1

    99

    rights_id: string

    Rights offering identifier from get_rights response

    pricing_option_id: string

    Selected pricing option from the rights offering

    buyer: BrandReference
    campaign: {
        description: string;
        uses: RightUse[];
        countries?: string[];
        format_ids?: FormatReferenceStructuredObject[];
        estimated_impressions?: number;
        start_date?: string;
        end_date?: string;
    }

    Campaign details for rights clearance

    Type Declaration

    • description: string

      Description of how the rights will be used

    • uses: RightUse[]

      Specific rights uses for this campaign

    • Optionalcountries?: string[]

      Countries where the campaign will run (ISO 3166-1 alpha-2)

    • Optionalformat_ids?: FormatReferenceStructuredObject[]

      Creative formats that will be produced

    • Optionalestimated_impressions?: number

      Estimated total impressions for the campaign. Required when the request carries an intent-phase governance_context token AND the selected pricing_option has model: 'cpm' — the brand agent projects commitment as (pricing_option.price / 1000) × estimated_impressions evaluated in pricing_option.currency. Brand agents MUST reject with INVALID_REQUEST (field: campaign.estimated_impressions) when CPM-priced rights are requested under a governance_context and this field is omitted or zero; implementer-chosen defaults are non-conformant. See the acquire_rights task reference for the full validation contract including currency-mismatch handling.

      0

    • Optionalstart_date?: string

      Campaign start date (ISO 8601)

      date

    • Optionalend_date?: string

      Campaign end date (ISO 8601). Brand agents MUST reject with INVALID_REQUEST (field: campaign.end_date) when end_date is in the past at the time of the request — acquiring rights for an elapsed window produces a zero-duration grant and is almost always a buyer-side bug.

      date

    revocation_webhook: PushNotificationConfig
    push_notification_config?: PushNotificationConfig
    idempotency_key: string

    Client-generated key for safe retries. Resubmitting with the same key returns the original response rather than creating a duplicate acquisition. MUST be unique per (seller, request) pair to prevent cross-seller correlation. Use a fresh UUID v4 for each request.

    16

    255

    ^[A-Za-z0-9_.:-]{16,255}$

    context?: ContextObject
    ext?: ExtensionObject