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

​
サブモジュール

​
モジュールの内容

このモジュールは X API の spaces エンドポイントへのアクセス手段を提供し、 spaces 関連のすべての機能に対する主なエントリポイントとして機能します。

​
class xdk.spaces.SpacesClient

Spaces に関する各種操作を行うための Client です

​
パラメータ

​
path.client
Client

​
__init__

​
パラメータ

​
path.client
Client

​
get_buyers

Spaceのチケット購入者を取得 特定のSpaceの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"
表示するツイートのフィールドをカンマ区切りで指定するリストです。

​
戻り値

IteratorGetBuyersResponse

​
get_by_creator_ids

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

​
パラメーター

​
path.user_ids
List
検索対象とする User の 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 フィールドをカンマ区切りで指定します。

​
戻り値

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

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

​
Parameters

​
path.id
str
取得するSpaceのID。
​
path.max_results
int or None
デフォルト:"None"
指定されたSpaceから取得する投稿数。指定しない場合、最大値である100がデフォルトになります。
​
path.tweet_fields
List or None
デフォルト:"None"
表示するTweetフィールドを、カンマ区切りのリストで指定します。
​
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 - レスポンスデータ