> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# CommunitiesClient

<div id="submodules">
  ## サブモジュール
</div>

* [xdk.communities.client モジュール](/ja/xdks/python/reference/xdk.communities.client)
  * [`CommunitiesClient`](/ja/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient)
    * [`CommunitiesClient.__init__()`](/ja/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.__init__)
    * [`CommunitiesClient.get_by_id()`](/ja/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.get_by_id)
    * [`CommunitiesClient.search()`](/ja/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.search)
* [xdk.communities.models モジュール](/ja/xdks/python/reference/xdk.communities.models)
  * [`GetByIdResponse`](/ja/xdks/python/reference/xdk.communities.models#xdk.communities.models.GetByIdResponse)
    * [`GetByIdResponse.model_config`](/ja/xdks/python/reference/xdk.communities.models#xdk.communities.models.GetByIdResponse.model_config)
  * [`SearchResponse`](/ja/xdks/python/reference/xdk.communities.models#xdk.communities.models.SearchResponse)
    * [`SearchResponse.model_config`](/ja/xdks/python/reference/xdk.communities.models#xdk.communities.models.SearchResponse.model_config)

<div id="module-contents">
  ## モジュール内容
</div>

このモジュールは X API の communities エンドポイントへのアクセスを提供し、
communities 関連のあらゆる機能へのメインエントリーポイントとして機能します。

<div id="class-xdkcommunitiescommunitiesclient">
  ### `class xdk.communities.CommunitiesClient`
</div>

コミュニティ関連の操作を行うための Client

<div id="parameters">
  #### パラメーター
</div>

<ParamField path="path.client" type="Client" />

<div id="__init__">
  ### `__init__`
</div>

#### パラメータ

<ParamField path="path.client" type="Client" />

<div id="get_by_id">
  ### `get_by_id`
</div>

ID で Community を取得する
指定した ID の Community の詳細を取得します。

<div id="parameters">
  #### パラメーター
</div>

<ParamField path="path.id" type="Any">
  コミュニティの ID。
</ParamField>

<ParamField path="path.community_fields" type="List or None" default="None">
  表示するコミュニティのフィールドをカンマ区切りで指定します。
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`GetByIdResponse` - レスポンスデータ

<div id="search">
  ### `search`
</div>

コミュニティの検索
指定した検索クエリに一致するコミュニティのリストを返します。

<div id="parameters">
  #### パラメーター
</div>

<ParamField path="path.query" type="str">
  コミュニティを検索するための検索クエリ。
</ParamField>

<ParamField path="path.max_results" type="int or None" default="None">
  1 回のリクエストで返される検索結果の最大数。
</ParamField>

<ParamField path="path.next_token" type="Any or None" default="None">
  次の「ページ」の結果を取得するために使用されるパラメーターです。このパラメーターに指定する値は、API のレスポンスから直接取得されるものであり、変更してはいけません。
</ParamField>

<ParamField path="path.pagination_token" type="Any or None" default="None">
  次の「ページ」の結果を取得するために使用されるパラメーターです。このパラメーターに指定する値は、API のレスポンスから直接取得されるものであり、変更してはいけません。
</ParamField>

<ParamField path="path.community_fields" type="List or None" default="None">
  表示するコミュニティフィールドをカンマ区切りで指定するリスト。
</ParamField>

<div id="returns">
  #### 戻り値
</div>

`IteratorSearchResponse`