> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Friend API リファレンス

フレンド・フォロー機能




ゲーム内の友達関係を実現するときに使用します。

リクエストを出して、承認されて初めて関係の構築されるフレンドと、 相手の承認手続きなしに構築できるフォローがあります。

ゲームプレイヤーのメタデータとしてプロフィール情報を持たせることができます。<br>
プロフィール情報は `公開` `フォロワーに公開` `フレンドに公開` のスコープがあり、スコープに応じて他プレイヤーに公開されます。

フレンド・フォロワー数の上限はそれぞれ1,000人ですが、連携するサービスによっては各サービスのポリシーに従って追加の制限が加わる可能性があります。

フレンド関係を構築したいいずれかのプレイヤーが、相手にフレンドリクエストを送信し、フレンドリクエストを受け取ったプレイヤーがそれに同意することでフレンド関係が成立します。

GS2-Friend はプレイヤーのプロフィールを保持する領域を提供します。<br>
プロフィールには任意の値を保持でき、スペースが3箇所存在します。

ブラックリストは、プレイヤーがブロックしたユーザーIDのリストを保持する領域です。<br>
あくまで永続化する機能が存在するだけで、ここに追加するだけでは何も機能は果たしません。<br>
GS2-Matchmaking のマッチメイキング条件にリストを渡すなど、別途ここに記録したリストを必要に応じて使用する必要があります。

[マイクロサービス紹介 / GS2-Friend](../../microservices/friend)



- [GS2-Friend Deploy/CDK リファレンス](/ja/api_reference/friend/deploy/)
  
- [GS2-Friend SDK API リファレンス](/ja/api_reference/friend/sdk/)
  
- [GS2-Friend SDK for Game Engine API リファレンス](/ja/api_reference/friend/game_engine/)
  
- [GS2-Friend スクリプト トリガー リファレンス](/ja/api_reference/friend/script/)
  
- [GS2-Friend トランザクションアクション](/ja/api_reference/friend/stamp_sheet/)