Getting Started

__CAPGO_KEEP_1__

AI-Assisted セットアップを使用してプラグインをインストールできます。AIツールに Capgo スキルを追加するには、以下のコマンドを実行してください。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください。

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-crisp` plugin in my project.

手動セットアップを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

bun add @capgo/capacitor-crisp
bunx cap sync

インポート

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

API の概要

configure

SDK をウェブサイト ID で設定する。 他のメソッドを使用する前に呼び出す必要があります。

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.configure({ websiteID: 'YOUR_WEBSITE_ID' });

openMessenger

Crisp メッセンジャー チャット ウィンドウを開く。 ユーザーにチャット インターフェイスを表示します。

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.openMessenger();

setTokenID

セッション用のユニークなトークンIDを設定します。 前回の会話を識別して復元するために使用されます。

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.setTokenID({} as { tokenID: string });

setUser

現在のセッションのユーザー情報を設定します。 サポートエージェントが見るユーザープロファイルを更新します。

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setUser({
  nickname: 'John Doe',
  email: 'john@example.com',
  phone: '+1234567890'
});

pushEvent

Crispにカスタムイベントをプッシュします。 ユーザーの行動や行動を追跡するために使用されます。

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.pushEvent({
  name: 'completed_purchase',
  color: 'green'
});

setCompany

現在のセッションの会社情報を設定します。 ユーザーをCrispの会社に関連付けます。

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setCompany({
  name: 'Acme Corp',
  url: 'https://acme.com',
  employment: ['CEO', 'Executive'],
  geolocation: ['USA', 'San Francisco']
});

setInt

ユーザー セッションに関連付けられた数値データを保存するカスタム整数データ フィールドを設定します。

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setInt({ key: 'user_level', value: 42 });

setString

ユーザー セッションに関連付けられたテキスト データを保存するカスタム文字列データ フィールドを設定します。

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setString({ key: 'subscription_tier', value: 'premium' });

sendMessage

ユーザーがメッセージをタイプしたように、プログラムでメッセージを送信します。

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.sendMessage({ value: 'Hello, I need help!' });

setSegment

ユーザーをターゲットと組織化するために使用される、ユーザー セグメントを設定します。

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CrispPlugin.setSegment({ segment: 'premium-users' });

reset

セッションをリセットします。 ユーザーデータをすべて削除し、新しいセッションを開始します。 ログアウトしたときに便利です。

import { CapacitorCrisp } from '@capgo/capacitor-crisp';

await CapacitorCrisp.reset();

タイプ リファレンス

ConfigureOptions

Crispの初期化に使用する設定です。

export interface ConfigureOptions {
  /**
   * Your Crisp website ID from dashboard.
   */
  websiteID: string;
  /**
   * Optional - Locale to force in the Crisp chat widget (ISO 639-1), eg. `en`, `fr`, `es`.
   * Web + Android: overrides the runtime locale. iOS follows the device/app locale.
   */
  locale?: string;
  /**
   * Optional - Unique token identifier for the user session continuity.
   */
  tokenID?: string;
}

eventColor

Crispイベントの可視化に使用する色です。

export type eventColor =
  | 'red'
  | 'orange'
  | 'yellow'
  | 'green'
  | 'blue'
  | 'purple'
  | 'pink'
  | 'brown'
  | 'grey'
  | 'black';

ソース オブ トゥルース

このページはプラグインから生成されています。 src/definitions.ts. 公開 API がアップストリームで変更された場合、再度同期を実行してください。

Getting Started から続けてください

Capacitor を使用している場合 Getting Started を使用してダッシュボードと __CAPGO_KEEP_0__ の操作を計画する場合、Capacitor を接続してください。 Capacitor の @API/__CAPGO_KEEP_1__-crisp を使用 Capacitor の @capgo/capacitor-crisp のネイティブ機能について for the native capability in Using @capgo/capacitor-crisp, API の実装詳細について for the implementation detail in API Overview, Introduction Introductionの実装詳細について API Keys API Keysの実装詳細について、 Devices Devicesの実装詳細について