メインコンテンツへスキップ

​
List ルックアップ endpoint の始め方

このクイックスタート ガイドでは、Postman を使用して List ルックアップ endpoint への初回リクエストを送信する手順を説明します。 各種言語のサンプルを確認する場合は、X API v2 サンプルコード の GitHub リポジトリをご覧ください。 注: この例では、List lookup by ID endpoint にリクエストを送信しますが、このクイックスタートで学んだ内容は他のルックアップ リクエストにも適用できます。

​
前提条件

このガイドを完了するには、リクエストの認証に使用する一連の キーおよびトークン が必要です。以下の手順でこれらのキーおよびトークンを生成できます。
  • デベロッパーアカウントに登録 して承認を受ける。
  • developer portal で Project を作成し、関連付けられた 開発者用 App を作成する。
  • App の「Keys and tokens」ページに移動して、必要な認証情報を生成する。すべての認証情報は安全な場所に保存すること。

​
List ルックアップリクエストを構築する手順

ステップ1：ツールまたはライブラリから始める この endpoint にリクエストを送る方法として使用できるツール、コード例、ライブラリは複数ありますが、ここでは手順を簡素化するために Postman を使用します。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください。
Postman に X API v2 コレクションを読み込んだら、「List」フォルダに移動し、「List lookup」フォルダを選択してから “List by ID” を選択します。   ステップ2：リクエストを認証する X API に正しくリクエストを行うには、権限があることを確認する必要があります。この endpoint では、App only、OAuth 2.0 Authorization Code with PKCE、または OAuth 1.0a User Context のいずれかの認証方法でリクエストを認証する必要があります。 簡便のため、このリクエストでは App only を使用しますが、非公開のmetrics や List を取得したい場合は、他の認証方法のいずれかを使用する必要があります。  App only を使用するには、Postman の右上にある “X API v2” という名前の環境を選択し、「initial value」と「current value」フィールド（環境ドロップダウン横の目のアイコンをクリック）に、キーおよびトークン（特に App only Access Token）を追加します。 正しく設定できていれば、これらの変数はリクエストの authorization タブに自動で反映されます。   ステップ3：取得したい List を特定して指定する リクエスト内で、取得したい List を指定する必要があります。List の ID は、x.com にアクセスして List をクリックし、URL を確認することで見つけられます。例えば、次の URL の List ID は 84839422 です。 https://x.com/i/lists/84839422 対象の ID は有効な List ID であればどれでも構いません。Postman で「Params」タブに移動し、id パス変数の「Value」列に ID を入力します。ID の前後にスペースを含めないようにしてください。
KeyValue
id84839422（List ID）
ステップ4：取得したい fields を特定して指定する ステップ3の後に「Send」ボタンをクリックすると、レスポンスにはデフォルトの List object の fields（id, name）が返されます。 追加の fields を取得したい場合は、list.fields および/または expansion パラメータでそれらをリクエストに指定してください。 この演習では、異なるオブジェクトから追加で 3 つの fields セットを要求します。
  • プライマリの Lists オブジェクトにおける created_at の追加
  • expansion パラメータを使用した完全な user object
  • 関連するユーザーオブジェクトにおける user.created_at の追加
Postman で「Params」タブに移動し、「Query Params」テーブルに次の key:value ペアを追加します。
KeyValueReturned fields
list.fieldscreated_atcreated_at
expansionsowner_idincludes.users.id,
includes.users.name,
includes.users.username
user.fieldscreated_atincludes.users.created_at
これで、「Send」ボタンの横に次のような URL が表示されるはずです。 https://api.x.com/2/lists/84839422?list.fields=owner_id&expansions=owner_id&user.fields=created_at ステップ5：リクエストを送信し、レスポンスを確認する すべての設定が完了したら、「Send」ボタンを押すと、次のサンプルに類似したレスポンスが返ってきます。 
{
  "data": {
    "id": "84839422",
    "name": "公式Xアカウント",
    "owner_id": "783214"
  },
  "includes": {
    "users": [
      {
        "name": "Twitter",
        "created_at": "2007-02-20T14:35:54.000Z",
        "username": "Twitter",
        "id": "783214"
      }
    ]
  }
}
⌘I