統合ガイド
概要
このページでは、最新または全アーカイブの Post 件数エンドポイントをシステムに統合する際に把握しておくべき各種ツールと重要な概念について説明します。ページは次のセクションに分かれています。
主要な概念を見ていく前に、これらのエンドポイントの機能を試験するには、次のいずれかのツールまたはコードサンプルの使用をおすすめします。
お好みのプログラミング言語でこれらのエンドポイントをセットアップするためのコードをお探しですか？当社の GitHub ページ には、導入の出発点として使える各種コードサンプルをご用意しており、Python クライアント も含まれています。
セットアップの助けになる、数多くのコミュニティ提供のサードパーティ製ライブラリを活用してください。対応するバージョンタグを確認すれば、v2 エンドポイントで動作するライブラリを見つけられます。
Postman は、これらのエンドポイントのテストに役立つ優れたツールです。各 Postman リクエストには、そのエンドポイントで利用可能なすべてのパラメータが含まれており、どのような項目が利用できるかを素早く把握できます。Postman コレクションの詳細については、Using Postman をご覧ください。
すべての X API v2 エンドポイントでは、キーやトークンとも呼ばれる一連のクレデンシャルで認証されたリクエストが必要です。該当のエンドポイントでは OAuth 2.0 Bearer Token の使用が必須であり、リクエストを成功させるには Bearer Token を渡す必要があります。Bearer Token は開発者アプリ内で直接生成するか、POST oauth2/token エンドポイントを使用して生成できます。
X API v2 の各エンドポイントを利用するには、開発者アカウントを作成し、そのアカウント内にプロジェクトを設定し、そのプロジェクト内に開発者アプリを作成する必要があります。開発者アプリ内のキーとトークンは、最新のPost件数エンドポイントで利用できます。フルアーカイブのPost件数エンドポイントを使用する場合、あるいは高度なオペレーターやより長いクエリを利用する場合は、エンタープライズアクセスの承認が必要です。
詳しくはエンタープライズアクセスのセクションをご覧ください。
毎日、何千人もの開発者が X API にリクエストを送信しています。リクエスト量を管理するため、各エンドポイントにはレート制限が設けられており、アプリの代理または認証済みユーザーの代理として各開発者が行えるリクエスト数が制限されています。
このエンドポイントはアプリ単位でレート制限が適用されます。つまり、使用している認証情報で識別される任意のアプリから、一定期間内にこのエンドポイントへ送信できるリクエスト数には上限があります。
これらのエンドポイントの主要な機能は、単一のクエリでPostをフィルタリングし、返却される件数を算出することです。クエリは、メッセージのキーワード、ハッシュタグ、URL など、Post やユーザーの属性にマッチするオペレーターで構成されます。オペレーターは、ブール論理や括弧を使って組み合わせることで、マッチングの挙動を細かく制御できます。
詳しくは、クエリの作成方法ガイドをご参照ください。
最新のPost件数については、next_token は返されません。つまり、粒度に関係なく、1回のAPI呼び出しで直近7日間のPostボリュームを取得できます。
フルアーカイブのPost件数については、直近30日分のdataを取得できます。30日より前のdataについては、追加のdataを取得するためにページネーションに使用できる next_token が返されます。
Post件数エンドポイントは、GETリクエストで単一のクエリを受け取り、そのクエリに一致する過去のPost件数のセットを返します。クエリは、さまざまなPostの属性にマッチさせるためのオペレーターで構成されています。