便利なツール
Postman
コードサンプル
サードパーティ製ライブラリ
重要な概念
認証
developer portal、Project、および開発者用 App
レートリミット
fields と expansions
- pinned_tweet_id
ガイド
連携ガイド
このページでは、blocks 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 Tokens、その他いくつかのパラメータを使用して authorization ヘッダーを作成し、そのヘッダーをリクエストに添えて送信する必要があります。Access Tokens は、あなたがユーザーに代わってリクエストを行う対象のユーザーに紐づいていなければなりません。別のユーザー向けの Access Tokens を生成したい場合は、そのユーザーが 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 設定セクションにある App の認証設定で有効化する必要があります。
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 パラメータを使うと、ペイロード内で id 参照されているオブジェクトを展開できます。たとえば、この endpoint では次の expansions を取得できます。
Blocks lookup は大量の data を返す場合があります。任意のタイミングで結果が多くなりすぎないよう、ページネーションを使用しています。結果のページネーション方法についてはこちらをご覧ください。
⌘I