イントロダクション

このエンドポイントを使用すると、キーワードに基づいてコミュニティを検索・発見できます。

このエンドポイントは、クエリとして1つ以上のキーワードを受け付けます。デフォルトでは、指定したクエリに一致する公開コミュニティと非公開コミュニティの両方を返します。

アカウントのセットアップ

これらのエンドポイントにアクセスするには、以下が必要です。

• 承認済みの開発者アカウント。
• developer App のキーとトークンを使用して、Project 内にあるアプリで認証すること。 

X API v2 エンドポイントへのアクセス方法の詳細は、はじめにガイドをご覧ください。

はじめに

​

認証

このエンドポイントは、OAuth 1.0a ユーザーコンテキスト、OAuth 2.0 App-Only、または OAuth 2.0 認可コード（PKCE 対応）のいずれかで認証できます。  

​

リクエストの送信

Search Communities エンドポイントは次のように呼び出します：

      curl --location 'https://api.x.com/2/communities/search?query=anime' --header 'Authorization: ••••••'

リクエストが成功すると、次のような JSON レスポンスが表示されます。

{
   "data": [
       {
           "access": "Public",
           "description": "アニメコミュニティへようこそ！アニメファンが集まり、お気に入りの番組を共有し、アニメに関するあらゆることを議論する場所です。",
           "join_policy": "Open",
           "name": "アニメコミュニティ"
       },
       {
           "access": "Public",
           "description": "参加してアニメについて語りましょう 🥰",
           "join_policy": "Open",
           "name": "アニメワールド 🌸"
       },
       {
           "access": "Public",
           "description": "すべてのアニメ愛好家とクリエイターのために！",
           "join_policy": "Open",
           "name": "アニメ"
       },
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}

​

コミュニティ fields

Community Fields を指定すると、コミュニティに関連付けられた追加の data を取得できます。

利用可能な Community Fields は次のとおりです:

Field value	Type	Description
created_at	date (ISO 8601)	コミュニティの作成日時。
id	string	コミュニティの一意の識別子。
name	string	コミュニティ名。
description	string	コミュニティの説明文（提供されている場合）。
access	string	コミュニティのアクセスレベル。 次のいずれか: * Public * Closed
join_policy	string	コミュニティの参加ポリシー。 次のいずれか: * Open * RestrictedJoinRequestsDisabled * RestrictedJoinRequestsRequireAdminApproval * RestrictedJoinRequestsRequireModeratorApproval * SuperFollowRequired
member_count	integer	コミュニティに参加しているメンバー数。

​

リクエスト例

以下のように、追加の community fields を指定して Search Communities エンドポイントを呼び出せます。

      curl --location 'https://api.x.com/2/communities/search?query=anime&community.fields=access,created_at,description,id,join_policy,member_count,name' --header 'Authorization: ••••••'

レスポンス例

リクエストが成功すると、次のような JSON レスポンスが表示されます。

{
   "data": [
       {
           "id": "Q29tbXVuaXR5OjE3NTg3NDc4MTc2NDI3MDA5MjI=",
           "description": "アニメコミュニティへようこそ!アニメファンが集まり、お気に入りの作品を共有したり、アニメに関するあらゆることについて語り合ったりする場所です。",
           "join_policy": "オープン",
           "access": "公開",
           "member_count": 39915,
           "name": "アニメコミュニティ",
           "created_at": "2024-02-17T06:58:50.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE1MDY3OTM5NTMxMDYwNDI4OTE=",
           "description": "参加してアニメについて語り合いましょう 🥰",
           "join_policy": "オープン",
           "access": "公開",
           "member_count": 26019,
           "name": "アニメワールド 🌸",
           "created_at": "2022-03-24T00:44:07.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE0OTY3NzYyMTU5Mzk1MzQ4NDk=",
           "description": "すべてのアニメファンとクリエイターのために!",
           "join_policy": "オープン",
           "access": "公開",
           "member_count": 5612,
           "name": "アニメ",
           "created_at": "2022-02-24T09:17:13.000Z"
       }
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}