ピン留めリストの検索

注意: このガイドは、クイックスタート概要の前提条件を完了済みであることを前提としています。

​

ピン留めされた List ルックアップリクエストを作成する手順

ステップ1：Postman で List エンドポイントコレクションを選択

Postman に X API v2 コレクションを読み込んだら、“List” フォルダーに移動し、“Pinned Lists” フォルダーを選択してから、“User’s pinned Lists” を選びます。  

ステップ2：ユーザーを特定して指定

ユーザーのピン留めされた List を取得するには、リクエスト内でそのユーザーの ID を指定する必要があります。ユーザー ID は認証済みユーザーの ID と一致している必要があり、つまりリクエストの認証時にはそのユーザー ID に紐づく Access Tokens を渡す必要があります。この例では、ご自身のユーザーに属する ID を指定できます。ID は次の2つの方法で確認できます。

1. users lookup の username エンドポイントを使用して、username を渡すと id フィールドが返されます。
2. Access Token を確認すると、数値部分がご自身のユーザー ID です。

Postman で、“Params” タブに移動し、このユーザー ID を id パラメータの “Value” 列に入力します。

Key	Value
id	2244994945 (user ID)

ステップ3：取得したい fields を特定して指定

ステップ3の後に “Send” ボタンをクリックすると、レスポンスにはデフォルトの List object の fields、id と name が返されます。

id と name 以外の追加の fields を受け取りたい場合は、リクエストで fields および/または expansions パラメータを指定する必要があります。

この演習では、異なるオブジェクトから3つの追加の fields セットをリクエストします。

• 主となる List オブジェクトの追加フィールド follower_count。
• expansions パラメータを使用した user object の完全版。
• 関連するユーザーオブジェクトの追加フィールド tweet.created_at。

Postman で、“Params” タブに移動し、“Query Params” テーブルに以下の key:value ペアを追加します。

Key	Value	Returned fields
list.fields	follower_count	follower_count
expansions	owner_id	includes.users.id, <br/>includes.users.name, <br/>includes.users.username
user.fields	created_at	includes.users.created_at

“Send” ボタンの横に、次のような URL が表示されるはずです。

https://api.x.com/2/users/2244994945/pinned_lists?expansions=owner_id&list.fields=follower_count&user.fields=created_at

ステップ4：リクエストを送信してレスポンスを確認

セットアップが完了したら、“Send” ボタンを押すと、次の例に類似したレスポンスが返されます。

{
  "data": [
    {
      "follower_count": 0,
      "id": "1454155907651158017",
      "name": "test list",
      "owner_id": "2244994945"
    }
  ],
  "includes": {
    "users": [
      {
        "username": "TwitterDev",
        "id": "2244994945",
        "created_at": "2013-12-14T04:35:55.000Z",
        "name": "Twitter Dev"
      }
    ]
  },
  "meta": {
    "result_count": 1
  }
}