コンストラクタ
コンストラクター
client): PostsClient
新しい Posts クライアント インスタンスを作成します
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
client | Client | X API のメインクライアントインスタンス |
戻り値
PostsClient
定義箇所
メソッド
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 レスポンスに解決される Promise
定義先
posts/client.ts:478searchRecent
query, options?): Promise<Get2TweetsSearchRecentResponse>
最近のPostを検索
検索クエリに一致する直近7日間のPostを取得します。
パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
query | string | Posts に一致させるためのクエリ／ルール／フィルターを1つ。最大クエリ長は https://t.co/rulelength を参照してください。 |
options | SearchRecentOptions | - |
戻り値
Promise<Get2TweetsSearchRecentResponse>
API レスポンスで解決される Promise
定義元
posts/client.ts:540getRepostedBy
id, options?): Promise<Get2TweetsIdRetweetedByResponse>
リポストしたユーザーを取得
指定したPostのIDに基づき、そのPostをリポストしたユーザーの一覧を取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
id | string | 単一の Post ID。 |
options | GetRepostedByOptions | - |
戻り値
Promise<Get2TweetsIdRetweetedByResponse>
API レスポンスに解決される Promise
定義箇所
getLikingUsers
id, options?): Promise<Get2TweetsIdLikingUsersResponse>
「いいね」したユーザーを取得
指定したIDのPostに「いいね」したユーザーの一覧を取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
id | string | 単一の Post の id。 |
options | GetLikingUsersOptions | - |
返り値
Promise<Get2TweetsIdLikingUsersResponse>
API レスポンスで解決される Promise
定義場所
posts/client.ts:744getInsightsHistorical
tweetIds, endTime, startTime, granularity, requestedMetrics, options?): Promise<Get2InsightsHistoricalResponse>
過去のPostインサイトを取得
指定したPostの、指定期間内における過去のエンゲージメント指標を取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
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 | - |
戻り値
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 と一致させるためのクエリ/ルール/フィルターを 1 つ指定します。最大クエリ長は https://t.co/rulelength を参照してください。 |
options | GetCountsRecentOptions | - |
戻り値
Promise<Get2TweetsCountsRecentResponse>
API レスポンスに解決される Promise
定義元
posts/client.ts:1046getByIds
ids, options?): Promise<Get2TweetsResponse>
IDでPostを取得
複数のPostをID指定で取得し、詳細を返します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
ids | any[] | Postのidをカンマ区切りで指定した一覧。1回のリクエストにつき最大100件まで指定できます。 |
options | GetByIdsOptions | - |
返却値
Promise<Get2TweetsResponse>
API レスポンスで解決される Promise
定義元
posts/client.ts:1140create
body): Promise<TweetCreateResponse>
Post の作成または編集
認証済みユーザーの新規 Post を作成するか、edit_options が指定されている場合は既存の Post を編集します。
パラメータ
| Name | Type | 説明 |
|---|---|---|
body | TweetCreateRequest | リクエストボディ |
戻り値
Promise<TweetCreateResponse>
API レスポンスで解決される Promise
定義箇所
getById
id, options?): Promise<Get2TweetsIdResponse>
ID で Post を取得
指定した Post のIDで詳細を取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
id | string | 単一の Post ID。 |
options | GetByIdOptions | - |
戻り値
Promise<Get2TweetsIdResponse>
API レスポンスで解決される Promise
定義先
posts/client.ts:1258delete
id): Promise<TweetDeleteResponse>
Post を削除
認証済みユーザーが所有する場合、指定した ID の Post を削除します。
パラメーター
| Name | Type | Description |
|---|---|---|
id | string | 削除する Post の id。 |
戻り値
Promise<TweetDeleteResponse>
API レスポンスを返す Promise
定義箇所
getAnalytics
ids, endTime, startTime, granularity, options?): Promise<Analytics>
Post のアナリティクスを取得
指定した Post のアナリティクス data を、指定した時間範囲内で取得します。
パラメーター
| Name | Type | Description |
|---|---|---|
ids | any[] | カンマ区切りの Post の id リスト。1 回のリクエストで最大 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 にマッチさせるためのクエリ／ルール／フィルターを1つ指定します。クエリの最大長は 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 | Post にマッチさせるためのクエリ／ルール／フィルターを1つ指定します。最大クエリ長については https://t.co/rulelength を参照してください。 |
options | SearchAllOptions | - |
戻り値
Promise<Get2TweetsSearchAllResponse>
API レスポンスで解決される Promise