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

​
ListsClient

クラス 基底クラス: object リスト関連の操作を行う 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を指定して削除します。

​
Parameters

​
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"
表示するユーザーのフィールドをカンマ区切りのリストで指定します。
​
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"
表示する投票のフィールドを、カンマ区切りで指定します。
​
path.user_fields
List or None
デフォルト:"None"
表示するユーザーのフィールドを、カンマ区切りで指定します。
​
path.place_fields
List or None
デフォルト:"None"
表示する場所のフィールドを、カンマ区切りで指定します。

​
戻り値

IteratorGetPostsResponse

​
remove_member_by_user_id

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

​
Parameters

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

​
戻り値

RemoveMemberByUserIdResponse - レスポンスデータ

​
update

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

​
パラメータ

​
path.id
Any
変更するリストのID。
​
body.body
UpdateRequest
リクエストボディ