役立つツール
Postman
コードサンプル
サードパーティ製ライブラリ
重要なキーワード
認証
developer portal、Project、開発者用 App
レートリミット
fields と expansions
- pinned_tweet_id
ページネーション
ご注意: ユーザーがX上でミュートした場合、15分あたり200リクエストの制限があります。
ガイド
統合ガイド
このページでは、mutes endpoint をシステムに統合する際に把握しておくべき、いくつかのツールと重要な概念について説明します。ページは次のセクションに分かれています。
このendpointを統合するうえで役立つ主要な概念に入る前に、次の内容にあらかじめ慣れておくことをおすすめします。
Postman は、endpoint をテストするのに適したツールです。各 Postman リクエストには、利用可能な項目をすばやく把握できるよう、すべてのパスおよびボディパラメータが含まれています。Postman コレクションの詳細は、“Using Postman” ページをご覧ください。
お使いのプログラミング言語でこの endpoint を使い始めたい方のために、参考にできるコードサンプルを複数用意しています。出発点としてご利用いただけるサンプルは、GitHub ページでご確認ください。
コミュニティ提供のサードパーティ製ライブラリを活用して、導入をスムーズに進めましょう。適切なバージョンタグを確認すれば、v2 の endpoint に対応するライブラリを見つけられます。
すべての X API v2 endpoint では、キーおよびトークンとも呼ばれる一連の認証情報でリクエストを認証する必要があります。これらの endpoint へのリクエストの認証には、OAuth 1.0a ユーザーコンテキストまたは OAuth 2.0 Authorization Code（PKCE 付き）のいずれかを使用できます。
OAuth 1.0a ユーザーコンテキスト では、API Key、ユーザーの Access Token、その他いくつかのパラメータを使用して 認可ヘッダーを作成 し、それをリクエストに付与する必要があります。Access Token は、あなたが代理してリクエストを行うユーザーに関連付けられている必要があります。別のユーザーの Access Token セットを生成する場合は、そのユーザーが 3-legged OAuth フロー を使用してあなたの App を承認する必要があります。
OAuth 1.0a は扱いが難しい場合があります。この認証方法に不慣れな場合は、ライブラリ を使用するか、Postman のようなツールを利用するか、あるいは OAuth 2.0 を使用してリクエストを認証することを推奨します。
OAuth 2.0 Authorization Code（PKCE 付き） は、アプリケーションのスコープをより細かく制御でき、複数デバイスにまたがる認可フローにも対応します。OAuth 2.0 では、ユーザーに代わって特定の権限を付与するきめ細かなスコープを選択できます。
App で OAuth 2.0 を有効にするには、developer portal の App settings セクションにある App の authentication 設定で有効化する必要があります。
X API v2 の endpoint で利用できる認証情報一式を取得するには、デベロッパーアカウントに登録し、そのアカウント内でProjectを作成し、さらにその Project 内に開発者用 Appを作成する必要があります。キーおよびトークンは、作成した開発者用 App 内で確認できます。
毎日、何千人もの開発者が X API にリクエストを送信しています。これらの大量のリクエストを適切に管理するため、各 endpoint にはレートリミットが設定されており、App または認証済みユーザーに代わって行えるリクエスト数が制限されています。
これらの endpoint はユーザーレベルでレート制限されています。つまり、あなたが代行してリクエストを送信する認証済みユーザーは、どの開発者用 App からであっても、その endpoint を呼び出せる回数が定められています。
ユーザーのレートリミットは、POST と DELETE の両メソッドについて、endpoint ごとに 15 分あたり 50 リクエストです。一方、GET メソッドでは 15 分あたり 15 リクエストとなります。
X API v2 の GET endpoint では、fields と expansions と呼ばれる一連の手段を使って、API から返す data を正確に指定できます。expansions パラメータは、ペイロード内で参照されているオブジェクトを展開します。たとえば、この endpoint では次の expansions を取得できます:
ミュートのルックアップは大量のdataを返すことがあります。常に一貫性があり高いパフォーマンスの結果を提供するため、ページネーションを使用します。ページネーションは、1回のレスポンスで返しきれない件数の結果を返すX API v2のendpointで利用される機能です。その場合、dataは一連の「ページ」に分割されて返されます。結果のページネーション方法について詳しくはこちらをご覧ください。
⌘I