v1 から v2 へ

リストルックアップ：Standard v1.1 と X API v2 の比較

Standard v1.1 の GET lists/show や GET lists/ownerships エンドポイントを利用している場合、このガイドの目的は、Standard v1.1 と X API v2 のリストルックアップエンドポイントの共通点と違いを理解できるよう支援することです。

• 共通点
  • 認証方法
  • レート制限
• 相違点
  • エンドポイント URL
  • App および Project の要件
  • 1 回のリクエストあたりのデータオブジェクト数の制限
  • レスポンスデータ形式
  • リクエストパラメータ

類似点

認証

どちらのエンドポイントバージョンも OAuth 1.0a User Context と App only の両方をサポートしています。したがって、以前に Standard v1.1 の List lookup エンドポイントのいずれかを使用していた場合、X API v2 バージョンへ移行しても同じ認証方法を引き続き使用できます。

利用する認証ライブラリやパッケージにもよりますが、App only 認証はおそらく最も簡単に始められる方法で、シンプルなリクエストヘッダーを設定するだけで利用できます。App only Access Token の生成方法については、この App only ガイドを参照してください。

レート制限

Standard v1.1	X API v2
/1.1/lists/show.json OAuth 1.0a User Context で 15 分あたり 75 リクエスト App only で 15 分あたり 75 リクエスト	/2/lists/:id OAuth 1.0a User Context で 15 分あたり 75 リクエスト OAuth 2.0 Authorization Code with PKCE で 15 分あたり 75 リクエスト
/1.1/lists/ownerships.json OAuth 1.0a User Context で 15 分あたり 15 リクエスト App only で 15 分あたり 15 リクエスト	/2/users/:id/owned_lists OAuth 1.0a User Context で 15 分あたり 15 リクエスト OAuth 2.0 Authorization Code with PKCE で 15 分あたり 15 リクエスト App only で 15 分あたり 15 リクエスト

違い

エンドポイント URL

• Standard v1.1 エンドポイント:
  • GET https://api.x.com/1.1/lists/show.json (指定したリストをルックアップ)
  • GET https://api.x.com/1.1/lists/ownerships.json (指定したユーザーが所有するリストをルックアップ)
• X API v2 エンドポイント:

  • GET https://api.x.com/2/lists/:id (指定したリストをルックアップ)

  • GET https://api.x.com/2/users/:id/owned_lists (指定したユーザーが所有するリストをルックアップ)

App と Project の要件

X API v2 エンドポイントでは、リクエストを認証する際に、developer App と、それに関連付けられた Project の認証情報を使用する必要があります。すべての X API v1.1 エンドポイントは、Project に関連付けられていない App からの認証情報、または Project に関連付けられた App からの認証情報のどちらでも使用できます。

リクエストごとのデータオブジェクト数の上限

Standard v1.1 の /lists/ownerships エンドポイントでは、1 回のリクエストで最大 1000 件のリストを返すことができます。新しい v2 エンドポイントでは、1 回のリクエストで最大 100 件のリストを返すことができます。デフォルトでは 100 件のユーザーオブジェクトが返されます。結果数を変更するには、クエリパラメータ max_results= に 1～100 の数値を指定する必要があります。その後、レスポンスペイロードで返される next_token を、次のリクエストの pagination_token クエリパラメータに指定できます。

レスポンスデータ形式

Standard v1.1 と X API v2 のエンドポイントバージョンの最大の違いの 1 つは、どのフィールドをペイロードで返すかの指定方法です。

Standard エンドポイントでは、多くのレスポンスフィールドがデフォルトで返され、そのうえで追加のフィールドやフィールドセットをペイロードで返すかどうかをパラメータで指定できます。

X API v2 バージョンでは、デフォルトで List の id と name フィールドのみが返されます。追加のフィールドやオブジェクトをリクエストするには、fields と expansions パラメータを使用する必要があります。このエンドポイントからリクエストした List のフィールドは、すべてプライマリの List オブジェクトに含まれます。展開されたポストまたはユーザーオブジェクトとそのフィールドは、レスポンス内の includes オブジェクトに含まれます。次に、ユーザーオブジェクトと展開されたポストオブジェクトの両方に含まれる ID を照合することで、展開されたオブジェクトを List オブジェクトに対応付けることができます。

以下は、指定可能な List フィールドと expansions の例です。

• created_at

• follower_count

• member_count

• owner_id

• description

• private

エンドポイント	Expansion
/2/lists/:id	owner_id
/2/users/:id/owned_lists	owner_id

これらの新しいパラメータについて詳しくは、それぞれのガイド、または fields と expansions の使い方 に関するガイドを参照することをお勧めします。

また、Standard v1.1 のフィールドを新しい v2 のフィールドにマッピングするのに役立つ データ形式移行ガイド も用意しています。このガイドでは、特定のフィールドを返すために v2 リクエストで指定する必要がある、具体的な expansion および field パラメータについても説明しています。

特定のフィールドのリクエスト方法の変更に加えて、X API v2 では、Post オブジェクトや user オブジェクトなど、API によって返されるオブジェクトに対して、新しい JSON 設計も導入されています。

• JSON のルートレベルでは、Standard エンドポイントは Post オブジェクトを statuses 配列で返す一方、X API v2 は data 配列で返します。

• Retweeted と Quoted の「statuses」を参照する代わりに、X API v2 の JSON では Retweeted と Quoted のツイートを参照します。contributors や user.translator_type など、多くのレガシー／非推奨フィールドは削除されます。

• Post オブジェクトの favorites と user オブジェクトの favourites の両方を使用する代わりに、X API v2 では like という用語を使用します。

• X では、値が存在しない JSON 値 (例えば null) はペイロードに書き込まないという規約を採用しています。Post と user の属性は、非 null の値がある場合にのみ含まれます。

リクエストパラメータ

次の Standard v1.1 のリクエストパラメータには、X API v2 における対応するパラメータがあります。

ID によるリストルックアップ

Standard v1.1	X API v2
list_id	id
slug	同等のものはありません
owner_screen_name	同等のものはありません
owner_id	expansions/fields パラメータでリクエスト

ユーザー所有リストのルックアップ

Standard v1.1	X API v2
user_id	id
screen_name	対応するフィールドなし
count	max_results
cursor	pagination_token