はじめに

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

これらのendpointにアクセスするには、以下が必要です。

• 承認済みのデベロッパーアカウント。
• Project 内にある開発者用 Appのキーおよびトークンを使用した認証。 

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

はじめに

​

認証

この endpoint は、OAuth 1.0a ユーザーコンテキスト、OAuth 2.0 App-Only、または OAuth 2.0 Authorization Code（PKCE 付き） のいずれかで認証できます。  

​

リクエストの送信

以下のように、id を指定して Communities Lookup endpoint を呼び出せます（id 1758747817642700922 を使用）:

      curl --location 'https://api.x.com/2/communities/1758747817642700922' --header 'Authorization: ••••••'

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

{
    "data": {
        "access": "Public",
        "description": "アニメコミュニティへようこそ！アニメファンが集まり、お気に入りの作品を共有し、アニメに関するあらゆることについて語り合う場所です。",
        "join_policy": "Open",
        "name": "アニメコミュニティ"
    }
}

​

コミュニティ 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	コミュニティに参加しているメンバー数。

​

リクエスト例

以下のように、追加のコミュニティ fields を指定して Communities Lookup endpoint を呼び出せます（ID 1758747817642700922 を使用）:

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

レスポンス例

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

{
    "data": {
        "description": "アニメコミュニティへようこそ！アニメファンが集まってお気に入りの作品を共有し、アニメに関するあらゆることを語り合う場所です。",
        "access": "公開",
        "member_count": 40369,
        "created_at": "2024-02-17T06:58:50.000Z",
        "join_policy": "オープン",
        "name": "アニメコミュニティ",
        "id": "Q29tbXVuaXR5OjE3NTg3NDc4MTc2NDI3MDA5MjI="
    }
}