Chrome拡張機能の公開配布におけるHTTP APIとWordParty設定参照の可否について

対象

わんコメ / WordParty / その他

利用OS

Windows または MacOS

利用バージョン: Windows、わんコメやOBSのバージョン

わんコメ: 9.0.6

PRO版を利用

している

過去ログ確認 (検索はこちらから)

していない

ドキュメント確認 (公式サイト)

した

内容

お世話になっております。

YouTube Studioのリアルタイム登録者数が増えた際に、指定したWordPartyを1回
起動するChrome拡張機能を開発しています。現在は自分の環境で動作確認を行って
おり、将来的にChrome Web Storeで無料配布し、希望者から任意の寄付を受け付ける
ことを検討しています。

本拡張機能はわんコメ本体や素材を同梱せず、利用者自身のPCで起動している
わんコメ 9.0.6へ、Chrome拡張機能から次のローカルHTTPアクセスを行います。

  1. GET http://localhost:11180/api/info
    • 接続確認とバージョン表示
  2. GET http://localhost:11180/api/templates
    • WordPartyテンプレートのIDを確認
  3. GET http://localhost:11180/templates/{templateId}/config.js
    • 利用者が設定したWordPartyを一覧表示するために参照
  4. POST http://localhost:11180/api/wordparty/{wordPartyId}
    • 利用者が選択したWordPartyを起動

config.js はJavaScriptとして実行せず、拡張機能内で文字列として解析し、
WordPartyの演出名、8文字のID、演出種類、有効・無効だけを選択肢として表示
します。画像、音声、パターンなどの設定は保存しません。利用者が選択して保存
した演出名とIDだけをChromeのローカルストレージへ保存します。

登録者数やWordParty設定を開発者のサーバーへ送信することはありません。
わんコメとの通信は同じPCの localhost:11180 だけで完結します。利用者には
わんコメの「設定 > API > 許可ホスト」へChrome拡張機能IDを登録してもらいます。

以下について確認させてください。

  1. Chrome Web Storeで公開配布する外部連携アプリケーションから、上記4つの
    URLを使用しても問題ないでしょうか。
  2. 特に GET /api/templates
    GET /templates/{templateId}/config.js を、WordParty一覧の取得目的で
    使用してよいでしょうか。
  3. WordParty一覧を取得するための、より適切な公開APIや推奨方式があれば
    教えてください。
  4. 拡張機能の設定画面とストア掲載ページには、無料版のわんコメ利用時に必要な
    クレジット表記の案内と、「わんコメ公式ではない独立開発の拡張機能」である
    旨を記載する予定です。追加で必要な表記や推奨文言はありますでしょうか。
  5. 拡張機能の基本機能は無料のまま、開発者が任意の寄付を受け付けることに
    問題はありますでしょうか。

公開前に必要な条件や申請がある場合は、それに従います。
よろしくお願いいたします。

1,2,3について

元となるインターフェイスによるかもしれませんが、ユーザーが WordPartyId を指定した段階でテンプレート一覧及びconfig.js取得のロジックについてはほとんど場合不要な処理に見受けられます

WordPartyのexecは現在接続されているすべてのWordPartyテンプレートに対してIDを送出し各クライアントで該当のID演出があれば実行をするものになっています(なお無効であっても実行される仕様となります)
そのため実行トリガーである拡張機能側からテンプレートの特定や演出の特定をせずともただIDを送るだけで該当のテンプレートの演出が発火します

APIの使用については問題ありませんが、config.jsについてはAPIで提供している範囲ではないためサポートの対象外となります
これらのファイルは予告なく変更される可能性がある点はご留意ください

推奨としましてはユーザーがWordPartyIDのみを指定し、ただexecを呼び出すだけというものとなります(下図: わんコメStreamDeckプラグインもこの方式です)

  1. 特に指定はございませんが、もしローカルストレージ内などに保存する項目がありましたら明記を推奨いたします(何をどこにどのくらい保存するのか)

  2. APIを用いたサードパーティプラグイン・テンプレート等の収益につきましては許諾事項の範囲内になります

ご回答ありがとうございます。

WordPartyの実行仕様について理解いたしました。ご案内いただいた推奨方式に合わせ、公開配布版ではユーザーにWordParty IDを指定していただき、拡張機能からexec APIへそのIDを送信するだけの構成へ変更いたします。

テンプレート一覧の取得およびconfig.jsの読み取り・解析処理は削除し、config.jsに依存しない形とします。

また、ローカルストレージ等に保存する設定項目、保存場所、保存期間についても、拡張機能の設定画面、ストア掲載情報およびプライバシーポリシーへ明記いたします。

APIを利用したサードパーティ製ツールの収益に関する扱いについても承知いたしました。

詳しくご説明いただき、ありがとうございました。公開前にご確認できて大変助かりました。