Skip to main content

ブロックの照会: Standard v1.1 と X API v2 の比較

標準 v1.1 の GET blocks/idsGET blocks/list エンドポイントをお使いの場合、本ガイドは、Standard v1.1 と X API v2 のブロック照会エンドポイントにおける共通点と相違点の理解を支援することを目的としています。
  • 共通点
    • 認証
  • 相違点
    • エンドポイント URL
    • リクエストあたりのユーザー数上限
    • アプリおよびプロジェクト要件
    • レスポンスの data 形式
    • リクエストパラメータ

共通点

認証 標準の v1.1 と X API v2 の両方のブロック参照エンドポイントは OAuth 1.0a ユーザーコンテキスト を使用します。そのため、以前に標準の v1.1 のブロック参照エンドポイントを利用していた場合は、X API v2 版へ移行しても同じ認証方法を引き続き使用できます。 

相違点

エンドポイントURL 1リクエストあたりのユーザー数上限 標準の v1.1 エンドポイントでは、1リクエストあたり最大 5,000 ユーザーを返せます。新しい v2 エンドポイントでは、1リクエストあたり最大 1,000 ユーザーを返せます。1,000 ユーザーをすべて返すには、クエリパラメータとして max_results=1000 を指定する必要があります。次のリクエストでは、レスポンスのペイロードで返される next_token を pagination_token クエリパラメータに渡してください。   アプリとプロジェクトの要件 X API v2 エンドポイントでは、リクエストの認証時に、developer App とそれに関連付けられた Project の資格情報を使用する必要があります。すべての X API v1.1 エンドポイントは、プロジェクトに関連付けられていない単体のアプリ、またはプロジェクトに関連付けられたアプリの資格情報を使用できます。 レスポンスのデータ形式 標準 v1.1 と X API v2 のエンドポイントの大きな違いの一つは、ペイロードで返す fields の選択方法です。 標準エンドポイントでは、多くのレスポンス fields がデフォルトで返され、さらにパラメータを使用して、ペイロードで返す fields やそのセットを指定できます。 X API v2 では、デフォルトで返されるのは user の id、name、username の fields のみです。追加の fields やオブジェクトを要求するには、fieldsexpansions パラメータを使用する必要があります。このエンドポイントで要求したユーザー fields は、プライマリのユーザーオブジェクトに含まれて返されます。展開された Post オブジェクトと fields は、レスポンス内の includes オブジェクトに含まれて返されます。その後、ユーザーと展開された Post オブジェクトの両方にある ID を照合することで、展開オブジェクトをユーザーオブジェクトに対応付けられます。  これらの新しいパラメータについては、各ガイド、またはfields と expansions の使い方のガイドをご確認ください。  また、標準 v1.1 の fields を新しい v2 の fields にマッピングするのに役立つデータ形式移行ガイドも用意しています。このガイドでは、特定の fields を返すために v2 のリクエストに含める必要がある具体的な expansion および field パラメータも示します。    特定の fields の要求方法の変更に加えて、X API v2 は API が返すオブジェクトに対して新しい JSON 設計も導入しています。これには Post オブジェクトや user オブジェクトが含まれます。
  • JSON のルートレベルでは、標準エンドポイントは Post オブジェクトを statuses 配列で返しますが、X API v2 は data 配列で返します。 
  • Retweeted と Quoted の「statuses」を参照する代わりに、X API v2 の JSON では Retweeted と Quoted Tweets を参照します。contributors や user.translator_type のような多くのレガシー/非推奨の fields は削除されています。 
  • (Post オブジェクトの)favorites と(user オブジェクトの)favourites の両方を使う代わりに、X API v2 では like という用語を使用します。 
  • X では、値を持たない JSON 値(たとえば null)はペイロードに含めないという慣例を採用しています。Post と user の属性は、null ではない値がある場合にのみ含まれます。   
また、Post オブジェクトに新しい fields のセットも導入しました。以下が含まれます:
  • conversation_id field
  • 2つの新しい annotations fields(context と entities)
  • 複数の新しい metrics fields 
  • 新しい reply_setting field(特定の Post に返信できるユーザーを示します)
リクエストパラメータ 以下の標準的な v1.1 リクエストパラメータは、クエリパラメータ(user_id または screen_name)のいずれかを受け付けていました。X API v2 では数値のユーザーIDのみがサポートされ、エンドポイントパスの一部として渡す必要があります。