UsersClient
コンストラクター
__init__
パラメータ
block_dms
パラメータ
認証済みユーザーがDMの受信をブロックしようとしている対象ユーザーのID。
戻り値
BlockDmsResponse - レスポンスデータ
create_bookmark
パラメーター
ブックマークを追加する認証済みソースユーザーの ID。
リクエストボディ
delete_bookmark
Parameters
ブックマークを削除する認証済みソースユーザーのID。
送信元ユーザーがブックマークから削除するポストのID。
戻り値
DeleteBookmarkResponse - レスポンスデータ
follow_list
パラメータ
リストをフォローする認証済みユーザーのID。
リクエストボディ
follow_user
Parameters
対象Userのフォローをリクエストしている認証済みの送信元Userのid。
リクエスト本文
get_blocking
Parameters
結果を返す対象の認証済みソースユーザーのID。
結果の最大数。
指定した「ページ」の結果を取得するために使用するパラメータ。
表示するユーザーフィールドのカンマ区切りリスト。
展開するフィールドのカンマ区切りリスト。
表示するツイートフィールドのカンマ区切りリスト。
戻り値
IteratorGetBlockingResponse
get_bookmark_folders
パラメーター
結果を返す対象となる認証済みソースユーザーのIDです。
返される結果の最大数です。
このパラメーターは、次の「ページ」の結果を取得するために使用します。
戻り値
IteratorGetBookmarkFoldersResponse
get_bookmarks
パラメーター
結果を返す対象となる、認証済みソースユーザーのID。
結果の最大件数。
次の「ページ」の結果を取得するために使用されるパラメーター。
表示するツイートのフィールドを、カンマ区切りのリストで指定します。
展開するフィールドを、カンマ区切りのリストで指定します。
表示するメディアのフィールドを、カンマ区切りのリストで指定します。
表示する投票のフィールドを、カンマ区切りのリストで指定します。
表示するユーザーのフィールドを、カンマ区切りのリストで指定します。
表示する場所のフィールドを、カンマ区切りのリストで指定します。
戻り値
IteratorGetBookmarksResponse
get_bookmarks_by_folder_id
パラメーター
結果を返す対象となる、認証済みソースユーザーのID。
認証済みユーザーがポストを取得しようとしているブックマークフォルダーのID。
戻り値
GetBookmarksByFolderIdResponse - レスポンス データ
get_by_id
Parameters
取得するユーザーのID。
表示するユーザーのフィールドをカンマ区切りのリストとして指定します。
展開するフィールドをカンマ区切りのリストとして指定します。
表示するツイートのフィールドをカンマ区切りのリストとして指定します。
戻り値
GetByIdResponse - レスポンスデータ
get_by_ids
Parameters
カンマ区切りのユーザーIDのリストです。最大100件まで指定できます。
表示するユーザーのフィールドをカンマ区切りのリストで指定します。
展開するフィールドをカンマ区切りのリストで指定します。
表示するツイートのフィールドをカンマ区切りのリストで指定します。
戻り値
GetByIdsResponse - レスポンスデータ
get_by_username
パラメーター
ユーザー名。
表示する User フィールドをカンマ区切りのリストで指定します。
展開対象のフィールドをカンマ区切りのリストで指定します。
表示するツイートフィールドをカンマ区切りのリストで指定します。
戻り値
GetByUsernameResponse 型のレスポンスデータ
get_by_usernames
パラメーター
カンマ区切りのユーザー名のリスト。
表示する User フィールドをカンマ区切りで並べたリスト。
展開するフィールドをカンマ区切りで並べたリスト。
表示するツイートのフィールドをカンマ区切りで並べたリスト。
戻り値
GetByUsernamesResponse - レスポンスデータ
get_followed_lists
パラメーター
取得対象のユーザーのIDを指定します。
結果の最大数を指定します。
結果の特定の「ページ」を取得するために使用します。
表示するリストのフィールドをカンマ区切りで指定します。
展開するフィールドをカンマ区切りで指定します。
表示するユーザーのフィールドをカンマ区切りで指定します。
戻り値
IteratorGetFollowedListsResponse
get_followers
パラメータ
取得対象ユーザーの ID。
結果数の上限。
指定した「ページ」に対応する結果を取得するために使用するパラメータです。
表示する User フィールドのカンマ区切りリスト。
展開するフィールドのカンマ区切りリスト。
表示するツイートのフィールドのカンマ区切りリスト。
戻り値
IteratorGetFollowersResponse
get_following
パラメーター
検索対象のユーザーのIDです。
結果の最大数です。
指定した「ページ」の結果を取得するために使用するパラメーターです。
表示するユーザーのフィールドを、カンマ区切りのリストで指定します。
展開するフィールドを、カンマ区切りのリストで指定します。
表示するツイートのフィールドを、カンマ区切りのリストで指定します。
戻り値
IteratorGetFollowingResponse
get_liked_posts
パラメータ
取得対象のユーザーのID。
結果の最大件数。
結果の次ページを取得するために使用されるパラメータ。
表示するツイートのフィールドをカンマ区切りで指定するリスト。
展開するフィールドをカンマ区切りで指定するリスト。
表示するメディアのフィールドをカンマ区切りで指定するリスト。
表示する投票のフィールドをカンマ区切りで指定するリスト。
表示するユーザーのフィールドをカンマ区切りで指定するリスト。
表示する場所のフィールドをカンマ区切りで指定するリスト。
戻り値
IteratorGetLikedPostsResponse
get_list_memberships
Parameters
取得対象ユーザーのIDを指定します。
取得する結果の最大数を指定します。
特定の「ページ」の結果を取得するために使用するページネーション用トークンです。
表示するリストのフィールドを、カンマ区切りで指定します。
展開するフィールドを、カンマ区切りで指定します。
表示するユーザーフィールドを、カンマ区切りで指定します。
戻り値
IteratorGetListMembershipsResponse
get_me
パラメーター
表示する User フィールドをカンマ区切りのリストとして指定します。
展開するフィールドをカンマ区切りのリストとして指定します。
表示するツイートフィールドをカンマ区切りのリストとして指定します。
戻り値
GetMeResponse - レスポンスデータ
get_mentions
Parameters
取得対象ユーザーのID。
結果セットに含める最小のポストID。このパラメーターは、start_time と両方が指定された場合は start_time より優先されます。
結果セットに含める最大のポストID。このパラメーターは、end_time と両方が指定された場合は end_time より優先されます。
結果の最大件数。
次の「ページ」の結果を取得するためのパラメーターです。
YYYY-MM-DDTHH:mm:ssZ。ポストが返される最も早いUTCタイムスタンプ。since_id パラメーターも指定されている場合は、since_id が優先されます。
YYYY-MM-DDTHH:mm:ssZ。ポストが返される最新のUTCタイムスタンプ。until_id パラメーターも指定されている場合は、until_id が優先されます。
表示するツイートのフィールドのカンマ区切りのリスト。
展開するフィールドのカンマ区切りのリスト。
表示するメディアのフィールドのカンマ区切りのリスト。
表示する投票のフィールドのカンマ区切りのリスト。
表示するユーザーのフィールドのカンマ区切りのリスト。
表示する場所のフィールドのカンマ区切りのリスト。
戻り値
IteratorGetMentionsResponse
get_muting
パラメーター
結果を返す対象となる、認証済みソースユーザーの ID。
結果の最大件数。
次の「ページ」の結果を取得するために使用するパラメーター。
表示するユーザーのフィールドをカンマ区切りで指定したリスト。
展開するフィールドをカンマ区切りで指定したリスト。
表示するツイートのフィールドをカンマ区切りで指定したリスト。
戻り値
IteratorGetMutingResponse
get_owned_lists
パラメーター
照会対象のユーザーのID。
結果の最大件数。
指定した「ページ」の結果を取得するために使用されるパラメーターです。
表示するリストのフィールドをカンマ区切りで指定します。
展開するフィールドをカンマ区切りで指定します。
表示するユーザーフィールドをカンマ区切りで指定します。
戻り値
IteratorGetOwnedListsResponse
get_pinned_lists
パラメーター
結果を返す対象となる、認証済みのソースユーザーの ID です。
表示する List オブジェクトのフィールドを、カンマ区切りのリストで指定します。
展開するフィールドを、カンマ区切りのリストで指定します。
表示する User オブジェクトのフィールドを、カンマ区切りのリストで指定します。
戻り値
GetPinnedListsResponse - レスポンスデータ
get_posts
パラメータ
取得対象のユーザーの ID。
結果セットに含める投稿 ID の最小値。このパラメータは、start_time と両方が指定された場合、start_time より優先されます。
結果セットに含める投稿 ID の最大値。このパラメータは、end_time と両方が指定された場合、end_time より優先されます。
取得する結果の最大数。
次の「ページ」の結果を取得するために使用されるパラメータです。
除外するエンティティのセット(例: 「replies」や「retweets」)。
YYYY-MM-DDTHH:mm:ssZ。投稿が返される最も早い UTC タイムスタンプ。since_id パラメータも指定されている場合は、since_id が優先されます。
YYYY-MM-DDTHH:mm:ssZ。投稿が返される最も遅い UTC タイムスタンプ。until_id パラメータも指定されている場合は、until_id が優先されます。
表示するツイートのフィールドをカンマ区切りで指定します。
展開するフィールドをカンマ区切りで指定します。
表示するメディアのフィールドをカンマ区切りで指定します。
表示する投票のフィールドをカンマ区切りで指定します。
表示するユーザーのフィールドをカンマ区切りで指定します。
表示する場所のフィールドをカンマ区切りで指定します。
戻り値
IteratorGetPostsResponse
get_reposts_of_me
パラメーター
返される結果の最大数です。
次の「ページ」の結果を取得するために使用されるパラメーターです。
表示するツイートのフィールドを指定する、カンマ区切りのリストです。
展開するフィールドを指定する、カンマ区切りのリストです。
表示するメディアのフィールドを指定する、カンマ区切りのリストです。
表示する投票のフィールドを指定する、カンマ区切りのリストです。
表示するユーザーのフィールドを指定する、カンマ区切りのリストです。
表示する場所のフィールドを指定する、カンマ区切りのリストです。
戻り値
IteratorGetRepostsOfMeResponse
get_timeline
Parameters
逆時系列タイムラインのポストを一覧取得する対象となる、認証済みソースUserのID。
結果セットに含めるポストIDの最小値。このパラメータは、start_time と両方が指定された場合、start_time より優先されます。
結果セットに含めるポストIDの最大値。このパラメータは、end_time と両方が指定された場合、end_time より優先されます。
結果の最大件数。
次の「ページ」の結果を取得するために使用されるパラメータです。
除外するエンティティの集合(例: 「replies」や「retweets」)。
YYYY-MM-DDTHH:mm:ssZ。ポストが返される最も早いUTCタイムスタンプ。since_id パラメータも指定されている場合は、since_id が優先されます。
YYYY-MM-DDTHH:mm:ssZ。ポストが返される最も遅いUTCタイムスタンプ。until_id パラメータも指定されている場合は、until_id が優先されます。
表示するツイートフィールドをカンマ区切りで指定したリスト。
展開するフィールドをカンマ区切りで指定したリスト。
表示する Media フィールドをカンマ区切りで指定したリスト。
表示する Poll フィールドをカンマ区切りで指定したリスト。
表示する User フィールドをカンマ区切りで指定したリスト。
表示する Place フィールドをカンマ区切りで指定したリスト。
戻り値
IteratorGetTimelineResponse
like_post
パラメータ
ポストに「いいね」を付けるようリクエストしている、認証済みの発信元ユーザーのID。
リクエストボディ
mute_user
パラメーター
ターゲットユーザーのミュートをリクエストしている認証済み送信元ユーザーのID。
リクエストボディ
pin_list
Parameters
リストをピン留めする操作元の認証済みユーザーのid。
リクエストボディ
repost_post
パラメータ
ポストのリポストをリクエストしている、認証済みの送信元ユーザーのID。
リクエストボディ
search
Parameters
ユーザーを検索するためのクエリ文字列。
結果の最大件数。
このパラメータは、次の「ページ」の結果を取得するために使用されます。パラメータに指定する値は API が返すレスポンスからそのまま取得し、変更してはいけません。
表示する User フィールドをカンマ区切りで指定するリスト。
展開するフィールドをカンマ区切りで指定するリスト。
表示するツイートのフィールドをカンマ区切りで指定するリスト。
戻り値
IteratorSearchResponse
unblock_dms
パラメーター
認証済みユーザーが DM のブロックを解除しようとしている対象ユーザーの ID。
戻り値
UnblockDmsResponse - レスポンスデータ
unfollow_list
パラメータ
リストのフォローを解除する認証済みソースユーザーのID。
フォローを解除するリストのID。
戻り値
UnfollowListResponse - レスポンスデータ
unfollow_user
パラメータ
フォロー解除をリクエストしている認証済みソースユーザーのID。
ソースユーザーがフォロー解除をリクエストしているターゲットユーザーのID。
戻り値
UnfollowUserResponse - レスポンスデータ
unlike_post
パラメーター
ポストの「いいね」を取り消すリクエストを行う、認証済みの発信元ユーザーの ID。
ユーザーが「いいね」の取り消しをリクエストしているポストの ID。
戻り値
UnlikePostResponse - レスポンスデータ
unmute_user
パラメータ
ミュート解除を要求する認証済みソースユーザーのID。
ソースユーザーがミュート解除を要求する対象ユーザーのID。
戻り値
UnmuteUserResponse - レスポンスデータ
unpin_list
パラメーター
結果を返す対象となる認証済みソースユーザーのID。
ピン留めを解除するリストのID。
戻り値
UnpinListResponse - レスポンスデータ
unrepost_post
Parameters
リポストをリクエストしている認証済み発信元ユーザーの ID。
ユーザーがリポストの取り消しをリクエストしているポストの ID。
戻り値
UnrepostPostResponse - レスポンスデータ