はじめに

インストール

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.

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

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

ユーザーをターゲットと組織化するためにセグメントを設定します。 Crisp ダッシュボードでユーザーをカテゴリ化するために使用されます。

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

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

reset

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

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

await CapacitorCrisp.reset();

Type Reference

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がアップストリームで変更されたら、再度同期を実行してください。

続けて始めましょう

Capgoを使用している場合 CapgoのGetting Started Capgoを使用してダッシュボードとAPIの操作を計画するには、CapgoをAPIに接続します。 Capgoの@capgo/capacitor-crispを使用します。 Capgoの@capgo/capacitor-crispのネイティブ機能のために Capgoの@API/__CAPGO_KEEP_1__-crispのAPIの概要 CapgoのAPIの概要の実装詳細 CapgoのIntroductionの実装詳細 Capgoの__CAPGO_KEEP_0__のキー CapgoのAPIのキー Capgoの実装詳細についてはAPIキーの詳細を参照してください。 デバイス Capgoの実装詳細についてはデバイスの詳細を参照してください。