メインコンテンツへスキップ

​
SpacesClient

クラス 基底クラス: object Spaces の操作を行うための Client

​
コンストラクター

​
__init__

​
パラメータ

​
path.client
Client

​
get_buyers

スペースのチケット購入者を取得 指定したスペースIDに対して、そのチケットを購入したユーザーのリストを取得します。

​
パラメータ

​
path.id
str
取得するSpaceのID。
​
path.pagination_token
Any or None
デフォルト:"None"
指定した「ページ」の結果を取得するためのパラメータ。
​
path.max_results
int or None
デフォルト:"None"
結果の最大件数。
​
path.user_fields
List or None
デフォルト:"None"
表示するUserフィールドをカンマ区切りで指定したリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りで指定したリスト。
​
path.tweet_fields
List or None
デフォルト:"None"
表示するTweetフィールドをカンマ区切りで指定したリスト。

​
戻り値

IteratorGetBuyersResponse

​
get_by_creator_ids

作成者IDを指定してSpacesを取得します 指定したユーザーIDが作成したSpacesの詳細を取得します。

​
パラメーター

​
path.user_ids
List
検索対象とするユーザーのID。
​
path.space_fields
List or None
デフォルト:"None"
表示するスペースのフィールドをコンマ区切りで指定します。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドをコンマ区切りで指定します。
​
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドをコンマ区切りで指定します。
​
path.topic_fields
List or None
デフォルト:"None"
表示するトピックのフィールドをコンマ区切りで指定します。

​
戻り値

GetByCreatorIdsResponse - レスポンスデータ

​
get_by_id

ID でスペースを取得 指定した ID のスペースの詳細を取得します。

​
パラメーター

​
path.id
str
取得する Space の ID。
​
path.space_fields
List or None
デフォルト:"None"
レスポンスに含める Space フィールドをカンマ区切りのリストで指定します。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りのリストで指定します。
​
path.user_fields
List or None
デフォルト:"None"
レスポンスに含める User フィールドをカンマ区切りのリストで指定します。
​
path.topic_fields
List or None
デフォルト:"None"
レスポンスに含める Topic フィールドをカンマ区切りのリストで指定します。

​
戻り値

GetByIdResponse - レスポンスデータ

​
get_by_ids

ID を指定して Space を取得する 複数の Space を ID で指定して詳細情報を取得します。

​
パラメーター

​
path.ids
List
返す Space ID のリスト。
​
path.space_fields
List or None
デフォルト:"None"
表示する Space フィールドのカンマ区切りのリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドのカンマ区切りのリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示する User フィールドのカンマ区切りのリスト。
​
path.topic_fields
List or None
デフォルト:"None"
表示する Topic フィールドのカンマ区切りのリスト。

​
戻り値

GetByIdsResponse - レスポンスデータ

​
get_posts

Space の投稿を取得 特定の Space 内で共有された投稿の一覧を、その ID を指定して取得します。

​
パラメーター

​
path.id
str
取得するスペースのID。
​
path.max_results
int or None
デフォルト:"None"
指定されたスペースから取得する投稿数。指定しない場合は、最大値である100が使用されます。
​
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートフィールドをカンマ区切りで指定するリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りで指定するリスト。
​
path.media_fields
List or None
デフォルト:"None"
表示するMediaフィールドをカンマ区切りで指定するリスト。
​
path.poll_fields
List or None
デフォルト:"None"
表示するPollフィールドをカンマ区切りで指定するリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示するUserフィールドをカンマ区切りで指定するリスト。
​
path.place_fields
List or None
デフォルト:"None"
表示するPlaceフィールドをカンマ区切りで指定するリスト。

​
戻り値

GetPostsResponse - レスポンスデータ スペースを検索する 指定したクエリに一致するスペースのリストを取得します。

​
パラメーター

​
path.query
str
検索クエリ。
​
path.state
str or None
デフォルト:"None"
検索対象とするSpaceの状態。
​
path.max_results
int or None
デフォルト:"None"
返す結果の数。
​
path.space_fields
List or None
デフォルト:"None"
表示するSpaceのフィールドを指定するカンマ区切りのリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドを指定するカンマ区切りのリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示するUserのフィールドを指定するカンマ区切りのリスト。
​
path.topic_fields
List or None
デフォルト:"None"
表示するTopicのフィールドを指定するカンマ区切りのリスト。

​
戻り値

SearchResponse 型のレスポンスデータ