クイックスタート

​

List Posts lookup エンドポイントのはじめ方

このクイックスタートガイドでは、Postman を使用して List Posts lookup エンドポイントへ最初のリクエストを送る手順を説明します。

さまざまな言語のサンプルコードを確認したい場合は、X API v2 sample code の GitHub リポジトリをご覧ください。

​

前提条件

このガイドを完了するには、リクエストを認証するための keys and tokens が必要です。次の手順に従って、これらの keys と tokens を生成できます。

• Sign up for a developer account にサインアップして承認を受けます。
• 開発者ポータルで Project と、それに関連付けられた developer App を作成します。
• アプリの「Keys and tokens」ページに移動して、必要な認証情報を生成します。すべての認証情報は安全な場所に保存してください。

​

List Posts ルックアップリクエストを作成する手順

​

ステップ1: ツールまたはライブラリから始める

このエンドポイントにリクエストする方法はいくつかあり、ツールやコード例、ライブラリを利用できますが、ここでは手順を簡単にするため Postman を使用します。

X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください。

X API v2 を Postman に追加

Postman に X API v2 コレクションを読み込んだら、「List」フォルダに移動し、「List Posts」フォルダを選択して、“List Posts lookup” を選びます。  

​

ステップ2：リクエストを認証する

X API に適切にリクエストを行うには、権限があることを確認する必要があります。このエンドポイントでこれを行うには、App only、OAuth 2.0 認可コード（PKCE 対応)、または OAuth 1.0a ユーザーコンテキスト 認証方式のいずれかでリクエストを認証する必要があります。

簡単にするために、このリクエストでは App only を使用しますが、非公開の metrics や Post を取得したい場合は、他の認証方式のいずれかを使用する必要があります。

App only を使用するには、Postman の環境「X API v2」を選択し(Postman の右上隅)、キーとトークン(具体的には App only Access Token、App only Bearer Token とも呼ばれます)を「initial value」と「current value」フィールドに追加する必要があります(環境ドロップダウンの横にある目のアイコンをクリックして追加します)。

これを正しく行った場合、これらの変数は自動的にリクエストの認証タブに取り込まれます。  

​

ステップ3：どのリストからPostを取得するかを特定して指定する

リクエスト内で受け取りたいリストを指定する必要があります。x.comで対象のリストをクリックし、URLを確認するとリストIDを見つけられます。たとえば、次のURLのリストIDは84839422です。

https://x.com/i/lists/84839422

ターゲットIDには、有効なリストIDであればいずれでも指定できます。Postmanで「Params」タブに移動し、id パス変数の「Value」列にIDを入力します。IDの前後にスペースを入れないように注意してください。

Key	Value
id	84839422（リストID）

​

ステップ4: 取得したい fields を特定して指定する

ステップ3の後に「Send」ボタンをクリックすると、レスポンスにはデフォルトの Post object の fields（id と text）が含まれます。

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

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

• プライマリの Lists オブジェクトにおける追加の created_at field。

• expansions パラメータを使用した完全な user object

• 関連する user オブジェクトにおける追加の user.created_at field。

Postman で「Params」タブに移動し、「Query Params」テーブルに次の key:value ペアを追加します:

Key	Value	Returned fields
tweet.fields	created_at	created_at
expansions	author_id	includes.users.id, includes.users.name, includes.users.username
user.fields	created_at	includes.users.created_at

「Send」ボタンの横に、次のような URL が表示されるはずです:

https://api.x.com/2/lists/84839422/tweets?expansions=author_id&user.fields=created_at&max_results=1

​

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

すべての設定が完了したら、「Send」ボタンを押すと、次のサンプルレスポンスに類似したレスポンスが返ってきます。

{
  "data": [
    {
      "author_id": "4172587277",
      "id": "1458172421115101189",
      "text": "A Alemanha registrou nesta semana um recorde de novos casos de Covid-19. Segundo o governo e especialistas em Saúde, pessoas não vacinadas são responsáveis pela situação \nhttps://t.co/4POyaPwMLu"
    }
  ],
  "includes": {
    "users": [
      {
        "username": "MomentsBrasil",
        "name": "Twitter Moments Brasil",
        "created_at": "2015-11-12T16:46:02.000Z",
        "id": "4172587277"
      }
    ]
  },
  "meta": {
    "result_count": 1,
    "next_token": "7140dibdnow9c7btw3z2vwioavpvutgzrzm9icis4ndix"
  }
}

ご注意ください: このエンドポイントのレスポンスでは、指定したList内の最新800件のPostをクエリできます