PostsClient

投稿操作用 Client

この Client は、X API の投稿エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストの整形、および投稿関連のすべての操作に対するレスポンスの解析を処理します。

​

コンストラクタ

​

コンストラクター

• new PostsClient(client): PostsClient

新しい PostsClient インスタンスを作成します

​

パラメーター

名前	型	説明
client	Client	X API のメイン Client インスタンス

​

戻り値

PostsClient

​

定義元

posts/client.ts:789

​

メソッド

​

getInsights28hr

▸ 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 レスポンス (または requestOptions.raw が true の場合は生の Response) を返す Promise

​

定義場所

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>

ポストのアナリティクスを取得します。
指定した投稿について、指定した時間範囲内のアナリティクスデータを取得します。

​

パラメーター

Name	Type	Description
ids	any[]	カンマ区切りのポストIDのリスト。1回のリクエストで最大100件まで指定できます。
endTime	string	YYYY-MM-DDTHH:mm:ssZ。期間の終了時刻を表すUTCタイムスタンプ。
startTime	string	YYYY-MM-DDTHH:mm:ssZ。期間の開始時刻を表すUTCタイムスタンプ。
granularity	string	検索カウント結果の粒度。
options	GetAnalyticsOptions & { requestOptions: { raw: true } }	-

​

Returns

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>

Reposts を取得します
特定のポストをリポストしている投稿の一覧を、そのポストの id を指定して取得します。

​

パラメータ

Name	Type	Description
id	string	単一の投稿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>

最近の投稿を検索します
検索クエリに一致する、直近7日間の投稿を取得します。

​

パラメーター

Name	Type	Description
query	string	投稿に一致させるための1つのクエリ／ルール／フィルター。最大クエリ長を確認するには https://t.co/rulelength を参照してください。
options	SearchRecentOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンスが解決値となる Promise、または requestOptions.raw が true の場合は生の Response

​

定義場所

posts/client.ts:1559

▸ searchRecent(query, options?): Promise<Get2TweetsSearchRecentResponse>

​

パラメータ

名前	type
query	string
options?	SearchRecentOptions

​

戻り値

Promise<Get2TweetsSearchRecentResponse>

​

定義元

posts/client.ts:1572

---

​

searchAll

▸ searchAll(query, options): Promise<Response>

すべての投稿を検索します
検索クエリに一致する投稿をフルアーカイブから取得します。

​

パラメーター

Name	Type	Description
query	string	ポストに一致する 1つのクエリ／ルール／フィルター。最大クエリ長については https://t.co/rulelength を参照してください。
options	SearchAllOptions & { requestOptions: { raw: true } }	-

​

戻り値

Promise<Response>

API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

​

定義元

posts/client.ts:1968

▸ searchAll(query, options?): Promise<Get2TweetsSearchAllResponse>

​

パラメーター

名前	type
query	string
options?	SearchAllOptions

​

戻り値

Promise<Get2TweetsSearchAllResponse>

​

定義場所

posts/client.ts:1981

---

​

getByIds

▸ getByIds(ids, options): Promise<Response>

ID で投稿を取得します
複数の投稿の詳細を、ID を指定して取得します。

​

パラメーター

Name	Type	Description
ids	any[]	カンマ区切りのポストIDのリスト。1回のリクエストで最大100件まで指定できます。
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>

ポストを作成または編集 認証済みユーザーの新規ポストを作成するか、edit_options が指定されている場合は既存のポストを編集します。

​

パラメーター

名称	型	説明
body	TweetCreateRequest	リクエストボディ
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>

​

パラメーター

Name	Type
body	TweetCreateRequest

​

戻り値

Promise<TweetCreateResponse>

​

定義場所

posts/client.ts:2633

---

​

getQuoted

▸ getQuoted(id, options): Promise<Response>

引用された投稿を取得 特定のポストをIDで指定し、そのポストを引用している投稿の一覧を取得します。

​

パラメーター

Name	Type	Description
id	string	1件のポストの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>

直近の投稿数を取得します
検索クエリに一致する直近7日間の投稿数を取得します。

​

パラメーター

Name	Type	Description
query	string	投稿にマッチさせるためのクエリ／ルール／フィルター 1 件。最大クエリ長については https://t.co/rulelength を参照してください。
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>

返信を非表示にします
認証済みユーザーが所有する会話に対する返信を、非表示または再表示します。

​

パラメーター

名前	型	説明
tweetId	string	非表示または再表示する返信のID。
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>

過去のポストインサイトを取得
指定したポストについて、定義された期間内の過去のエンゲージメント指標を取得します。

​

Parameters

Name	Type	Description
tweetIds	any[]	履歴メトリクス用の PostId のリスト。
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 レスポンスで解決される 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>

すべての投稿の件数を取得します。
フルアーカイブから、検索クエリに一致する投稿件数を取得します。

​

パラメーター

Name	Type	Description
query	string	投稿と照合するためのクエリ／ルール／フィルターを 1 つ指定します。最大クエリ長については https://t.co/rulelength を参照してください。
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>

ID を指定してポストを取得 指定した ID のポストの詳細を取得します。

​

パラメーター

Name	Type	Description
id	string	単一のポスト ID。
options	GetByIdOptions & { requestOptions: { raw: true } }	-

​

Returns

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>

ポストを削除します 認証済みユーザーが所有している場合に、指定された ID のポストを削除します。

​

パラメーター

Name	Type	説明
id	string	削除対象のポストの ID。
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>

いいねしたユーザーを取得 特定のポストのIDを指定して、そのポストにいいねしたユーザーの一覧を取得します。

​

パラメーター

Name	Type	Description
id	string	単一のポストの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>

Reposted by の取得 特定のポストの ID を指定して、そのポストを Repost したユーザーの一覧を取得します。

​

パラメーター

Name	Type	Description
id	string	1件のポストの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