Cấu hình

Tổng quan về tất cả các tùy chọn cấu hình khả dụng.

Về các ví dụ

Tất cả các ví dụ trong phần này là các đoạn code một phần. Chúng không đại diện cho cấu hình đầy đủ/hợp lệ.

credentials

Đây là thông tin đăng nhập cần thiết để kết nối ứng dụng của bạn với hệ thống Kalapa CMP.

• Type:

  interface Credentials {
    url: string;
    key: string;
    trackingId: string;
  }

  Yêu cầu: Tất cả các trường (url, key, trackingId) đều bắt buộc phải được điền đầy đủ.

Chi tiết:

• url: Địa chỉ của máy chủ Kalapa CMP mà bạn đang kết nối.

• key: Khóa API để xác thực quyền truy cập.

• trackingId: ID theo dõi khách hàng của bạn.

• Ví dụ:

    credentials: {
        url: "provided-url",
        key: "provided-key",
        trackingId: "your-customer-tracking-id"
    }

  Lưu ý:

• Bảo mật: Bảo quản thông tin đăng nhập (URL, key, tracking ID) một cách an toàn.

• Thay thế các giá trị mẫu (provided-url, provided-key, your-customer-tracking-id) bằng thông tin thực tế của bạn.

options

guiOptions

Tuỳ chỉnh giao diện chính của các modal/popup

• Type:

  interface GuiOptions {
    consentModal?: ConsentModalOptions;
    preferencesModal?: PreferencesModalOptions;
  }

guiOptions.consentModal

• Type:

  interface ConsentModalOptions {
    layout?: string;
    position?: string;
  }

• Default:

  {
      layout: 'cloud',
      position: 'bottom center',
  }

• Chi tiết:

  Tất cả các lựa chọn layout và position.

  Layout	Variant(s)	Position-Y	Position-X
  box	wide, inline	top, middle, bottom	left, center, right
  cloud	inline	top, middle, bottom	left, center, right
  bar	inline	top, bottom	-

  Lưu ý

  Giá trị layout hợp lệ: <layoutName> <layoutVariant>.
  Giá trị position lệ: <positionY> <positionX>.

• Ví dụ:

  guiOptions: {
      consentModal: {
          layout: 'cloud inline',
          position: 'bottom center'
      }
  }

guiOptions.preferencesModal

• Type:

  interface PreferencesModalOptions {
    layout?: string;
    position?: string;
  }

• Default:

  {
      layout: 'box',
      position: 'right',
  }

• Details:

  Tất cả các lựa chọn layout và position.

  Layout	Variant(s)	Position-Y	Position-X
  box	-	-	-
  bar	wide	-	left, right

  Lưu ý

  Giá trị layout hợp lệ: <layoutName> <layoutVariant>.
  Giá trị position lệ: <positionY> <positionX>.

• Ví dụ:

  guiOptions: {
      preferencesModal: {
          layout: 'bar wide',
          position: 'left',
      }
  }

forceConsent

Tạo một overlay tối và chặn tương tác của người dùng trên website cho đến khi người dùng cấp Consent

• Type: boolean
• Default: true

darkMode

Bật/tắt chế độ tối

• Type: boolean
• Default: false

language

Tạo một overlay tối và chặn tương tác của người dùng trên website cho đến khi người dùng cấp Consent

• Type: boolean
• Default: true