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

​
List lookup エンドポイントの利用を開始する

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

​
前提条件

このガイドを完了するには、リクエストの認証に必要な一連のキーとトークンが必要です。以下の手順に従って、これらのキーとトークンを生成できます。
  • 開発者アカウントに登録し、承認を受けます。
  • 開発者ポータルでProjectと関連付けられた開発者アプリを作成します。
  • アプリの「Keys and tokens」ページに移動して、必要な認証情報を生成します。すべての認証情報は安全な場所に保管してください。

​
List lookup リクエストを作成する手順

ステップ1：ツールまたはライブラリを用意する このエンドポイントにリクエストを送るには、いくつかの方法があります。ツール、コード例、ライブラリが多数ありますが、ここでは手順を簡素化するために Postman を使用します。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください。
Postman に X API v2 コレクションを読み込んだら、「List」フォルダに移動し、「List lookup」フォルダを選択してから “List by ID” を選びます。   ステップ2：リクエストを認証する X API に正しくリクエストするには、権限があることを確認する必要があります。このエンドポイントでは、App only、OAuth 2.0 Authorization Code with PKCE、または OAuth 1.0a User Context のいずれかの認証方法でリクエストを認証する必要があります。 簡便さのため、このリクエストでは App only を使用しますが、非公開のmetrics や List にアクセスしたい場合は、他の認証方法のいずれかを使用する必要があります。  App only を使用するには、Postman で「X API v2」という名前の環境（Postman の右上）を選択し、キーとトークン（特に App only Access Token）を「initial value」と「current value」フィールドに追加します（環境ドロップダウンの横にある目のアイコンをクリック）。 正しく設定できていれば、これらの変数はリクエストの 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 や expansions パラメータでそれらをリクエストに指定する必要があります。 この演習では、異なるオブジェクトから追加で 3 つの fields セットを要求します。
  • プライマリの Lists オブジェクトにおける created_at の追加
  • expansions パラメータを使って取得する完全な 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": "Official Twitter Accounts",
    "owner_id": "783214"
  },
  "includes": {
    "users": [
      {
        "name": "Twitter",
        "created_at": "2007-02-20T14:35:54.000Z",
        "username": "Twitter",
        "id": "783214"
      }
    ]
  }
}