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

​
サブモジュール

​
モジュールの内容

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

​
class xdk.lists.ListsClient

リスト操作用のクライアント

​
パラメータ

​
path.client
Client

​
__init__

​
パラメータ

​
path.client
Client

​
add_member

リストメンバーの追加 ID で指定された特定のリストにユーザーを追加します。

​
パラメータ

​
path.id
Any
メンバーを追加するリストのID。
​
body.body
AddMemberRequest
リクエストボディ

​
create

リストを作成 認証済みユーザーの新しいリストを作成します。 body: リクエストボディ :returns: レスポンスデータ :rtype: CreateResponse

​
パラメータ

​
body.body
CreateRequest

​
delete

リストを削除します 認証済みユーザーが所有する特定のリストを、そのIDを指定して削除します。

​
パラメーター

​
path.id
Any
削除するリストの ID。

​
戻り値

DeleteResponse - レスポンスデータ

​
get_by_id

ID でリストを取得 指定した ID を持つリストの詳細を取得します。

​
Parameters

​
path.id
Any
リストのID。
​
path.list_fields
List or None
デフォルト:"None"
表示するリストのフィールドをカンマ区切りで指定します。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りで指定します。
​
path.user_fields
List or None
デフォルト:"None"
表示するユーザーフィールドをカンマ区切りで指定します。

​
戻り値

GetByIdResponse - レスポンスデータ

​
get_followers

リストのフォロワーを取得する 特定のリストをフォローしているユーザーの一覧を、そのリストのIDを指定して取得します。

​
パラメーター

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

​
戻り値

IteratorGetFollowersResponse

​
get_members

リストメンバーを取得 特定のリストのidを指定して、そのリストに属するユーザーの一覧を取得します。

​
パラメーター

​
path.id
Any
リストのID。
​
path.max_results
int or None
デフォルト:"None"
取得する結果の最大数。
​
path.pagination_token
Any or None
デフォルト:"None"
このパラメーターは、特定の「ページ」の結果を取得するために使用します。
​
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドを、カンマ区切りのリストで指定します。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドを、カンマ区切りのリストで指定します。
​
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートのフィールドを、カンマ区切りのリストで指定します。

​
戻り値

IteratorGetMembersResponse

​
get_posts

リストの投稿を取得 特定のリストの ID を指定して、そのリストに関連付けられた投稿の一覧を取得します。

​
パラメーター

​
path.id
Any
リストの ID。
​
path.max_results
int or None
デフォルト:"None"
結果の最大件数。
​
path.pagination_token
Any or None
デフォルト:"None"
このパラメーターは、結果の次の「ページ」を取得するために使用します。
​
path.tweet_fields
List or None
デフォルト:"None"
表示するツイートフィールドをカンマ区切りで指定したリスト。
​
path.expansions
List or None
デフォルト:"None"
展開するフィールドをカンマ区切りで指定したリスト。
​
path.media_fields
List or None
デフォルト:"None"
表示するメディアフィールドをカンマ区切りで指定したリスト。
​
path.poll_fields
List or None
デフォルト:"None"
表示する Poll フィールドをカンマ区切りで指定したリスト。
​
path.user_fields
List or None
デフォルト:"None"
表示する User フィールドをカンマ区切りで指定したリスト。
​
path.place_fields
List or None
デフォルト:"None"
表示する Place フィールドをカンマ区切りで指定したリスト。

​
戻り値

IteratorGetPostsResponse

​
remove_member_by_user_id

リストのメンバーを削除する
指定したリストのIDとユーザーのIDを使って、そのリストからユーザーを削除します。

​
パラメーター

​
path.id
Any
メンバーを削除する対象のリストのid。
​
path.user_id
Any
リストから削除するユーザーのid。

​
戻り値

RemoveMemberByUserIdResponse - レスポンスデータ

​
update

リストを更新する 認証済みのユーザーが所有する特定のリストの詳細を、その id を指定して更新します。

​
パラメータ

​
path.id
Any
更新するリストのID。
​
body.body
UpdateRequest
リクエスト本文