Discordリンクされたロール連携アプリ開発ガイド

Discordの「リンクされたロール」機能を活用し、外部サービスと連携したDiscordコミュニティを構築する方法を学びましょう。

この記事では、SteamやYouTubeなどの外部サービスアカウントとDiscordアカウントを連携させ、特定の条件を満たしたユーザーに自動的にロールを付与するアプリの開発方法を、初心者エンジニアにも分かりやすく解説します。

開発の流れ

1. Discord開発者ポータルでの準備
   • Discord開発者ポータルから、新しいアプリケーションを作成します。
   • アプリケーションの「Bot」タブで、Botユーザーを作成します。
   • 「OAuth2」タブで、OAuth2 URL Generatorを使用し、identify、connections などの必要なスコープを選択し、リダイレクトURLを設定します。
     • リダイレクトURLは、認証後にユーザーがリダイレクトされるURLです（例：http://localhost:3000/callback）。
2. OAuth2認証フローの実装
   • ユーザーがDiscordアプリ内で外部サービスとの接続を試みると、アプリはOAuth2認証URLにユーザーをリダイレクトします。
   • ユーザーは外部サービスでログインし、アプリへのアクセスを許可します。
   • 外部サービスは、事前に設定したリダイレクトURLに認証コードを付与してユーザーをリダイレクトします。
   • アプリは、この認証コードを使用してアクセストークンを取得します。
3. 外部サービスAPIとの連携
   • Steam、YouTubeなど、連携したい外部サービスのAPIドキュメントを参照し、必要な情報を取得する方法を確認します。
   • アクセストークンを使用してAPIリクエストを送信し、ユーザーの情報を取得します（例：Steam ID、YouTubeチャンネル登録状況など）。
4. リンクされたロールのメタデータ設定
   • Discord APIのPUT /applications/{application.id}/role-connections/metadataエンドポイントを使用して、リンクされたロールのメタデータを設定します。
     • メタデータには、ロール付与の条件となるキーと、そのキーに対応する説明（name、description）を含めます。
     • 例えば、「has_game」というキーで「特定のゲームを所有している」という条件を設定できます。
   • このAPIリクエストには、Botトークンを使用します。
5. Discordサーバーでのロール設定
   • Discordサーバーで新しいロールを作成します。
   • サーバー設定の「ロール」>「リンク」タブに移動します。
   • 作成したリンクされたロールを選択し、ロールを取得するための要件（メタデータで設定したキーと値）を設定します。
     • 例えば、「has_game」キーがtrueの場合にロールを付与するように設定できます。
6. ユーザーによる接続とロール付与
   • ユーザーはDiscordサーバー内で、サーバー名をクリックし、「アプリ」> 連携アプリ名 > 連携するサービス を選択し、外部サービスのアカウントを接続します。
   • アプリは、外部サービスAPIから取得した情報と、リンクされたロールのメタデータに基づいて、ユーザーにロールを付与します。

よくある質問（FAQ）

Q: なぜOAuth2を使うのですか？

A: OAuth2は、ユーザーがパスワードを共有せずに安全に外部サービスへのアクセスを許可するための標準的な認証フレームワークです。

Q: リダイレクトURLは何のために必要ですか？

A: リダイレクトURLは、認証後にユーザーがリダイレクトされる場所です。外部サービスは、このURLに認証コードを付与してリダイレクトします。アプリはこのコードを使ってアクセストークンを取得します。

Q: Botトークンとユーザートークンの違いは何ですか？

A: Botトークンは、Botユーザー（アプリ）の認証に使用されます。ユーザートークンは、個々のユーザーの認証に使用されます。リンクされたロールのメタデータを設定する際には、セキュリティ上の理由からBotトークンを使用します。

Q: 複数の外部サービスと連携できますか？

A: はい、複数の外部サービスと連携できます。それぞれのサービスに対してOAuth2フローとAPI連携を実装する必要があります。

Q: どのような条件でロールを付与できますか？

A: 外部サービスAPIから取得できる情報に基づいて、様々な条件を設定できます。例えば、特定のゲームの所有、特定のチャンネルの登録、特定のスコアの達成などです。

Q: ユーザーが接続を解除した場合、ロールはどうなりますか？

A: アプリは接続解除を検知し、必要に応じてロールを削除する処理を実装する必要があります。

Q: 開発にはどのようなプログラミング言語やライブラリを使用できますか？

A: HTTPリクエストを送信できる言語であれば、基本的にどのような言語でも開発可能です。Node.js、Python、Goなどがよく使われます。Discord.js、discord.pyなどのDiscord APIラッパーライブラリを使用すると、開発が容易になります。

補足

• エラーハンドリング: APIリクエストのエラーや認証フローのエラーなどを適切に処理するように実装することが重要です。
• セキュリティ: Botトークンの管理、OAuth2フローの適切な実装など、セキュリティに配慮した開発を心がけましょう。

この記事が、あなたのアプリ開発に役立つことを願っています。