Skip to main content

​
List lookup: Standard v1.1 と X API v2 の比較

これまで standard v1.1 の GET lists/show および GET lists/ownerships エンドポイントを利用してきた方向けに、standard v1.1 と X API v2 の List lookup エンドポイントの類似点と相違点を理解するのに役立つことを目的としたガイドです。
  • 類似点
    • 認証方式
    • レート制限
  • 相違点
    • エンドポイント URL
    • App と Project の要件
    • リクエストあたりのデータオブジェクト数上限
    • レスポンスデータ形式
    • リクエストパラメータ

​
類似点

認証 いずれのエンドポイントバージョンも、OAuth 1.0a User Context と App only の両方をサポートしています。したがって、以前 standard v1.1 の List lookup エンドポイントのいずれかを利用していた場合、X API v2 版へ移行しても同じ認証方式を継続して利用できます。 利用している認証ライブラリ/パッケージによりますが、App only 認証はおそらく最も簡単に開始できる方法で、シンプルなリクエストヘッダーで設定できます。App only アクセストークンの生成方法については、App only ガイドをご確認ください。 レート制限

​
相違点

エンドポイント URL App と Project の要件 X API v2 エンドポイントでは、リクエスト認証時に Project に紐づく developer App の認証情報の使用が必須です。すべての X API v1.1 エンドポイントは、App または Project に関連する App の認証情報を利用できます。 リクエストあたりのデータオブジェクト数上限 standard v1.1 の /lists/ownerships エンドポイントでは、1 リクエストあたり最大 1000 の List を返せます。新しい v2 エンドポイントでは、1 リクエストあたり最大 100 の List を返せます。デフォルトでは 100 ユーザーオブジェクトが返され、返却件数を変更したい場合は、クエリパラメータ max_results= に 1 - 100 の数値を渡す必要があります。次に、レスポンスペイロードで返された next_token を、次のリクエストの pagination_token クエリパラメータに渡します。 レスポンスデータ形式 standard v1.1 と X API v2 のエンドポイントバージョンにおける最も大きな違いのひとつは、ペイロードに返すフィールドをどう選ぶかです。 standard エンドポイントではデフォルトで多くのレスポンスフィールドを受け取り、パラメータを使ってペイロードに追加で返すフィールドやフィールドセットを指定するオプションがあります。 X API v2 版では、デフォルトでは List の id と name フィールドのみが返されます。追加のフィールドやオブジェクトをリクエストするには、fields と expansions パラメータを使用する必要があります。このエンドポイントからリクエストした List フィールドはすべて、プライマリの List オブジェクトに含まれて返されます。展開された Post やユーザーオブジェクトおよびフィールドは、レスポンス内の includes オブジェクトに返されます。展開されたオブジェクトは、ユーザーおよび展開された Post オブジェクトに含まれる ID を突き合わせることで、List オブジェクトに関連付けられます。 利用可能な List フィールドと expansions の例:
  • created_at
  • follower_count
  • member_count
  • owner_id
  • description
  • private
これらの新しいパラメータについては、各ガイドや、fields と expansions の使い方についてのガイドをぜひご覧ください。 standard v1.1 のフィールドを新しい v2 のフィールドにマッピングするのに役立つデータ形式の移行ガイドもご用意しています。このガイドでは、特定のフィールドを v2 リクエストで返すために渡す必要がある具体的な expansion と field パラメータも提供されます。 特定フィールドのリクエスト方法の変更に加えて、X API v2 では API が返すオブジェクト (Post や user オブジェクトを含む) の新しい JSON 設計も導入されています。
  • JSON のルートレベルでは、standard エンドポイントは Post オブジェクトを statuses 配列で返しますが、X API v2 では data 配列で返します。
  • Retweeted や Quoted「statuses」ではなく、X API v2 の JSON では Retweeted / Quoted Tweets を参照します。contributors や user.translator_type など、多くのレガシー・非推奨フィールドは削除されています。
  • Post オブジェクトでは favorites、user オブジェクトでは favourites という別々の表記が使われていましたが、X API v2 では like という用語に統一しています。
  • X では、値が存在しない JSON 値 (たとえば null) はペイロードに書き出さないという慣習を採用しています。Post とユーザーの属性は、非 null の値を持つ場合のみ含まれます。
リクエストパラメータ 以下の standard v1.1 リクエストパラメータには X API v2 に相当するものがあります: List lookup by ID User owned List lookup