메인 콘텐츠로 건너뛰기

​
하위 모듈

​
모듈 내용

이 모듈은 X API의 리스트 엔드포인트에 대한 접근을 제공하며, 리스트 관련 모든 기능의 주요 진입점 역할을 합니다.

​
class xdk.lists.ListsClient

리스트 연산을 위한 Client

​
매개변수

​
path.client
Client

​
__init__

​
매개변수

​
path.client
Client

​
add_member

리스트 멤버 추가 ID로 지정된 특정 리스트에 사용자를 추가합니다.

​
Parameters

​
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를 사용하여 해당 리스트의 세부 정보를 조회합니다.

​
매개변수

​
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"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.

​
반환값

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"
표시할 User 필드를 쉼표로 구분한 목록입니다.
​
path.expansions
List or None
기본값:"None"
확장할 필드를 쉼표로 구분한 목록입니다.
​
path.tweet_fields
List or None
기본값:"None"
표시할 Tweet 필드를 쉼표로 구분한 목록입니다.

​
반환값

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"
표시할 Tweet 필드의 쉼표로 구분된 목록입니다.
​
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를 사용해 해당 리스트에서 사용자를 제거합니다.

​
매개변수

​
path.id
Any
멤버를 제거할 리스트의 ID입니다.
​
path.user_id
Any
리스트에서 제거할 사용자의 ID입니다.

​
반환값

RemoveMemberByUserIdResponse - 응답 데이터

​
update

리스트 업데이트 인증된 사용자가 소유한 특정 리스트를 ID로 지정해 해당 리스트의 세부 정보를 업데이트합니다.

​
매개변수

​
path.id
Any
수정할 리스트의 ID입니다.
​
body.body
UpdateRequest
요청 본문