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

    Interface GetCreativeDeliveryResponse

    Response payload for get_creative_delivery task. Returns creative delivery data with variant-level breakdowns including manifests and metrics.

    interface GetCreativeDeliveryResponse {
        account_id?: string;
        media_buy_id?: string;
        currency: string;
        reporting_period: { start: string; end: string; timezone?: string };
        creatives: {
            creative_id: string;
            media_buy_id?: string;
            format_id?: FormatReferenceStructuredObject;
            totals?: DeliveryMetrics;
            variant_count?: number;
            variants: CreativeVariant[];
        }[];
        pagination?: {
            limit: number;
            offset: number;
            has_more: boolean;
            total?: number;
        };
        errors?: Error[];
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    account_id? media_buy_id? currency reporting_period creatives pagination? errors? context? ext?

    Properties

    account_id?: string

    Account identifier. Present when the response spans or is scoped to a specific account.

    media_buy_id?: string

    Publisher's media buy identifier. Present when the request was scoped to a single media buy.

    currency: string

    ISO 4217 currency code for monetary values in this response (e.g., 'USD', 'EUR')

    ^[A-Z]{3}$

    reporting_period: { start: string; end: string; timezone?: string }

    Date range for the report.

    Type Declaration

    • start: string

      ISO 8601 start timestamp

      date-time

    • end: string

      ISO 8601 end timestamp

      date-time

    • Optionaltimezone?: string

      IANA timezone identifier for the reporting period (e.g., 'America/New_York', 'UTC'). Platforms report in their native timezone.

    creatives: {
        creative_id: string;
        media_buy_id?: string;
        format_id?: FormatReferenceStructuredObject;
        totals?: DeliveryMetrics;
        variant_count?: number;
        variants: CreativeVariant[];
    }[]

    Creative delivery data with variant breakdowns

    Type Declaration

    • creative_id: string

      Creative identifier

    • Optionalmedia_buy_id?: string

      Publisher's media buy identifier for this creative. Present when the request spanned multiple media buys, so the buyer can correlate each creative to its media buy.

    • Optionalformat_id?: FormatReferenceStructuredObject
    • Optionaltotals?: DeliveryMetrics
    • Optionalvariant_count?: number

      Total number of variants for this creative. When max_variants was specified in the request, this may exceed the number of items in the variants array.

      0

    • variants: CreativeVariant[]

      Variant-level delivery breakdown. Each variant includes the rendered manifest and delivery metrics. For standard creatives, contains a single variant. For asset group optimization, one per combination. For generative creative, one per generated execution. Empty when a creative has no variants yet.

    pagination?: {
        limit: number;
        offset: number;
        has_more: boolean;
        total?: number;
    }

    Pagination information. Present when the request included pagination parameters.

    Type Declaration

    • limit: number

      Maximum number of creatives requested

      1

    • offset: number

      Number of creatives skipped

      0

    • has_more: boolean

      Whether more creatives are available beyond this page

    • Optionaltotal?: number

      Total number of creatives matching the request filters

      0

    errors?: Error[]

    Task-specific errors and warnings

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties