メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.mellowtel.com/llms.txt

Use this file to discover all available pages before exploring further.

​
これが何か

Mellowtelは、ユーザーが明示的にオプトインするまで、1バイトの帯域幅も共有しません。また、ユーザーがオプトアウトするための明確な方法を常に提供する必要があります。これはSDKの厳格な要件であり、Mellowtelベースの拡張機能を許可するすべてのブラウザストアポリシーの厳格な要件です。

​
なぜ重要か

それはユーザーの帯域幅です。明示的かつ撤回可能な同意がないことは非倫理的であり、ストアからの削除の理由になります。SDKは、簡単な パスが 準拠した パスでもあるように設計されています。推奨される実装に従えば、同意なしにアクティブ化されるバージョンを誤って出荷することはありません。

​
仕組み

初回インストール時（およびMellowtelを新たに導入する更新時）には、Mellowtelが何をするかを説明する非解除可能な免責事項をユーザーに表示し、その選択を取得する必要があります。それ以降、ユーザーが考えを変えることができるように、UIのどこかに設定リンクを明確に配置する必要があります。
実装には2つのオプションがあります：
  1. 推奨: generateAndOpenOptInLink()を使用して、事前に構築されたMellowtelオプトインページを開く。1つのメソッド呼び出しで、完全に準拠し、オプトインのコンバージョンを最大化します。
  2. カスタムUI: 独自の同意画面を構築し、optIn() / optOut()を自分で呼び出します。

​
APIの概要

メソッド戻り値使用目的
generateAndOpenOptInLink()Promise<void>ホストされたオプトインページを開く（推奨パス）。
getOptInStatus()Promise<boolean>ユーザーがすでにオプトインしているかどうかを確認します。
optIn()Promise<void>独自のUIから同意を記録します。
optOut()Promise<void>独自のUIから同意を撤回します。
start()Promise<void>オプトイン後にリクエストの処理を開始します。
generateSettingsLink()Promise<string>ユーザーが後で選択を変更できるように、ホストされた設定ページのURLを取得します。
すべてのメソッドは、拡張機能の任意の部分（ポップアップ、コンテンツスクリプト、またはバックグラウンドスクリプト）からアクセス可能です。

​
推奨される実装

完全な統合手順はプラットフォームのクイックスタートにあります。SDKをどこに配置するか、インストール/更新ライフサイクルにどのように組み込むか、そしてどのようにテストするかを示しています： 要するに、new Mellowtel(...)とinitBackground()の後に、インストール/更新ハンドラからgenerateAndOpenOptInLink()を呼び出します。それだけです。

​
カスタムUI

同意画面を完全にコントロールしたい場合は、独自のUIでユーザーの選択を取得し、それをSDKに転送します： 
// ユーザーが同意
await mellowtel.optIn();
await mellowtel.start();

// ユーザーが拒否または後で撤回
await mellowtel.optOut();

// ステータスを確認（例：トグルをレンダリングするため）
const hasOptedIn = await mellowtel.getOptInStatus();
どのようなUIを構築するにしても、以下を満たす必要があります：
  1. 初回インストール時に非解除可能であること。
  2. ユーザーが積極的に同意するまで、デフォルトでオプトアウトされていること。
  3. ユーザーが選択を変更できるように、製品内のどこかに再度開けるようにすること。

​
設定リンク

ユーザーは常に設定を変更する簡単な方法を持っている必要があります。generateSettingsLink()を使用してホストされた設定ページのURLを取得し、それをポップアップ、オプションページ、アカウント画面などのどこかに配置します。 
const settingsUrl = await mellowtel.generateSettingsLink();

​
既存のユーザーへのMellowtelの告知

すでにユーザーがいる拡張機能にMellowtelを追加する場合、同意を求める前に何が変わったかを知らせる必要があります。適応可能なコピー＆ペースト告知テンプレートを提供しています。

​
関連

  • プライバシー: ユーザーが実際に何を共有することに同意しているのか。
  • レート制限: オプトインしたユーザーをSDKがどのように保護するか。