PostsClient

posts 操作向けのクライアントこのクライアントは X API の posts エンドポイントと対話するためのメソッドを提供します。認証、リクエストの整形、posts に関連するすべての操作のレスポンス解析を扱います。

コンストラクター

• new PostsClient(client): PostsClient 新しい posts クライアントインスタンスを作成します

パラメーター

名前	型	説明
`client`	`Client`	メインの X API クライアントインスタンス

戻り値

PostsClient

定義場所

posts/client.ts:789

メソッド

getInsights28hr

▸ getInsights28hr(tweetIds, granularity, requestedMetrics, options): Promise<Response> Get 28-hour Post insights Retrieves engagement metrics for specified Posts over the last 28 hours.

パラメーター

名前	型	説明
`tweetIds`	`any`[]	List of PostIds for 28hr metrics.
`granularity`	`string`	granularity of metrics response.
`requestedMetrics`	`any`[]	request metrics for historical request.
`options`	`GetInsights28hrOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`tweetIds`	`any`[]
`granularity`	`string`
`requestedMetrics`	`any`[]
`options?`	`GetInsights28hrOptions`

戻り値

Promise<Get2Insights28hrResponse>

定義場所

posts/client.ts:863

getAnalytics

▸ getAnalytics(ids, endTime, startTime, granularity, options): Promise<Response> Get Post analytics Retrieves analytics data for specified Posts within a defined time range.

パラメーター

名前	型	説明
`ids`	`any`[]	A comma separated list of Post IDs. Up to 100 are allowed in a single request.
`endTime`	`string`	YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range.
`startTime`	`string`	YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range.
`granularity`	`string`	The granularity for the search counts results.
`options`	`GetAnalyticsOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される 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:1077

getReposts

▸ getReposts(id, options): Promise<Response> Get Reposts 次の一覧を取得します: Posts that repost a specific Post by its ID.

パラメーター

名前	型	説明
`id`	`string`	A single Post ID.
`options`	`GetRepostsOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`id`	`string`
`options?`	`GetRepostsOptions`

戻り値

Promise<Get2TweetsIdRetweetsResponse>

定義場所

posts/client.ts:1284

searchRecent

▸ searchRecent(query, options): Promise<Response> Search recent Posts Retrieves Posts from the last 7 days matching a search query.

パラメーター

名前	型	説明
`query`	`string`	One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
`options`	`SearchRecentOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`query`	`string`
`options?`	`SearchRecentOptions`

戻り値

Promise<Get2TweetsSearchRecentResponse>

定義場所

posts/client.ts:1572

searchAll

▸ searchAll(query, options): Promise<Response> Search all Posts Retrieves Posts from the full archive matching a search query.

パラメーター

名前	型	説明
`query`	`string`	One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
`options`	`SearchAllOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`query`	`string`
`options?`	`SearchAllOptions`

戻り値

Promise<Get2TweetsSearchAllResponse>

定義場所

posts/client.ts:1981

getByIds

▸ getByIds(ids, options): Promise<Response> Get Posts by IDs Retrieves details of multiple Posts by their IDs.

パラメーター

名前	型	説明
`ids`	`any`[]	A comma separated list of Post IDs. Up to 100 are allowed in a single request.
`options`	`GetByIdsOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`ids`	`any`[]
`options?`	`GetByIdsOptions`

戻り値

Promise<Get2TweetsResponse>

定義場所

posts/client.ts:2378

create

▸ create(body, options): Promise<Response> Create or Edit Post Creates a new Post for the authenticated user, or edits an existing Post when edit_options are provided.

パラメーター

名前	型	説明
`body`	`TweetCreateRequest`	Request body
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`body`	`TweetCreateRequest`

戻り値

Promise<TweetCreateResponse>

定義場所

posts/client.ts:2633

getQuoted

▸ getQuoted(id, options): Promise<Response> Get Quoted Posts 次の一覧を取得します: Posts that quote a specific Post by its ID.

パラメーター

名前	型	説明
`id`	`string`	A single Post ID.
`options`	`GetQuotedOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`id`	`string`
`options?`	`GetQuotedOptions`

戻り値

Promise<Get2TweetsIdQuoteTweetsResponse>

定義場所

posts/client.ts:2731

getCountsRecent

▸ getCountsRecent(query, options): Promise<Response> Get count of recent Posts Retrieves the count of Posts from the last 7 days matching a search query.

パラメーター

名前	型	説明
`query`	`string`	One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
`options`	`GetCountsRecentOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`query`	`string`
`options?`	`GetCountsRecentOptions`

戻り値

Promise<Get2TweetsCountsRecentResponse>

定義場所

posts/client.ts:3038

hideReply

▸ hideReply(tweetId, options): Promise<Response> Hide reply Hides or unhides a reply to a conversation owned by the authenticated user.

パラメーター

名前	型	説明
`tweetId`	`string`	The ID of the reply that you want to hide or unhide.
`options`	`HideReplyOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`tweetId`	`string`
`options?`	`HideReplyOptions`

戻り値

Promise<TweetHideResponse>

定義場所

posts/client.ts:3311

getInsightsHistorical

▸ getInsightsHistorical(tweetIds, endTime, startTime, granularity, requestedMetrics, options): Promise<Response> Get historical Post insights Retrieves historical engagement metrics for specified Posts within a defined time range.

パラメーター

名前	型	説明
`tweetIds`	`any`[]	List of PostIds for historical metrics.
`endTime`	`string`	YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range.
`startTime`	`string`	YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range.
`granularity`	`string`	granularity of metrics response.
`requestedMetrics`	`any`[]	request metrics for historical request.
`options`	`GetInsightsHistoricalOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される 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>

定義場所

posts/client.ts:3464

getCountsAll

▸ getCountsAll(query, options): Promise<Response> Get count of all Posts Retrieves the count of Posts matching a search query from the full archive.

パラメーター

名前	型	説明
`query`	`string`	One query/rule/filter for matching Posts. Refer to https://t.co/rulelength to identify the max query length.
`options`	`GetCountsAllOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`query`	`string`
`options?`	`GetCountsAllOptions`

戻り値

Promise<Get2TweetsCountsAllResponse>

定義場所

posts/client.ts:3692

getById

▸ getById(id, options): Promise<Response> Get Post by ID Retrieves details of a specific Post by its ID.

パラメーター

名前	型	説明
`id`	`string`	A single Post ID.
`options`	`GetByIdOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`id`	`string`
`options?`	`GetByIdOptions`

戻り値

Promise<Get2TweetsIdResponse>

定義場所

posts/client.ts:3965

delete

▸ delete(id, options): Promise<Response> Delete Post Deletes a specific Post by its ID, if owned by the authenticated user.

パラメーター

名前	型	説明
`id`	`string`	The ID of the Post to be deleted.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`id`	`string`

戻り値

Promise<TweetDeleteResponse>

定義場所

posts/client.ts:4215

getLikingUsers

▸ getLikingUsers(id, options): Promise<Response> Get Liking Users 次の一覧を取得します: Users who liked a specific Post by its ID.

パラメーター

名前	型	説明
`id`	`string`	A single Post ID.
`options`	`GetLikingUsersOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`id`	`string`
`options?`	`GetLikingUsersOptions`

戻り値

Promise<Get2TweetsIdLikingUsersResponse>

定義場所

posts/client.ts:4319

getRepostedBy

▸ getRepostedBy(id, options): Promise<Response> Get Reposted by 次の一覧を取得します: Users who reposted a specific Post by its ID.

パラメーター

名前	型	説明
`id`	`string`	A single Post ID.
`options`	`GetRepostedByOptions` & { `requestOptions`: { `raw`: `true` } }	-

戻り値

Promise<Response> API レスポンスに解決される Promise。requestOptions.raw が true の場合は生の Response を返します

定義場所

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

パラメーター

名前	型
`id`	`string`
`options?`	`GetRepostedByOptions`

戻り値

Promise<Get2TweetsIdRetweetedByResponse>

定義場所

posts/client.ts:4538

​コンストラクター

​コンストラクター

​パラメーター

​戻り値

​定義場所

​メソッド

​getInsights28hr

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​getAnalytics

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​getReposts

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​searchRecent

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​searchAll

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​getByIds

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​create

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​getQuoted

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​getCountsRecent

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​hideReply

​パラメーター

​戻り値

​定義場所

​パラメーター

​戻り値

​定義場所

​getInsightsHistorical

​パラメーター

​戻り値

​定義場所

コンストラクター

コンストラクター

パラメーター

戻り値

定義場所

メソッド

getInsights28hr

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

getAnalytics

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

getReposts

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

searchRecent

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

searchAll

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

getByIds

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

create

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

getQuoted

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

getCountsRecent

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

hideReply

パラメーター

戻り値

定義場所

パラメーター

戻り値

定義場所

getInsightsHistorical

パラメーター

戻り値

定義場所