Contentful Personalization & Analytics
    Preparing search index...

    Interface OptimizationProviderConfigProps

    Props for the OptimizationProvider component.

    Accepts all OptimizationConfig properties directly. Only clientId is required.

    interface OptimizationProviderConfigProps {
        allowedEventTypes?: AllowedEventType[];
        api?: CoreStatefulApiConfig;
        children?: ReactNode;
        clientId: string;
        defaults?: CoreConfigDefaults;
        environment?: string;
        eventBuilder?: EventBuilderConfig;
        fetchOptions?: Omit<ProtectedFetchMethodOptions, "apiName">;
        getAnonymousId?: () => string | undefined;
        locale?: string;
        logLevel?: LogLevels;
        onEventBlocked?: (event: BlockedEvent) => void;
        onStatesReady?: OnStatesReady;
        queuePolicy?: QueuePolicy;
        sdk?: undefined;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowedEventTypes? api? children? clientId defaults? environment? eventBuilder? fetchOptions? getAnonymousId? locale? logLevel? onEventBlocked? onStatesReady? queuePolicy? sdk?

    Properties

    allowedEventTypes?: AllowedEventType[]

    Allow-listed event type strings permitted when consent is not set.

    api?: CoreStatefulApiConfig

    Unified API configuration for stateful environments.

    children?: ReactNode

    Children components that will have access to the ContentfulOptimization instance.

    clientId: string

    Client identifier used for authentication or tracking.

    defaults?: CoreConfigDefaults

    Optional set of default values applied on initialization.

    environment?: string

    Contentful environment identifier.

    'main'

    eventBuilder?: EventBuilderConfig

    Event builder configuration (channel/library metadata, etc.).

    fetchOptions?: Omit<ProtectedFetchMethodOptions, "apiName">

    Options used to configure the underlying protected fetch method.

    apiName is derived from the client name and must not be provided here.

    getAnonymousId?: () => string | undefined

    Function used to obtain an anonymous user identifier.

    locale?: string

    Default SDK locale used for Experience API requests and event context.

    logLevel?: LogLevels

    Minimum log level for the default console sink.

    onEventBlocked?: (event: BlockedEvent) => void

    Callback invoked whenever an event call is blocked by checks.

    onStatesReady?: OnStatesReady

    Called once SDK state initialization completes and before provider children mount. Return a cleanup function to unsubscribe app-level state observers on teardown.

    queuePolicy?: QueuePolicy

    Unified queue policy for queued stateful work.

    sdk?: undefined

    Settings

    Member Visibility

    On This Page

    Properties