CommunitiesClient

​

CommunitiesClient

クラス 基底クラス: object

コミュニティに関する操作を行う Client

​

コンストラクタ

​

__init__

​

パラメータ

path.client · Client

​

get_by_id

ID で Community を取得 指定した Community の詳細を、その ID を用いて取得します。

​

Parameters

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