サブモジュール
- xdk.users.client モジュール
UsersClientUsersClient.__init__()UsersClient.block_dms()UsersClient.create_bookmark()UsersClient.delete_bookmark()UsersClient.follow_list()UsersClient.follow_user()UsersClient.get_blocking()UsersClient.get_bookmark_folders()UsersClient.get_bookmarks()UsersClient.get_bookmarks_by_folder_id()UsersClient.get_by_id()UsersClient.get_by_ids()UsersClient.get_by_username()UsersClient.get_by_usernames()UsersClient.get_followed_lists()UsersClient.get_followers()UsersClient.get_following()UsersClient.get_liked_posts()UsersClient.get_list_memberships()UsersClient.get_me()UsersClient.get_mentions()UsersClient.get_muting()UsersClient.get_owned_lists()UsersClient.get_pinned_lists()UsersClient.get_posts()UsersClient.get_reposts_of_me()UsersClient.get_timeline()UsersClient.like_post()UsersClient.mute_user()UsersClient.pin_list()UsersClient.repost_post()UsersClient.search()UsersClient.unblock_dms()UsersClient.unfollow_list()UsersClient.unfollow_user()UsersClient.unlike_post()UsersClient.unmute_user()UsersClient.unpin_list()UsersClient.unrepost_post()
- xdk.users.models モジュール
BlockDmsResponseCreateBookmarkRequestCreateBookmarkResponseDeleteBookmarkResponseFollowListRequestFollowListResponseFollowUserRequestFollowUserResponseGetBlockingResponseGetBookmarkFoldersResponseGetBookmarksByFolderIdResponseGetBookmarksResponseGetByIdResponseGetByIdsResponseGetByUsernameResponseGetByUsernamesResponseGetFollowedListsResponseGetFollowersResponseGetFollowingResponseGetLikedPostsResponseGetListMembershipsResponseGetMeResponseGetMentionsResponseGetMutingResponseGetOwnedListsResponseGetPinnedListsResponseGetPostsResponseGetRepostsOfMeResponseGetTimelineResponseLikePostRequestLikePostResponseMuteUserRequestMuteUserResponsePinListRequestPinListResponseRepostPostRequestRepostPostResponseSearchResponseUnblockDmsResponseUnfollowListResponseUnfollowUserResponseUnlikePostResponseUnmuteUserResponseUnpinListResponseUnrepostPostResponse
モジュールの内容
class xdk.users.UsersClient
パラメータ
__init__
パラメータ
block_dms
パラメーター
認証済みユーザーがDMのブロックをリクエストしている対象ユーザーのID。
戻り値
BlockDmsResponse - レスポンスデータ
create_bookmark
パラメータ
ブックマークを追加する対象となる認証済みソースユーザーのID。
リクエストボディ
delete_bookmark
パラメータ
ブックマークを削除する認証済み送信元ユーザーのID。
送信元ユーザーがブックマークから削除するポストのID。
戻り値
DeleteBookmarkResponse - レスポンスデータ
follow_list
認証済みユーザーが、指定したIDの特定のリストをフォローします。
パラメーター
リストをフォローする認証済みソースユーザーのID。
リクエストボディ
follow_user
パラメータ
対象ユーザーのフォローをリクエストしている、認証済み送信元ユーザーのID。
リクエストボディ
get_blocking
パラメーター
結果を返す認証済みソースユーザーのid。
結果の最大件数。
指定した「ページ」の結果を取得するために使用するパラメーター。
表示するユーザーフィールドをカンマ区切りのリストで指定します。
展開するフィールドをカンマ区切りのリストで指定します。
表示するツイートのフィールドをカンマ区切りのリストで指定します。
戻り値
IteratorGetBlockingResponse
get_bookmark_folders
パラメーター
結果を返す認証済みソースユーザーの ID。
結果の最大数。
次の「ページ」の結果を取得するために使用するパラメーターです。
戻り値
IteratorGetBookmarkFoldersResponse
get_bookmarks
パラメーター
結果を返す対象となる認証済みソースユーザーのIDです。
取得する結果の最大数です。
次の「ページ」の結果を取得するために使用するパラメーターです。
表示するツイートのフィールドをカンマ区切りのリストで指定します。
展開するフィールドをカンマ区切りのリストで指定します。
表示するメディアのフィールドをカンマ区切りのリストで指定します。
表示する投票のフィールドをカンマ区切りのリストで指定します。
表示するユーザーのフィールドをカンマ区切りのリストで指定します。
表示する場所のフィールドをカンマ区切りのリストで指定します。
戻り値
IteratorGetBookmarksResponse
get_bookmarks_by_folder_id
パラメーター
結果を返す対象となる認証済み送信元ユーザーの ID。
認証済みユーザーが投稿を取得しようとしているブックマークフォルダの ID。
戻り値
GetBookmarksByFolderIdResponse - レスポンスデータ
get_by_id
パラメーター
取得するユーザーのIDです。
表示するユーザーフィールドをカンマ区切りで指定します。
展開するフィールドをカンマ区切りで指定します。
表示するツイートフィールドをカンマ区切りで指定します。
戻り値
GetByIdResponse - レスポンスデータ
get_by_ids
複数のユーザーの詳細を ID で取得します。
パラメーター
カンマ区切りの User ID のリスト。最大 100 個まで指定できます。
表示する User フィールドのカンマ区切りリスト。
展開するフィールドのカンマ区切りリスト。
表示するツイートフィールドのカンマ区切りリスト。
戻り値
GetByIdsResponse - レスポンスデータ
get_by_username
パラメータ
ユーザー名です。
表示する User フィールドをカンマ区切りのリストで指定します。
展開するフィールドをカンマ区切りのリストで指定します。
表示するツイートフィールドをカンマ区切りのリストで指定します。
戻り値
GetByUsernameResponse - レスポンス データ
get_by_usernames
パラメーター
カンマ区切りのユーザー名のリストです。
表示するUserオブジェクトのフィールドをカンマ区切りで指定するリストです。
展開するフィールドをカンマ区切りで指定するリストです。
表示するTweetオブジェクトのフィールドをカンマ区切りで指定するリストです。
戻り値
GetByUsernamesResponse - レスポンスデータ
get_followed_lists
パラメーター
取得対象のユーザーのID。
結果数の上限。
結果の特定の「ページ」を取得するために使用されるパラメーターです。
表示するリストのフィールドをカンマ区切りで指定します。
展開するフィールドをカンマ区切りで指定します。
表示するユーザーのフィールドをカンマ区切りで指定します。
戻り値
IteratorGetFollowedListsResponse
get_followers
パラメーター
取得対象のユーザーの ID。
返される結果の最大数。
特定の「ページ」に対応する結果を取得するために使用するパラメーター。
表示するユーザーのフィールドをカンマ区切りのリストで指定します。
展開するフィールドをカンマ区切りのリストで指定します。
表示するツイートのフィールドをカンマ区切りのリストで指定します。
戻り値
IteratorGetFollowersResponse
get_following
id に基づいて、そのユーザーがフォローしているユーザーのリストを取得します。
パラメータ
取得するユーザーのID。
結果の最大数。
指定した「ページ」の結果を取得するために使用するパラメータ。
表示するユーザーのフィールドをカンマ区切りで指定したリスト。
展開するフィールドをカンマ区切りで指定したリスト。
表示するツイートのフィールドをカンマ区切りで指定したリスト。
戻り値
IteratorGetFollowingResponse
get_liked_posts
パラメーター
取得対象のユーザーのID。
結果の最大数。
結果の次の「ページ」を取得するために使用されるパラメーターです。
表示するツイートのフィールドをカンマ区切りのリストで指定します。
展開するフィールドをカンマ区切りのリストで指定します。
表示するMediaフィールドをカンマ区切りのリストで指定します。
表示するPollフィールドをカンマ区切りのリストで指定します。
表示するユーザーフィールドをカンマ区切りのリストで指定します。
表示するPlaceフィールドをカンマ区切りのリストで指定します。
戻り値
IteratorGetLikedPostsResponse
get_list_memberships
パラメーター
取得対象のユーザーのID。
結果の最大数。
指定した「ページ」の結果を取得するためのパラメーターです。
表示するリストのフィールドをカンマ区切りで指定したリスト。
展開するフィールドをカンマ区切りで指定したリスト。
表示するユーザーフィールドをカンマ区切りで指定したリスト。
戻り値
IteratorGetListMembershipsResponse
get_me
パラメーター
表示する User フィールドのカンマ区切りリストです。
展開対象のフィールドのカンマ区切りリストです。
表示する Tweet フィールドのカンマ区切りリストです。
戻り値
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 が優先されます。
表示するツイートのフィールドをカンマ区切りで指定したリスト。
展開するフィールドをカンマ区切りで指定したリスト。
表示する Media のフィールドをカンマ区切りで指定したリスト。
表示する Poll のフィールドをカンマ区切りで指定したリスト。
表示する User のフィールドをカンマ区切りで指定したリスト。
表示する Place のフィールドをカンマ区切りで指定したリスト。
戻り値
IteratorGetMentionsResponse
get_muting
パラメータ
結果を返す対象となる、認証済みのソースユーザーのID。
返される結果の最大数。
結果の次の「ページ」を取得するために使用するパラメータ。
表示するユーザーフィールドをカンマ区切りで指定したリスト。
展開するフィールドをカンマ区切りで指定したリスト。
表示するツイートフィールドをカンマ区切りで指定したリスト。
戻り値
IteratorGetMutingResponse
get_owned_lists
パラメーター
取得対象のユーザーのid。
返される結果の最大数。
結果の特定の「ページ」を取得するために使用するパラメーター。
表示するリストのフィールドをカンマ区切りで指定します。
展開するフィールドをカンマ区切りで指定します。
表示するユーザーのフィールドをカンマ区切りで指定します。
戻り値
IteratorGetOwnedListsResponse
get_pinned_lists
パラメータ
結果を返す対象となる、認証済みソースユーザーの ID。
表示するリストのフィールドをカンマ区切りで指定します。
展開するフィールドをカンマ区切りで指定します。
表示するユーザーフィールドをカンマ区切りで指定します。
戻り値
GetPinnedListsResponse - レスポンスデータ
get_posts
Parameters
取得するユーザーの 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
パラメーター
取得する結果の最大数です。
結果の次の「ページ」を取得するために使用するパラメーターです。
表示するツイートのフィールドを、カンマ区切りのリストで指定します。
展開するフィールドを、カンマ区切りのリストで指定します。
表示する Media フィールドを、カンマ区切りのリストで指定します。
表示する Poll フィールドを、カンマ区切りのリストで指定します。
表示する User フィールドを、カンマ区切りのリストで指定します。
表示する Place フィールドを、カンマ区切りのリストで指定します。
戻り値
IteratorGetRepostsOfMeResponse
get_timeline
パラメーター
逆時系列タイムラインの投稿を取得する認証済みソースユーザーの 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 が優先されます。
表示するツイートのフィールドをカンマ区切りで指定したリスト。
展開するフィールドをカンマ区切りで指定したリスト。
表示するメディアのフィールドをカンマ区切りで指定したリスト。
表示する投票のフィールドをカンマ区切りで指定したリスト。
表示するユーザーのフィールドをカンマ区切りで指定したリスト。
表示する場所のフィールドをカンマ区切りで指定したリスト。
戻り値
IteratorGetTimelineResponse
like_post
パラメーター
ポストへの「いいね」をリクエストしている認証済み送信元ユーザーのID。
リクエストボディ
mute_user
パラメータ
ターゲットユーザーのミュートを要求している、認証済み送信元ユーザーのID。
リクエストボディ
pin_list
パラメーター
リストをピン留めする認証済みソースユーザーのID。
リクエストボディ
repost_post
パラメーター
ポストのリポストをリクエストしている、認証済みの発信元ユーザーの ID。
リクエストボディ
search
パラメーター
ユーザーを検索するためのクエリ文字列です。
結果の最大件数です。
次の「ページ」の結果を取得するために使用されるパラメーターです。このパラメーターで使用する値は、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 - レスポンスデータ