생성자
constructor
client): PostsClient
새 PostsClient 인스턴스를 생성합니다
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
client | Client | 주요 X API Client 인스턴스 |
반환 값
PostsClient
정의된 위치
메서드
getInsights28hr
tweetIds, granularity, requestedMetrics, options): Promise<Response>
28시간 포스트 인사이트 가져오기지정된 포스트에 대해 지난 28시간 동안의 참여 메트릭을 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
tweetIds | any[] | 28시간 메트릭용 게시물 id 목록입니다. |
granularity | string | 메트릭 응답의 세분화 수준입니다. |
requestedMetrics | any[] | 과거 데이터 조회를 위한 메트릭을 지정합니다. |
options | GetInsights28hrOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response가 반환됩니다
정의된 위치
tweetIds, granularity, requestedMetrics, options?): Promise<Get2Insights28hrResponse>
매개변수
| 이름 | 타입 |
|---|---|
tweetIds | any[] |
granularity | string |
requestedMetrics | any[] |
options? | GetInsights28hrOptions |
반환
Promise<Get2Insights28hrResponse>
정의 위치
posts/client.ts:863getAnalytics
ids, endTime, startTime, granularity, options): Promise<Response>
게시물 분석 가져오기
정의된 기간 내 지정된 포스트에 대한 분석 데이터를 가져옵니다.
매개변수
| Name | Type | Description |
|---|---|---|
ids | any[] | 쉼표로 구분된 게시물 ID 목록입니다. 한 요청당 최대 100개까지 허용됩니다. |
endTime | string | YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 종료 시점을 나타내는 UTC 타임스탬프입니다. |
startTime | string | YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 시작 시점을 나타내는 UTC 타임스탬프입니다. |
granularity | string | 검색 카운트 결과의 집계 단위입니다. |
options | GetAnalyticsOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise입니다. 단, requestOptions.raw가 true이면 원시 Response가 반환됩니다.
정의 위치
posts/client.ts:1052 ▸ getAnalytics(ids, endTime, startTime, granularity, options?): Promise<Analytics>
매개변수
| 이름 | 타입 |
|---|---|
ids | any[] |
endTime | string |
startTime | string |
granularity | string |
options? | GetAnalyticsOptions |
반환 값
Promise<Analytics>
정의 위치
posts/client.ts:1077getReposts
id, options): Promise<Response>
리포스트 가져오기
특정 게시물의 id를 사용하여 해당 게시물을 리포스트한 포스트 목록을 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
id | string | 단일 게시물 ID입니다. |
options | GetRepostsOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response입니다
정의된 위치
id, options?): Promise<Get2TweetsIdRetweetsResponse>
매개변수
| 이름 | type |
|---|---|
id | string |
options? | GetRepostsOptions |
반환값
Promise<Get2TweetsIdRetweetsResponse>
정의된 위치
searchRecent
query, options): Promise<Response>
최근 포스트 검색
검색 쿼리와 일치하는 최근 7일간의 포스트를 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
query | string | 포스트를 매칭하기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이는 https://t.co/rulelength 에서 확인하세요. |
options | SearchRecentOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response
정의 위치
posts/client.ts:1559 ▸ searchRecent(query, options?): Promise<Get2TweetsSearchRecentResponse>
매개변수
| 이름 | type |
|---|---|
query | string |
options? | SearchRecentOptions |
반환값
Promise<Get2TweetsSearchRecentResponse>
정의된 위치
searchAll
query, options): Promise<Response>
모든 포스트 검색
검색 쿼리와 일치하는 전체 아카이브의 포스트를 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
query | string | 게시물을 일치시키기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이를 확인하려면 https://t.co/rulelength를 참조하세요. |
options | SearchAllOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원본 Response입니다.
정의 위치
posts/client.ts:1968 ▸ searchAll(query, options?): Promise<Get2TweetsSearchAllResponse>
매개변수
| 이름 | Type |
|---|---|
query | string |
options? | SearchAllOptions |
반환값
Promise<Get2TweetsSearchAllResponse>
정의된 위치
getByIds
ids, options): Promise<Response>
id로 포스트 가져오기여러 포스트의 id를 사용하여 각 포스트의 세부 정보를 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
ids | any[] | 쉼표로 구분된 게시물 ID 목록입니다. 한 번의 요청에서 최대 100개까지 허용됩니다. |
options | GetByIdsOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response
정의된 곳
posts/client.ts:2365 ▸ getByIds(ids, options?): Promise<Get2TweetsResponse>
매개변수
| 이름 | 타입 |
|---|---|
ids | any[] |
options? | GetByIdsOptions |
반환 값
Promise<Get2TweetsResponse>
정의된 위치
create
body, options): Promise<Response>
게시물 생성 또는 편집인증된 사용자의 새 게시물을 생성하거나,
edit_options가 제공된 경우 기존 게시물을 편집합니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
body | TweetCreateRequest | 요청 본문 |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우에는 원시 Response
정의 위치
posts/client.ts:2622 ▸ create(body): Promise<TweetCreateResponse>
매개변수
| 이름 | Type |
|---|---|
body | TweetCreateRequest |
반환
Promise<TweetCreateResponse>
정의된 위치
getQuoted
id, options): Promise<Response>
인용된 포스트 가져오기
지정한 id의 게시물을 인용한 포스트 목록을 가져옵니다.
매개변수
| 이름 | type | 설명 |
|---|---|---|
id | string | 단일 게시물 ID입니다. |
options | GetQuotedOptions & { requestOptions: { raw: true } } | - |
반환
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원본 Response를 반환합니다
정의된 위치
id, options?): Promise<Get2TweetsIdQuoteTweetsResponse>
매개변수
| 이름 | 타입 |
|---|---|
id | string |
options? | GetQuotedOptions |
반환
Promise<Get2TweetsIdQuoteTweetsResponse>
정의된 위치
getCountsRecent
query, options): Promise<Response>
최근 포스트 개수 가져오기
검색 쿼리와 일치하는, 최근 7일 이내 포스트 개수를 조회합니다.
Parameters
| Name | Type | Description |
|---|---|---|
query | string | 포스트를 매칭하기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이를 확인하려면 https://t.co/rulelength를 참고하세요. |
options | GetCountsRecentOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true이면 raw Response를 반환합니다
정의된 위치
query, options?): Promise<Get2TweetsCountsRecentResponse>
매개변수
| 이름 | type |
|---|---|
query | string |
options? | GetCountsRecentOptions |
반환값
Promise<Get2TweetsCountsRecentResponse>
정의된 위치
hideReply
tweetId, options): Promise<Response>
답글 숨기기
인증된 사용자가 소유한 대화에 달린 답글을 숨기거나 숨김을 해제합니다.
매개변수
| Name | Type | Description |
|---|---|---|
tweetId | string | 숨기거나 숨김 해제하려는 답글의 ID입니다. |
options | HideReplyOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response
정의 위치
posts/client.ts:3298 ▸ hideReply(tweetId, options?): Promise<TweetHideResponse>
매개변수
| 이름 | 타입 |
|---|---|
tweetId | string |
options? | HideReplyOptions |
반환값
Promise<TweetHideResponse>
정의 위치
posts/client.ts:3311getInsightsHistorical
tweetIds, endTime, startTime, granularity, requestedMetrics, options): Promise<Response>
과거 게시물 인사이트 조회
지정된 포스트에 대해 설정된 기간 내의 과거 참여 지표를 반환합니다.
매개변수
| Name | Type | Description |
|---|---|---|
tweetIds | any[] | 과거 메트릭 조회를 위한 PostIds 목록입니다. |
endTime | string | YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 끝을 나타내는 UTC 타임스탬프입니다. |
startTime | string | YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 시작을 나타내는 UTC 타임스탬프입니다. |
granularity | string | 메트릭 응답의 세분화 수준입니다. |
requestedMetrics | any[] | 과거 조회에 대해 요청할 메트릭입니다. |
options | GetInsightsHistoricalOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원본 Response입니다
정의 위치
posts/client.ts:3435 ▸ getInsightsHistorical(tweetIds, endTime, startTime, granularity, requestedMetrics, options?): Promise<Get2InsightsHistoricalResponse>
매개변수
| 이름 | 유형 |
|---|---|
tweetIds | any[] |
endTime | string |
startTime | string |
granularity | string |
requestedMetrics | any[] |
options? | GetInsightsHistoricalOptions |
반환
Promise<Get2InsightsHistoricalResponse>
정의된 위치
getCountsAll
query, options): Promise<Response>
모든 포스트 개수 가져오기
전체 아카이브에서 검색 쿼리에 일치하는 포스트의 개수를 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
query | string | 포스트를 매칭하기 위한 단일 쿼리/규칙/필터입니다. 최대 쿼리 길이를 확인하려면 https://t.co/rulelength를 참고하세요. |
options | GetCountsAllOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response
정의된 위치
query, options?): Promise<Get2TweetsCountsAllResponse>
매개변수
| 이름 | 타입 |
|---|---|
query | string |
options? | GetCountsAllOptions |
반환
Promise<Get2TweetsCountsAllResponse>
정의된 위치
getById
id, options): Promise<Response>
ID로 게시물 조회주어진 ID로 특정 게시물의 상세 정보를 조회합니다.
매개변수
| Name | Type | Description |
|---|---|---|
id | string | 단일 게시물 id입니다. |
options | GetByIdOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원본 Response
정의 위치
posts/client.ts:3952 ▸ getById(id, options?): Promise<Get2TweetsIdResponse>
매개변수
| 이름 | 타입 |
|---|---|
id | string |
options? | GetByIdOptions |
반환값
Promise<Get2TweetsIdResponse>
정의된 위치
delete
id, options): Promise<Response>
게시물 삭제
인증된 사용자가 소유한 경우, 해당 ID의 특정 게시물을 삭제합니다.
매개변수
| Name | Type | Description |
|---|---|---|
id | string | 삭제할 게시물의 ID입니다. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
정의 위치
posts/client.ts:4202 ▸ delete(id): Promise<TweetDeleteResponse>
매개변수
| 이름 | 타입 |
|---|---|
id | string |
반환 값
Promise<TweetDeleteResponse>
정의 위치
posts/client.ts:4215getLikingUsers
id, options): Promise<Response>
좋아요한 사용자 가져오기
특정 게시물의 id를 기준으로, 해당 게시물을 좋아요한 사용자 목록을 가져옵니다.
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
id | string | 단일 게시물 ID입니다. |
options | GetLikingUsersOptions & { requestOptions: { raw: true } } | - |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 가공되지 않은 원본 Response를 그대로 반환합니다
정의 위치
posts/client.ts:4306 ▸ getLikingUsers(id, options?): Promise<Get2TweetsIdLikingUsersResponse>
매개변수
| 이름 | 타입 |
|---|---|
id | string |
options? | GetLikingUsersOptions |
반환값
Promise<Get2TweetsIdLikingUsersResponse>
정의된 위치
getRepostedBy
id, options): Promise<Response>
리포스트한 사용자 조회특정 게시물 ID를 기준으로, 해당 게시물을 리포스트한 사용자 목록을 가져옵니다.
매개변수
| Name | Type | Description |
|---|---|---|
id | string | 단일 게시물 ID입니다. |
options | GetRepostedByOptions & { requestOptions: { raw: true } } | - |
반환
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
정의 위치
posts/client.ts:4525 ▸ getRepostedBy(id, options?): Promise<Get2TweetsIdRetweetedByResponse>
매개변수
| 이름 | 타입 |
|---|---|
id | string |
options? | GetRepostedByOptions |
반환값
Promise<Get2TweetsIdRetweetedByResponse>