ADK API Reference
    Preparing search index...

    Type Alias PlacementProviderParams

    Parameters for configuring the adk.placement provider.

    type PlacementProviderParams = {
        adapters?: Record<string, Record<string, unknown>>;
        afterLoad?: (params: AfterLoadClientParams) => void;
        forceGroup?: boolean;
        labels?: string[] | (() => string[]);
        name?: string;
        removeOnPassback?: boolean;
        useContextLabels?: boolean;
    }
    Index

    Properties

    adapters? afterLoad? forceGroup? labels? name? removeOnPassback? useContextLabels?

    Properties

    adapters?: Record<string, Record<string, unknown>>

    Adapter-specific options, keyed by adapter ID.

    afterLoad?: (params: AfterLoadClientParams) => void

    Callback invoked after placement results are processed. Adapter rendering may still be in progress when this callback runs.

    forceGroup?: boolean

    Renders placement results as a group even when only one item is returned. Multiple results are grouped automatically.

    false
    labels?: string[] | (() => string[])

    Target labels for the ad request. Ignored when useContextLabels is true. Can be a static array or a function that returns an array of labels.

    name?: string

    Placement name sent with the ad request. It needs to match the name of a placement owned by the publisher referenced when calling ConfigBuilder.init.

    The container name, which is the first argument passed to ConfigBuilder.addContainer.

    removeOnPassback?: boolean

    Removes the container when a passback is rendered.

    false
    useContextLabels?: boolean

    Reads labels from the container's data-adk-labels attribute or its ancestors instead of using labels.

    false

    Settings

    Member Visibility

    On This Page

    Properties