スタートガイド

インストール

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

bunx 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-persistent-uuid` plugin in my project.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

bun add @capgo/capacitor-persistent-uuid
bunx cap sync

クイックスタート

import { PersistentUuid } from '@capgo/capacitor-persistent-uuid';

const result = await PersistentUuid.getId();
console.log(result);

例: resetId

import { PersistentUuid } from '@capgo/capacitor-persistent-uuid';

const result = await PersistentUuid.resetId();
console.log(result);

よくある落とし穴

• ネイティブ同期: 実行 bunx cap sync プラグインのアップグレード後。
• 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

インポート

import { PersistentUuid } from '@capgo/capacitor-persistent-uuid';

UUIDの読み取りまたは作成

import { PersistentUuid } from '@capgo/capacitor-persistent-uuid';

const result = await PersistentUuid.getId();

console.log(result.id);
console.log(result.scope);
console.log(result.created);

初回呼び出し時にUUIDが作成・保存されます。以降の呼び出しでは、同じスコープに対して同じUUIDが返されます。

安定したカスタムスコープの使用

ネイティブのデフォルトスコープは、Androidではパッケージ名、iOSではバンドル識別子です。デバッグ用と本番用のビルドでパッケージ識別子が異なるものの、同じUUIDを共有する必要がある場合は、共通のスコープを指定してください。

const result = await PersistentUuid.getId({
  scope: 'com.example.app',
});

UUIDのリセット

ユーザーのログアウト時、プライバシーのリセット要求時、または自動テストで新しい識別子が必要な場合に resetId を呼び出してください。

const replacement = await PersistentUuid.resetId();
console.log(replacement.id);

永続性の仕様

• Androidでは、パッケージ名またはカスタムスコープが安定していれば、署名キーが異なるAndroid StudioやPlay Store経由のインストールであっても、アンインストールと再インストールをまたいで保持されます。
• iOSでは、Keychainのアクセスルールが維持されている限り、アプリのアップデートやiOSのアップデート後も保持されます。
• Webでは localStorage を使用するため、開発時のフォールバックとしてのみ機能します。

Getting Startedの続きを進める

使用している場合 スタートガイド アプリに永続的な識別子を追加するには、以下と連携してください： @capgo/capacitor-persistent-uuid 概要についてはこちら、 Androidでの動作 再インストール時の挙動についてはこちら、 iOSの挙動 Keychainの挙動についてはこちら。 @capgo/capacitor-persistent-uuid を使用する チュートリアルについては、 Capgo プラグインディレクトリ 他のNative Pluginの場合も同様です。