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

    Interface SyncEventSourcesSuccess

    Success response - sync operation processed event sources

    interface SyncEventSourcesSuccess {
        event_sources: {
            event_source_id: string;
            name?: string;
            seller_id?: string;
            event_types?: EventType[];
            action_source?: ActionSource;
            managed_by?: "buyer" | "seller";
            setup?: {
                snippet?: string;
                snippet_type?: "html" | "javascript" | "pixel_url" | "server_only";
                instructions?: string;
            };
            action: "failed"
            | "created"
            | "updated"
            | "unchanged"
            | "deleted";
            health?: EventSourceHealth;
            errors?: Error[];
        }[];
        sandbox?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    event_sources: {
        event_source_id: string;
        name?: string;
        seller_id?: string;
        event_types?: EventType[];
        action_source?: ActionSource;
        managed_by?: "buyer" | "seller";
        setup?: {
            snippet?: string;
            snippet_type?: "html" | "javascript" | "pixel_url" | "server_only";
            instructions?: string;
        };
        action: "failed"
        | "created"
        | "updated"
        | "unchanged"
        | "deleted";
        health?: EventSourceHealth;
        errors?: Error[];
    }[]

    Results for each event source, including both synced and seller-managed sources on the account

    Type Declaration

    • event_source_id: string

      Event source ID from the request

    • Optionalname?: string

      Name of the event source

    • Optionalseller_id?: string

      Seller-assigned identifier for this event source (the ID in the seller's ad platform)

    • Optionalevent_types?: EventType[]

      Event types this source handles

    • Optionalaction_source?: ActionSource
    • Optionalmanaged_by?: "buyer" | "seller"

      Who manages this event source. 'buyer' = configured via this sync. 'seller' = always-on, managed by the seller (e.g. Amazon sales attribution for Amazon advertisers).

    • Optionalsetup?: {
          snippet?: string;
          snippet_type?: "html" | "javascript" | "pixel_url" | "server_only";
          instructions?: string;
      }

      Implementation details for activating this event source (e.g. JavaScript tag, pixel URL)

      • Optionalsnippet?: string

        Code snippet to place on the site (JavaScript, HTML pixel, etc.)

      • Optionalsnippet_type?: "html" | "javascript" | "pixel_url" | "server_only"

        Type of implementation. 'server_only' means no client-side tag is needed.

      • Optionalinstructions?: string

        Human/agent-readable setup instructions

    • action: "failed" | "created" | "updated" | "unchanged" | "deleted"

      Action taken for this event source

    • Optionalhealth?: EventSourceHealth
    • Optionalerrors?: Error[]

      Errors for this event source (only present when action='failed')

    sandbox?: boolean

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

    context?: ContextObject
    ext?: ExtensionObject