하위 모듈
- 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
Parameters
인증된 사용자가 DM 수신 차단을 요청하는 대상 사용자의 ID입니다.
반환값
BlockDmsResponse - 응답 데이터
create_bookmark
매개변수
북마크를 추가할 인증된 소스 사용자의 ID입니다.
요청 본문
delete_bookmark
매개변수
북마크를 제거하려는 인증된 소스 사용자의 ID입니다.
소스 사용자가 북마크에서 제거하려는 게시물의 ID입니다.
반환
DeleteBookmarkResponse - 응답 데이터
follow_list
매개변수
리스트를 팔로우할 인증된 소스 사용자의 ID입니다.
요청 본문
follow_user
매개변수
대상 사용자를 팔로우하도록 요청하는, 인증된 소스 사용자의 ID입니다.
요청 본문
get_blocking
매개변수
결과를 반환할 인증된 소스 User의 id입니다.
결과의 최대 개수입니다.
특정 ‘페이지’의 결과를 가져오는 데 사용되는 매개변수입니다.
표시할 User 필드의 쉼표로 구분된 목록입니다.
확장할 필드의 쉼표로 구분된 목록입니다.
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
반환값
IteratorGetBlockingResponse
get_bookmark_folders
매개변수
결과를 반환할 인증된 소스 사용자의 id입니다.
결과의 최대 개수입니다.
이 매개변수는 다음 ‘페이지’의 결과를 가져오는 데 사용됩니다.
반환값
IteratorGetBookmarkFoldersResponse
get_bookmarks
매개변수
결과를 반환할 인증된 소스 사용자의 ID입니다.
결과의 최대 개수입니다.
결과의 다음 ‘페이지’를 가져오는 데 사용하는 매개변수입니다.
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
확장할 필드의 쉼표로 구분된 목록입니다.
표시할 Media 필드의 쉼표로 구분된 목록입니다.
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
표시할 User 필드의 쉼표로 구분된 목록입니다.
표시할 Place 필드의 쉼표로 구분된 목록입니다.
반환값
IteratorGetBookmarksResponse
get_bookmarks_by_folder_id
매개변수
결과를 반환할 인증된 소스 사용자의 ID입니다.
인증된 사용자가 포스트를 가져오려는 북마크 폴더의 ID입니다.
반환값
GetBookmarksByFolderIdResponse - 응답 데이터
get_by_id
매개변수
조회할 사용자 ID입니다.
표시할 사용자 필드의 쉼표로 구분된 목록입니다.
확장할 필드의 쉼표로 구분된 목록입니다.
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
반환값
GetByIdResponse - 응답 데이터
get_by_ids
매개변수
쉼표로 구분된 User ID 목록입니다. 최대 100개의 ID를 지정할 수 있습니다.
표시할 User 필드의 쉼표로 구분된 목록입니다.
확장할 필드의 쉼표로 구분된 목록입니다.
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
반환값
GetByIdsResponse - 응답 데이터
get_by_username
매개변수
사용자 이름.
표시할 User 필드의 쉼표로 구분된 목록.
확장할 필드의 쉼표로 구분된 목록.
표시할 Tweet 필드의 쉼표로 구분된 목록.
반환
GetByUsernameResponse - 응답 데이터
get_by_usernames
파라미터
쉼표로 구분된 username 목록입니다.
표시할 User 필드를 쉼표로 구분한 목록입니다.
확장할 필드를 쉼표로 구분한 목록입니다.
표시할 Tweet 필드를 쉼표로 구분한 목록입니다.
반환 값
GetByUsernamesResponse - 응답 데이터
get_followed_lists
특정 사용자의 id를 사용해 해당 사용자가 팔로우하는 리스트 목록을 조회합니다.
매개변수
조회할 User의 id입니다.
결과의 최대 개수입니다.
지정된 ‘페이지’의 결과를 가져오는 데 사용되는 매개변수입니다.
표시할 List 필드를 쉼표로 구분한 목록입니다.
확장할 필드를 쉼표로 구분한 목록입니다.
표시할 User 필드를 쉼표로 구분한 목록입니다.
반환
IteratorGetFollowedListsResponse
get_followers
매개변수
조회할 사용자 ID입니다.
결과의 최대 개수입니다.
지정된 페이지의 결과를 가져오는 데 사용되는 파라미터입니다.
표시할 사용자 필드를 쉼표로 구분한 목록입니다.
확장할 필드를 쉼표로 구분한 목록입니다.
표시할 Tweet 필드를 쉼표로 구분한 목록입니다.
반환값
IteratorGetFollowersResponse
get_following
Parameters
조회할 User의 ID입니다.
결과의 최대 개수입니다.
지정된 ‘페이지’의 결과를 가져오는 데 사용되는 매개변수입니다.
표시할 User 필드를 쉼표로 구분한 목록입니다.
확장할 필드를 쉼표로 구분한 목록입니다.
표시할 Tweet 필드를 쉼표로 구분한 목록입니다.
반환값
IteratorGetFollowingResponse
get_liked_posts
Parameters
조회할 사용자의 ID입니다.
결과의 최대 개수입니다.
다음 결과 페이지를 가져오는 데 사용되는 매개변수입니다.
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
확장할 필드의 쉼표로 구분된 목록입니다.
표시할 Media 필드의 쉼표로 구분된 목록입니다.
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
표시할 User 필드의 쉼표로 구분된 목록입니다.
표시할 Place 필드의 쉼표로 구분된 목록입니다.
반환 값
IteratorGetLikedPostsResponse
get_list_memberships
매개변수
조회할 사용자의 ID입니다.
결과의 최대 개수입니다.
지정된 ‘페이지’의 결과를 가져오는 데 사용되는 매개변수입니다.
표시할 리스트 필드를 쉼표로 구분한 목록입니다.
확장할 필드를 쉼표로 구분한 목록입니다.
표시할 사용자 필드를 쉼표로 구분한 목록입니다.
반환값
IteratorGetListMembershipsResponse
get_me
매개변수
표시할 User 필드의 쉼표로 구분된 목록입니다.
확장할 필드의 쉼표로 구분된 목록입니다.
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
반환 값
GetMeResponse - 응답 데이터
get_mentions
Parameters
조회할 사용자의 ID입니다.
결과 집합에 포함될 최소 게시물 ID입니다. 이 파라미터와 start_time이 모두 지정된 경우, 이 파라미터가 우선합니다.
결과 집합에 포함될 최대 게시물 ID입니다. 이 파라미터와 end_time이 모두 지정된 경우, 이 파라미터가 우선합니다.
결과의 최대 개수입니다.
다음 ‘페이지’의 결과를 가져오는 데 사용되는 파라미터입니다.
YYYY-MM-DDTHH:mm:ssZ. 게시물이 제공될 가장 이른 UTC 타임스탬프입니다. since_id 파라미터도 지정된 경우, since_id가 우선합니다.
YYYY-MM-DDTHH:mm:ssZ. 게시물이 제공될 가장 늦은 UTC 타임스탬프입니다. until_id 파라미터도 지정된 경우, until_id가 우선합니다.
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
확장할 필드의 쉼표로 구분된 목록입니다.
표시할 Media 필드의 쉼표로 구분된 목록입니다.
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
표시할 User 필드의 쉼표로 구분된 목록입니다.
표시할 Place 필드의 쉼표로 구분된 목록입니다.
반환값
IteratorGetMentionsResponse
get_muting
Parameters
결과를 반환할 인증된 소스 사용자(User)의 ID입니다.
결과 수의 최댓값입니다.
다음 ‘페이지’의 결과를 가져오는 데 사용하는 파라미터입니다.
표시할 User 필드의 쉼표로 구분된 리스트입니다.
확장할 필드의 쉼표로 구분된 리스트입니다.
표시할 Tweet 필드의 쉼표로 구분된 리스트입니다.
반환값
IteratorGetMutingResponse
get_owned_lists
매개변수
조회할 사용자 id입니다.
결과의 최대 개수입니다.
특정 ‘페이지’의 결과를 가져오는 데 사용되는 매개변수입니다.
표시할 리스트 필드를 쉼표로 구분된 목록입니다.
확장할 필드를 쉼표로 구분된 목록입니다.
표시할 사용자 필드를 쉼표로 구분된 목록입니다.
반환값
IteratorGetOwnedListsResponse
get_pinned_lists
매개변수
결과를 반환할 인증된 소스 사용자(User)의 ID입니다.
표시할 리스트 필드의 쉼표로 구분된 목록입니다.
확장할 필드의 쉼표로 구분된 목록입니다.
표시할 User 필드의 쉼표로 구분된 목록입니다.
반환
GetPinnedListsResponse - 응답 데이터
get_posts
파라미터
조회할 사용자의 ID입니다.
결과 집합에 포함될 최소 게시물 ID입니다. 이 파라미터와 start_time이 모두 지정된 경우 이 파라미터가 우선합니다.
결과 집합에 포함될 최대 게시물 ID입니다. 이 파라미터와 end_time이 모두 지정된 경우 이 파라미터가 우선합니다.
결과의 최대 개수입니다.
다음 “페이지”의 결과를 가져오는 데 사용되는 파라미터입니다.
제외할 엔티티 집합입니다(예: “replies” 또는 “retweets”).
YYYY-MM-DDTHH:mm:ssZ 형식. 이 UTC 타임스탬프 이후부터 포스트가 제공됩니다. since_id 파라미터도 지정된 경우 해당 파라미터가 우선합니다.
YYYY-MM-DDTHH:mm:ssZ 형식. 이 UTC 타임스탬프까지 포스트가 제공됩니다. until_id 파라미터도 지정된 경우 해당 파라미터가 우선합니다.
표시할 Tweet 필드의 쉼표로 구분된 리스트입니다.
확장할 필드의 쉼표로 구분된 리스트입니다.
표시할 Media 필드의 쉼표로 구분된 리스트입니다.
표시할 Poll 필드의 쉼표로 구분된 리스트입니다.
표시할 User 필드의 쉼표로 구분된 리스트입니다.
표시할 Place 필드의 쉼표로 구분된 리스트입니다.
반환값
IteratorGetPostsResponse
get_reposts_of_me
파라미터
결과의 최대 개수입니다.
다음 페이지의 결과를 가져오는 데 사용되는 파라미터입니다.
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
확장할 필드의 쉼표로 구분된 목록입니다.
표시할 Media 필드의 쉼표로 구분된 목록입니다.
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
표시할 User 필드의 쉼표로 구분된 목록입니다.
표시할 Place 필드의 쉼표로 구분된 목록입니다.
반환값
IteratorGetRepostsOfMeResponse
get_timeline
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가 우선합니다.
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
확장할 필드의 쉼표로 구분된 목록입니다.
표시할 Media 필드의 쉼표로 구분된 목록입니다.
표시할 Poll 필드의 쉼표로 구분된 목록입니다.
표시할 User 필드의 쉼표로 구분된 목록입니다.
표시할 Place 필드의 쉼표로 구분된 목록입니다.
반환값
IteratorGetTimelineResponse
like_post
매개변수
게시물에 좋아요를 누르려는 인증된 소스 사용자의 ID입니다.
요청 본문
mute_user
매개변수
대상 User를 뮤트하도록 요청하는 인증된 소스 User의 ID입니다.
요청 본문입니다.
pin_list
매개변수
리스트를 고정할 인증된 소스 사용자의 ID입니다.
요청 본문입니다.
repost_post
매개변수
게시물 리포스트를 요청하는 인증된 소스 사용자(User)의 ID입니다.
요청 본문입니다.
search
Parameters
사용자를 검색할 때 사용할 쿼리 문자열입니다.
결과의 최대 개수입니다.
이 매개변수는 다음 “페이지”의 결과를 가져오는 데 사용됩니다. 이 매개변수에 사용되는 값은 API 응답에서 직접 가져온 값을 그대로 사용해야 하며, 수정해서는 안 됩니다.
표시할 User 필드를 쉼표로 구분한 목록입니다.
확장할 필드를 쉼표로 구분한 목록입니다.
표시할 Tweet 필드를 쉼표로 구분한 목록입니다.
반환값
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
Parameters
결과를 조회할 인증된 소스 사용자(User)의 ID입니다.
고정 해제할 리스트(List)의 ID입니다.
반환값
UnpinListResponse - 응답 데이터
unrepost_post
매개변수
게시물을 리포스트하려는 인증된 원본 사용자의 ID입니다.
사용자가 리트윗 취소를 요청하는 게시물의 ID입니다.
반환
UnrepostPostResponse - 응답 데이터