Skip to main content

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

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

共通点

認証 Standard v1.1 と X API v2 の両方のブロック参照用 endpoint は、OAuth 1.0a ユーザーコンテキスト を使用します。したがって、以前に Standard v1.1 のブロック参照用 endpoint のいずれかを使用していた場合は、X API v2 の同等のバージョンに移行しても、同じ認証方法を引き続き使用できます。 

相違点

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