CommunitiesClient

​

サブモジュール

• xdk.communities.client モジュール
  • CommunitiesClient
    • CommunitiesClient.__init__()
    • CommunitiesClient.get_by_id()
    • CommunitiesClient.search()
• xdk.communities.models モジュール
  • GetByIdResponse
    • GetByIdResponse.model_config
  • SearchResponse
    • SearchResponse.model_config

​

モジュール内容

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

​

class xdk.communities.CommunitiesClient

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

​

パラメーター

path.client · Client

​

__init__

​

パラメータ

path.client · Client

​

get_by_id

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

​

パラメーター

path.id · Any

コミュニティの ID。

path.community_fields · List or None · デフォルト: "None"

表示するコミュニティのフィールドをカンマ区切りで指定します。

​

戻り値

GetByIdResponse - レスポンスデータ

​

search

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

​

パラメーター

path.query · str

コミュニティを検索するための検索クエリ。

path.max_results · int or None · デフォルト: "None"

1 回のリクエストで返される検索結果の最大数。

path.next_token · Any or None · デフォルト: "None"

次の「ページ」の結果を取得するために使用されるパラメーターです。このパラメーターに指定する値は、API のレスポンスから直接取得されるものであり、変更してはいけません。

path.pagination_token · Any or None · デフォルト: "None"

次の「ページ」の結果を取得するために使用されるパラメーターです。このパラメーターに指定する値は、API のレスポンスから直接取得されるものであり、変更してはいけません。

path.community_fields · List or None · デフォルト: "None"

表示するコミュニティフィールドをカンマ区切りで指定するリスト。

​

戻り値

IteratorSearchResponse