@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Interface LegacySyncCreativesSuccess

    Success response - sync operation processed creatives (may include per-item failures)

    interface LegacySyncCreativesSuccess {
        dry_run?: boolean;
        creatives: {
            creative_id: string;
            revision_id?: string;
            account?: Account;
            action: CreativeAction;
            status?: CreativeStatus;
            platform_id?: string;
            localization?: CreativeLocalizationReadback;
            changes?: string[];
            errors?: Error[];
            warnings?: string[];
            macro_resolution_results?: {
                declaration_id: string;
                asset_path: string;
                token: string;
                dialect: MacroDialectFamily;
                dialect_namespace?: string;
                dialect_revision?: string;
                dialect_semantic: string;
                mapping_status: MacroMappingStatus;
                universal_semantic?: UniversalMacro;
                operation: MacroProcessingOperation;
                performed_by?: MacroProcessingActor;
                requested_encoding: MacroEncoding;
                required: boolean;
                unavailable_behavior:
                    | "preserve"
                    | "omit_parameter"
                    | "dialect_sentinel"
                    | "reject";
                status: | "preserved_for_downstream"
                | "unsupported"
                | "resolvable"
                | "ambiguous";
                reason: MacroResolutionReason;
                matched_encodings?: MacroEncoding[];
                message?: string;
            }[];
            preview_url?: string;
            expires_at?: string;
            assigned_to?: string[];
            assignment_errors?: { [k: string]: string
            | undefined };
        }[];
        sandbox?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index
    dry_run? creatives sandbox? context? ext?
    dry_run?: boolean

    Whether this was a dry run (no actual changes made)

    creatives: {
        creative_id: string;
        revision_id?: string;
        account?: Account;
        action: CreativeAction;
        status?: CreativeStatus;
        platform_id?: string;
        localization?: CreativeLocalizationReadback;
        changes?: string[];
        errors?: Error[];
        warnings?: string[];
        macro_resolution_results?: {
            declaration_id: string;
            asset_path: string;
            token: string;
            dialect: MacroDialectFamily;
            dialect_namespace?: string;
            dialect_revision?: string;
            dialect_semantic: string;
            mapping_status: MacroMappingStatus;
            universal_semantic?: UniversalMacro;
            operation: MacroProcessingOperation;
            performed_by?: MacroProcessingActor;
            requested_encoding: MacroEncoding;
            required: boolean;
            unavailable_behavior:
                | "preserve"
                | "omit_parameter"
                | "dialect_sentinel"
                | "reject";
            status: | "preserved_for_downstream"
            | "unsupported"
            | "resolvable"
            | "ambiguous";
            reason: MacroResolutionReason;
            matched_encodings?: MacroEncoding[];
            message?: string;
        }[];
        preview_url?: string;
        expires_at?: string;
        assigned_to?: string[];
        assignment_errors?: { [k: string]: string
        | undefined };
    }[]

    Results for each creative processed. Items with action='failed' indicate per-item validation/processing failures, not operation-level failures.

    Type Declaration

    • creative_id: string

      Creative ID from the request

    • Optionalrevision_id?: string
    • Optionalaccount?: Account
    • action: CreativeAction
    • Optionalstatus?: CreativeStatus
    • Optionalplatform_id?: string

      Platform-specific ID assigned to the creative

    • Optionallocalization?: CreativeLocalizationReadback
    • Optionalchanges?: string[]

      Field names that were modified (only present when action='updated')

    • Optionalerrors?: Error[]

      Validation or processing errors (only present when action='failed')

    • Optionalwarnings?: string[]

      Non-fatal warnings about this creative

    • Optionalmacro_resolution_results?: {
          declaration_id: string;
          asset_path: string;
          token: string;
          dialect: MacroDialectFamily;
          dialect_namespace?: string;
          dialect_revision?: string;
          dialect_semantic: string;
          mapping_status: MacroMappingStatus;
          universal_semantic?: UniversalMacro;
          operation: MacroProcessingOperation;
          performed_by?: MacroProcessingActor;
          requested_encoding: MacroEncoding;
          required: boolean;
          unavailable_behavior:
              | "preserve"
              | "omit_parameter"
              | "dialect_sentinel"
              | "reject";
          status: | "preserved_for_downstream"
          | "unsupported"
          | "resolvable"
          | "ambiguous";
          reason: MacroResolutionReason;
          matched_encodings?: MacroEncoding[];
          message?: string;
      }[]

      Per-token result for declared macros. Sellers include this on accepted items when macro declarations were evaluated, and may include it alongside a failed item's structured errors.

    • Optionalpreview_url?: string

      Preview URL for generative creatives (only present for generative formats)

    • Optionalexpires_at?: string

      ISO 8601 timestamp when preview link expires (only present when preview_url exists)

      date-time

    • Optionalassigned_to?: string[]

      Package IDs this creative was successfully assigned to (only present when assignments were requested)

    • Optionalassignment_errors?: { [k: string]: string | undefined }

      Assignment errors by package ID (only present when assignment failures occurred)

    sandbox?: boolean

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

    context?: ContextObject
    ext?: ExtensionObject

    Settings
    Member Visibility

    On This Page
    Properties