생성자
constructor
client): PostsClient
새로운 Posts 클라이언트 인스턴스를 생성합니다
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
client | Client | 주요 X API 클라이언트 인스턴스 |
반환값
PostsClient
정의됨
posts/client.ts:453메서드
getInsights28hr
tweetIds, granularity, requestedMetrics, options?): Promise<Get2Insights28hrResponse>
28시간 Post 인사이트 가져오기
지정된 Post의 지난 28시간치 참여 지표를 조회합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
tweetIds | any[] | 28시간 지표용 Post id 목록. |
granularity | string | 지표 응답의 세분화 수준. |
requestedMetrics | any[] | 과거 데이터 요청에 대한 지표 요청 항목. |
options | GetInsights28hrOptions | - |
반환
Promise<Get2Insights28hrResponse>
API 응답으로 resolve되는 Promise
정의
posts/client.ts:478searchRecent
query, options?): Promise<Get2TweetsSearchRecentResponse>
최근 Post 검색
검색 쿼리와 일치하는 지난 7일 이내의 Post를 검색해 가져옵니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
query | string | Posts와 일치시키기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이는 https://t.co/rulelength에서 확인하세요. |
options | SearchRecentOptions | - |
반환
Promise<Get2TweetsSearchRecentResponse>
API 응답으로 resolve되는 Promise
정의 위치
posts/client.ts:540getRepostedBy
id, options?): Promise<Get2TweetsIdRetweetedByResponse>
리포스트한 사용자 가져오기
특정 Post의 id로 해당 Post를 리포스트한 사용자 목록을 가져옵니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 단일 Post ID. |
options | GetRepostedByOptions | - |
반환
Promise<Get2TweetsIdRetweetedByResponse>
API 응답으로 이행되는 Promise
정의 위치
posts/client.ts:670getLikingUsers
id, options?): Promise<Get2TweetsIdLikingUsersResponse>
좋아요한 사용자 가져오기
지정한 Post의 id로 해당 Post에 좋아요를 누른 사용자 목록을 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 단일 Post ID |
options | GetLikingUsersOptions | - |
반환
Promise<Get2TweetsIdLikingUsersResponse>
API 응답으로 resolve되는 Promise
정의된 위치
getInsightsHistorical
tweetIds, endTime, startTime, granularity, requestedMetrics, options?): Promise<Get2InsightsHistoricalResponse>
과거 Post 인사이트 조회
지정된 기간 내 특정 Post의 과거 참여 지표를 조회합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
tweetIds | any[] | 과거 메트릭용 Post id 목록. |
endTime | string | YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 종료 시점을 나타내는 UTC 타임스탬프. |
startTime | string | YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 시작 시점을 나타내는 UTC 타임스탬프. |
granularity | string | 메트릭 응답의 세분성. |
requestedMetrics | any[] | 과거 데이터 조회에 요청할 메트릭. |
options | GetInsightsHistoricalOptions | - |
반환
Promise<Get2InsightsHistoricalResponse>
API 응답으로 이행되는 Promise
정의됨
posts/client.ts:834getReposts
id, options?): Promise<Get2TweetsIdRetweetsResponse>
리포스트 가져오기
지정한 Post의 id를 기준으로 해당 Post를 리포스트한 Post 목록을 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 단일 Post id입니다. |
options | GetRepostsOptions | - |
반환
Promise<Get2TweetsIdRetweetsResponse>
API 응답으로 이행되는 Promise
정의된 위치
hideReply
tweetId, options?): Promise<TweetHideResponse>
답글 숨기기
인증된 사용자가 소유한 대화의 답글을 숨기거나 숨김 해제합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
tweetId | string | 숨기거나 숨김 해제하려는 답글의 id입니다. |
options | HideReplyOptions | - |
반환
Promise<TweetHideResponse>
API 응답으로 해결되는 Promise
정의된 위치
getCountsRecent
query, options?): Promise<Get2TweetsCountsRecentResponse>
최근 Post 개수 가져오기
검색 쿼리와 일치하는 최근 7일간의 Post 개수를 가져옵니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
query | string | Post와 일치하는 항목을 찾기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이는 https://t.co/rulelength 를 참고하세요. |
options | GetCountsRecentOptions | - |
반환
Promise<Get2TweetsCountsRecentResponse>
API 응답으로 resolve되는 Promise
정의됨
posts/client.ts:1046getByIds
ids, options?): Promise<Get2TweetsResponse>
ID로 Post 가져오기
여러 Post를 ID로 조회하여 세부 정보를 반환합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
ids | any[] | 쉼표로 구분된 Post ID 목록입니다. 단일 요청당 최대 100개까지 가능합니다. |
options | GetByIdsOptions | - |
반환
Promise<Get2TweetsResponse>
API 응답으로 해결되는 Promise
정의 위치
posts/client.ts:1140create
body): Promise<TweetCreateResponse>
Post 생성 또는 편집
인증된 사용자의 새 Post를 생성하거나, edit_options가 제공된 경우 기존 Post를 편집합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
body | TweetCreateRequest | 요청 본문 |
반환
Promise<TweetCreateResponse>
API 응답으로 처리되는 Promise
정의 위치
posts/client.ts:1220getById
id, options?): Promise<Get2TweetsIdResponse>
ID로 Post 가져오기
지정한 ID의 특정 Post 상세 정보를 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 단일 Post ID입니다. |
options | GetByIdOptions | - |
반환
Promise<Get2TweetsIdResponse>
API 응답으로 resolve되는 Promise
정의 위치
posts/client.ts:1258delete
id): Promise<TweetDeleteResponse>
Post 삭제
인증된 사용자가 소유한 경우 ID로 지정된 특정 Post를 삭제합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
id | string | 삭제할 Post의 id입니다. |
반환값
Promise<TweetDeleteResponse>
API 응답으로 resolve되는 Promise
정의됨
posts/client.ts:1338getAnalytics
ids, endTime, startTime, granularity, options?): Promise<Analytics>
Post 분석 가져오기
지정된 기간 동안 특정 Post의 분석 data를 조회합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
ids | any[] | 쉼표로 구분된 Post id 목록. 단일 요청당 최대 100개까지 허용됩니다. |
endTime | string | YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 종료 시점을 나타내는 UTC 타임스탬프입니다. |
startTime | string | YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 시작 시점을 나타내는 UTC 타임스탬프입니다. |
granularity | string | 검색 집계 결과의 세분화 수준. |
options | GetAnalyticsOptions | - |
반환값
Promise<Analytics>
API 응답으로 해결되는 Promise
정의 위치
posts/client.ts:1388getCountsAll
query, options?): Promise<Get2TweetsCountsAllResponse>
모든 Post 수 가져오기
전체 아카이브에서 검색 쿼리와 일치하는 Post 수를 조회합니다.
매개변수
| 이름 | 유형 | 설명 |
|---|---|---|
query | string | Post와 일치시키기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이는 https://t.co/rulelength 에서 확인하세요. |
options | GetCountsAllOptions | - |
반환값
Promise<Get2TweetsCountsAllResponse>
API 응답으로 이행되는 Promise
정의됨
posts/client.ts:1455getQuoted
id, options?): Promise<Get2TweetsIdQuoteTweetsResponse>
인용된 Post 가져오기
특정 Post를 id로 인용한 Post 목록을 조회합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 단일 Post ID입니다. |
options | GetQuotedOptions | - |
반환
Promise<Get2TweetsIdQuoteTweetsResponse>
API 응답으로 이행되는 Promise
정의 위치
posts/client.ts:1549searchAll
query, options?): Promise<Get2TweetsSearchAllResponse>
모든 Post 검색
검색 쿼리와 일치하는 전체 보관소에서 Post를 가져옵니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
query | string | Posts와 매칭하기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이는 https://t.co/rulelength 에서 확인하세요. |
options | SearchAllOptions | - |
반환
Promise<Get2TweetsSearchAllResponse>
API 응답으로 resolve되는 Promise