@adcp/client API Reference - v3.3.3
    Preparing search index...

    Interface CreateMediaBuyRequest

    Request parameters for creating a media buy

    interface CreateMediaBuyRequest {
        buyer_ref: string;
        packages: PackageRequest[];
        brand_manifest: BrandManifestReference1;
        po_number?: string;
        start_time: string;
        end_time: string;
        reporting_webhook?: PushNotificationConfig & {
            reporting_frequency: "hourly" | "daily" | "monthly";
            requested_metrics?: (
                | "impressions"
                | "spend"
                | "clicks"
                | "ctr"
                | "video_completions"
                | "completion_rate"
                | "conversions"
                | "viewability"
                | "engagement_rate"
            )[];
        };
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    buyer_ref packages brand_manifest po_number? start_time end_time reporting_webhook? context? ext?

    Properties

    buyer_ref: string

    Buyer's reference identifier for this media buy

    packages: PackageRequest[]

    Array of package configurations

    brand_manifest: BrandManifestReference1
    po_number?: string

    Purchase order number for tracking

    start_time: string
    end_time: string

    Campaign end date/time in ISO 8601 format

    reporting_webhook?: PushNotificationConfig & {
        reporting_frequency: "hourly" | "daily" | "monthly";
        requested_metrics?: (
            | "impressions"
            | "spend"
            | "clicks"
            | "ctr"
            | "video_completions"
            | "completion_rate"
            | "conversions"
            | "viewability"
            | "engagement_rate"
        )[];
    }

    Type Declaration

    • reporting_frequency: "hourly" | "daily" | "monthly"

      Frequency for automated reporting delivery. Must be supported by all products in the media buy.

    • Optionalrequested_metrics?: (
          | "impressions"
          | "spend"
          | "clicks"
          | "ctr"
          | "video_completions"
          | "completion_rate"
          | "conversions"
          | "viewability"
          | "engagement_rate"
      )[]

      Optional list of metrics to include in webhook notifications. If omitted, all available metrics are included. Must be subset of product's available_metrics.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties