메인 콘텐츠로 건너뛰기
게시물 관련 작업을 위한 Client 이 Client는 X API의 게시물 엔드포인트와 상호 작용하기 위한 메서드를 제공합니다. 인증, 요청 형식 지정, 응답 파싱을 처리하여 게시물 관련 모든 작업을 지원합니다.

생성자

constructor

new PostsClient(client): PostsClient 새 PostsClient 인스턴스를 생성합니다

매개변수

이름타입설명
clientClient주요 X API Client 인스턴스

반환 값

PostsClient

정의된 위치

posts/client.ts:789

메서드

getInsights28hr

getInsights28hr(tweetIds, granularity, requestedMetrics, options): Promise<Response> 28시간 포스트 인사이트 가져오기
지정된 포스트에 대해 지난 28시간 동안의 참여 메트릭을 조회합니다.

매개변수

NameTypeDescription
tweetIdsany[]28시간 메트릭용 게시물 id 목록입니다.
granularitystring메트릭 응답의 세분화 수준입니다.
requestedMetricsany[]과거 데이터 조회를 위한 메트릭을 지정합니다.
optionsGetInsights28hrOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이며, requestOptions.rawtrue인 경우 원시 Response가 반환됩니다

정의된 위치

posts/client.ts:842 getInsights28hr(tweetIds, granularity, requestedMetrics, options?): Promise<Get2Insights28hrResponse>

매개변수

이름타입
tweetIdsany[]
granularitystring
requestedMetricsany[]
options?GetInsights28hrOptions

반환

Promise<Get2Insights28hrResponse>

정의 위치

posts/client.ts:863

getAnalytics

getAnalytics(ids, endTime, startTime, granularity, options): Promise<Response> 게시물 분석 가져오기 정의된 기간 내 지정된 포스트에 대한 분석 데이터를 가져옵니다.

매개변수

NameTypeDescription
idsany[]쉼표로 구분된 게시물 ID 목록입니다. 한 요청당 최대 100개까지 허용됩니다.
endTimestringYYYY-MM-DDTHH:mm:ssZ. 시간 범위의 종료 시점을 나타내는 UTC 타임스탬프입니다.
startTimestringYYYY-MM-DDTHH:mm:ssZ. 시간 범위의 시작 시점을 나타내는 UTC 타임스탬프입니다.
granularitystring검색 카운트 결과의 집계 단위입니다.
optionsGetAnalyticsOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise입니다. 단, requestOptions.raw가 true이면 원시 Response가 반환됩니다.

정의 위치

posts/client.ts:1052 getAnalytics(ids, endTime, startTime, granularity, options?): Promise<Analytics>

매개변수

이름타입
idsany[]
endTimestring
startTimestring
granularitystring
options?GetAnalyticsOptions

반환 값

Promise<Analytics>

정의 위치

posts/client.ts:1077

getReposts

getReposts(id, options): Promise<Response> 리포스트 가져오기 특정 게시물의 id를 사용하여 해당 게시물을 리포스트한 포스트 목록을 조회합니다.

매개변수

NameTypeDescription
idstring단일 게시물 ID입니다.
optionsGetRepostsOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response입니다

정의된 위치

posts/client.ts:1271 getReposts(id, options?): Promise<Get2TweetsIdRetweetsResponse>

매개변수

이름type
idstring
options?GetRepostsOptions

반환값

Promise<Get2TweetsIdRetweetsResponse>

정의된 위치

posts/client.ts:1284

searchRecent

searchRecent(query, options): Promise<Response> 최근 포스트 검색 검색 쿼리와 일치하는 최근 7일간의 포스트를 조회합니다.

매개변수

NameTypeDescription
querystring포스트를 매칭하기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이는 https://t.co/rulelength 에서 확인하세요.
optionsSearchRecentOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response

정의 위치

posts/client.ts:1559 searchRecent(query, options?): Promise<Get2TweetsSearchRecentResponse>

매개변수

이름type
querystring
options?SearchRecentOptions

반환값

Promise<Get2TweetsSearchRecentResponse>

정의된 위치

posts/client.ts:1572

searchAll

searchAll(query, options): Promise<Response> 모든 포스트 검색 검색 쿼리와 일치하는 전체 아카이브의 포스트를 조회합니다.

매개변수

NameTypeDescription
querystring게시물을 일치시키기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이를 확인하려면 https://t.co/rulelength를 참조하세요.
optionsSearchAllOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원본 Response입니다.

정의 위치

posts/client.ts:1968 searchAll(query, options?): Promise<Get2TweetsSearchAllResponse>

매개변수

이름Type
querystring
options?SearchAllOptions

반환값

Promise<Get2TweetsSearchAllResponse>

정의된 위치

posts/client.ts:1981

getByIds

getByIds(ids, options): Promise<Response> id로 포스트 가져오기
여러 포스트의 id를 사용하여 각 포스트의 세부 정보를 조회합니다.

매개변수

NameTypeDescription
idsany[]쉼표로 구분된 게시물 ID 목록입니다. 한 번의 요청에서 최대 100개까지 허용됩니다.
optionsGetByIdsOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response

정의된 곳

posts/client.ts:2365 getByIds(ids, options?): Promise<Get2TweetsResponse>

매개변수

이름타입
idsany[]
options?GetByIdsOptions

반환 값

Promise<Get2TweetsResponse>

정의된 위치

posts/client.ts:2378

create

create(body, options): Promise<Response> 게시물 생성 또는 편집
인증된 사용자의 새 게시물을 생성하거나, edit_options가 제공된 경우 기존 게시물을 편집합니다.

매개변수

이름타입설명
bodyTweetCreateRequest요청 본문
optionsObject-
options.requestOptionsObject-
options.requestOptions.rawtrue-

반환값

Promise<Response> API 응답으로 resolve되는 Promise 또는 requestOptions.rawtrue인 경우에는 원시 Response

정의 위치

posts/client.ts:2622 create(body): Promise<TweetCreateResponse>

매개변수

이름Type
bodyTweetCreateRequest

반환

Promise<TweetCreateResponse>

정의된 위치

posts/client.ts:2633

getQuoted

getQuoted(id, options): Promise<Response> 인용된 포스트 가져오기 지정한 id의 게시물을 인용한 포스트 목록을 가져옵니다.

매개변수

이름type설명
idstring단일 게시물 ID입니다.
optionsGetQuotedOptions & { requestOptions: { raw: true } }-

반환

Promise<Response> API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원본 Response를 반환합니다

정의된 위치

posts/client.ts:2718 getQuoted(id, options?): Promise<Get2TweetsIdQuoteTweetsResponse>

매개변수

이름타입
idstring
options?GetQuotedOptions

반환

Promise<Get2TweetsIdQuoteTweetsResponse>

정의된 위치

posts/client.ts:2731

getCountsRecent

getCountsRecent(query, options): Promise<Response> 최근 포스트 개수 가져오기 검색 쿼리와 일치하는, 최근 7일 이내 포스트 개수를 조회합니다.

Parameters

NameTypeDescription
querystring포스트를 매칭하기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이를 확인하려면 https://t.co/rulelength를 참고하세요.
optionsGetCountsRecentOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true이면 raw Response를 반환합니다

정의된 위치

posts/client.ts:3025 getCountsRecent(query, options?): Promise<Get2TweetsCountsRecentResponse>

매개변수

이름type
querystring
options?GetCountsRecentOptions

반환값

Promise<Get2TweetsCountsRecentResponse>

정의된 위치

posts/client.ts:3038

hideReply

hideReply(tweetId, options): Promise<Response> 답글 숨기기 인증된 사용자가 소유한 대화에 달린 답글을 숨기거나 숨김을 해제합니다.

매개변수

NameTypeDescription
tweetIdstring숨기거나 숨김 해제하려는 답글의 ID입니다.
optionsHideReplyOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response

정의 위치

posts/client.ts:3298 hideReply(tweetId, options?): Promise<TweetHideResponse>

매개변수

이름타입
tweetIdstring
options?HideReplyOptions

반환값

Promise<TweetHideResponse>

정의 위치

posts/client.ts:3311

getInsightsHistorical

getInsightsHistorical(tweetIds, endTime, startTime, granularity, requestedMetrics, options): Promise<Response> 과거 게시물 인사이트 조회 지정된 포스트에 대해 설정된 기간 내의 과거 참여 지표를 반환합니다.

매개변수

NameTypeDescription
tweetIdsany[]과거 메트릭 조회를 위한 PostIds 목록입니다.
endTimestringYYYY-MM-DDTHH:mm:ssZ. 시간 범위의 끝을 나타내는 UTC 타임스탬프입니다.
startTimestringYYYY-MM-DDTHH:mm:ssZ. 시간 범위의 시작을 나타내는 UTC 타임스탬프입니다.
granularitystring메트릭 응답의 세분화 수준입니다.
requestedMetricsany[]과거 조회에 대해 요청할 메트릭입니다.
optionsGetInsightsHistoricalOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이거나, requestOptions.rawtrue인 경우 원본 Response입니다

정의 위치

posts/client.ts:3435 getInsightsHistorical(tweetIds, endTime, startTime, granularity, requestedMetrics, options?): Promise<Get2InsightsHistoricalResponse>

매개변수

이름유형
tweetIdsany[]
endTimestring
startTimestring
granularitystring
requestedMetricsany[]
options?GetInsightsHistoricalOptions

반환

Promise<Get2InsightsHistoricalResponse>

정의된 위치

posts/client.ts:3464

getCountsAll

getCountsAll(query, options): Promise<Response> 모든 포스트 개수 가져오기 전체 아카이브에서 검색 쿼리에 일치하는 포스트의 개수를 조회합니다.

매개변수

NameTypeDescription
querystring포스트를 매칭하기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이를 확인하려면 https://t.co/rulelength를 참고하세요.
optionsGetCountsAllOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response

정의된 위치

posts/client.ts:3679 getCountsAll(query, options?): Promise<Get2TweetsCountsAllResponse>

매개변수

이름타입
querystring
options?GetCountsAllOptions

반환

Promise<Get2TweetsCountsAllResponse>

정의된 위치

posts/client.ts:3692

getById

getById(id, options): Promise<Response> ID로 게시물 조회
주어진 ID로 특정 게시물의 상세 정보를 조회합니다.

매개변수

NameTypeDescription
idstring단일 게시물 id입니다.
optionsGetByIdOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원본 Response

정의 위치

posts/client.ts:3952 getById(id, options?): Promise<Get2TweetsIdResponse>

매개변수

이름타입
idstring
options?GetByIdOptions

반환값

Promise<Get2TweetsIdResponse>

정의된 위치

posts/client.ts:3965

delete

delete(id, options): Promise<Response> 게시물 삭제 인증된 사용자가 소유한 경우, 해당 ID의 특정 게시물을 삭제합니다.

매개변수

NameTypeDescription
idstring삭제할 게시물의 ID입니다.
optionsObject-
options.requestOptionsObject-
options.requestOptions.rawtrue-

반환값

Promise<Response> API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response

정의 위치

posts/client.ts:4202 delete(id): Promise<TweetDeleteResponse>

매개변수

이름타입
idstring

반환 값

Promise<TweetDeleteResponse>

정의 위치

posts/client.ts:4215

getLikingUsers

getLikingUsers(id, options): Promise<Response> 좋아요한 사용자 가져오기 특정 게시물의 id를 기준으로, 해당 게시물을 좋아요한 사용자 목록을 가져옵니다.

매개변수

이름타입설명
idstring단일 게시물 ID입니다.
optionsGetLikingUsersOptions & { requestOptions: { raw: true } }-

반환값

Promise<Response> API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 가공되지 않은 원본 Response를 그대로 반환합니다

정의 위치

posts/client.ts:4306 getLikingUsers(id, options?): Promise<Get2TweetsIdLikingUsersResponse>

매개변수

이름타입
idstring
options?GetLikingUsersOptions

반환값

Promise<Get2TweetsIdLikingUsersResponse>

정의된 위치

posts/client.ts:4319

getRepostedBy

getRepostedBy(id, options): Promise<Response> 리포스트한 사용자 조회
특정 게시물 ID를 기준으로, 해당 게시물을 리포스트한 사용자 목록을 가져옵니다.

매개변수

NameTypeDescription
idstring단일 게시물 ID입니다.
optionsGetRepostedByOptions & { requestOptions: { raw: true } }-

반환

Promise<Response> API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response

정의 위치

posts/client.ts:4525 getRepostedBy(id, options?): Promise<Get2TweetsIdRetweetedByResponse>

매개변수

이름타입
idstring
options?GetRepostedByOptions

반환값

Promise<Get2TweetsIdRetweetedByResponse>

정의된 위치

posts/client.ts:4538