連携ガイド

このページでは、List の Posts ルックアップ endpoint をシステムに統合する際に把握しておくべき、いくつかのツールと重要な概念を説明します。ページは次のセクションに分かれています。

• 役立つツール
• 重要な概念
• 認証
• developer portal、Projects、および Apps
• レートリミット
• fields と expansions
• ページネーション

​

便利なツール

この endpoint を統合するうえで役立つ重要な概念に入る前に、次の内容に慣れておくことをおすすめします。

​

Postman

Postman は、endpoint のテストに役立つ優れたツールです。各 Postman リクエストには、利用可能な項目を素早く把握できるよう、すべてのパスパラメータとボディパラメータが含まれています。Postman コレクションの詳細については、“Using Postman” ページをご覧ください。 

​

コードサンプル

お好みのプログラミング言語でこの endpoint をセットアップするためのコードをお探しですか？出発点として利用できる複数のコードサンプルを、GitHub ページで提供しています。

​

サードパーティ製ライブラリ

コミュニティが提供するサードパーティ製ライブラリを活用して、スムーズに始めましょう。適切なバージョンタグを確認すれば、v2 の endpoint に対応するライブラリを見つけられます。

​

重要な概念

​

認証

すべての X API v2 の endpoint では、リクエストを認証するために、いわゆるキーおよびトークンの一式となる認証情報が必要です。この endpoint へのリクエストの認証には、OAuth 1.0a ユーザーコンテキスト、App only、または OAuth 2.0 Authorization Code（PKCE 付き）のいずれかを使用できます。 

OAuth 1.0a ユーザーコンテキスト では、成功するリクエストを行うために API Key の一式とユーザーの Access Tokens を使用する必要があります。access token は、代わってリクエストを行う対象のユーザーに関連付けられていなければなりません。別のユーザー向けに Access Tokens の一式を生成したい場合は、そのユーザーが 3-legged OAuth フロー を用いてあなたの App を承認する必要があります。

OAuth 1.0a は扱いが難しい場合があります。この認証方式に不慣れな場合は、library や Postman のようなツールを使用するか、あるいは OAuth 2.0 もしくは App only を用いてリクエストを認証することを推奨します。

OAuth 2.0 Authorization Code（PKCE 付き） は、アプリケーションのスコープをより細かく制御でき、複数デバイスにまたがる認可フローにも対応します。OAuth 2.0 では、ユーザーに代わって特定の権限を付与する細粒度のスコープを選択できます。 

App で OAuth 2.0 を有効にするには、developer portal の App 設定セクションにある App の認証設定で有効化してください。

App only では、リクエストに App only Access Token を渡すだけで済みます。App only Access Token は、開発者用 App 内で直接生成するか、POST oauth2/token endpoint を使用して生成できます。

​

developer portal、Project、開発者用 App

X API v2 の endpoint で利用できる認証情報一式を取得するには、デベロッパーアカウントに登録し、そのアカウント内でProjectを作成し、その Project 内に開発者用 Appを作成する必要があります。キーおよびトークンは、開発者用 App 内で確認できます。  

​

レートリミット

毎日、何万人もの開発者が X API にリクエストを送信しています。こうした膨大なリクエスト量を管理するため、各 endpoint にはレートリミットが設定されており、あなたの App または認証済みユーザーに代わって実行できるリクエスト数が制限されています。 

この endpoint には App レベルとユーザーレベルの両方でレートリミットが適用されます。App レートリミットは、開発者であるあなたが、任意の App（API Key と API Secret Key、または Bearer Token のいずれかを使用することを想定）から、一定期間内にこの endpoint へ送信できるリクエスト数を制限するものです。ユーザーレートリミットは、あなたが代理でリクエストを行う認証済みユーザーが、任意の開発者用 App をまたいで、List Post のルックアップを一定回数だけ実行できることを意味します。

以下の表は、各 endpoint のレートリミットを示しています。

Endpoint	HTTP method	Rate limit
/2/lists/:id/tweets	GET	15 分あたり 900 リクエスト

Fields と expansions

X API v2 の GET endpoint では、fields と expansions と呼ばれるツール群を用いて、API から返す data を正確に選択できます。expansions パラメータを使用すると、ペイロード内で参照されるオブジェクトを展開できます。たとえば、List Posts のルックアップでは、次のexpansionsを取得できます。

• author_id

fields パラメータを使用すると、受け取りたい各種データオブジェクト内のfieldsを正確に指定できます。この endpoint は主に Post オブジェクトを返します。既定では、Post オブジェクトは id と text fields を返します。tweet.created_at や tweet.lang などの追加フィールドを受け取るには、fields パラメータで明示的に指定する必要があります。 

X API v2 data dictionaryには、fields と expansionsを併用するためのガイドを追加しています。

以下の表は、lookup endpoint で利用可能な fields と expansions を示しています。

Endpoint	Fields	Expansions
/2/lists/:id/tweets	tweet.fields user.fields	author_id

ページネーション

List Posts のルックアップでは大量の data が返されることがあります。常に一貫性があり高いパフォーマンスの結果を返すため、ページネーションを使用しています。ページネーションは、単一のレスポンスでは返しきれない件数の結果を返す X API v2 の endpoint に備わる機能です。その場合、data は複数の「ページ」に分割されて返されます。結果をページネーションで取得する方法の詳細をご覧ください。