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

​
Spaces ルックアップエンドポイントのはじめ方

このクイックスタートガイドでは、Postman を使用して、指定した一連の fields を含めて Spaces ルックアップエンドポイントのいずれかへ最初のリクエストを送信する方法を説明します。 異なるプログラミング言語でのサンプルコードをご覧になりたい場合は、X API v2 sample code GitHub リポジトリをご参照ください。

​
前提条件

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

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

この例では、作成者 ID によるユーザー Spaces ルックアップエンドポイントへのリクエストを行いますが、このクイックスタートの内容は他のルックアップリクエストにも応用できます。 ステップ 1: ツールまたはライブラリを用意する このエンドポイントにリクエストする方法はいくつかありますが、ここでは手順を簡単にするため Postman を使用します。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください:
Postman に X API v2 コレクションを読み込んだら、Spaces フォルダーに移動し、「Lookup Spaces created by one or more users」というリクエストを見つけてください。   ステップ 2: リクエストを認証する X API に正しくリクエストするには、権限を確認する必要があります。そのため、このエンドポイントでは OAuth 2.0 App-Only か OAuth 2.0 Authorization Code with PKCE のいずれかでリクエストを認証する必要があります。 簡便さのため、ここでは OAuth 2.0 App-Only を使用します。ただし、非公開の metrics や非公開ユーザーの Spaces を取得したい場合は、他の認証方法を使用する必要があります。  OAuth 2.0 App-Only を使用するには、キーとトークン、特に App Access Token（App-only Bearer Token）を Postman に追加します。これには、Postman 右上の “X API v2” という環境を選択し、「initial value」と「current value」の fields にキーとトークンを入力します（環境ドロップダウン横の目のアイコンをクリック）。 正しく設定できていれば、これらの変数はリクエストの authorization タブに自動的に反映されます。   ステップ 3: どのユーザーの Post を取得するか特定して指定する リクエスト内で、ライブまたは今後予定されている Spaces を取得したいユーザーを指定する必要があります。この例では、単一のユーザー ID を渡します。 ユーザー ID は、アカウントのプロフィール URL から取得できる、そのアカウントを表す数値です。例えば、次のアカウントのユーザー名は XDevelopers です。 https://x.com/XDevelopers このユーザー名をユーザー ID に変換するには、ユーザールックアップエンドポイントにユーザー名を渡し、ペイロード内の数値のユーザー ID を確認します。@XDevelopers の場合、ユーザー ID は 2244994945 です。 Postman で「Params」タブを開き、id パラメータの「Value」列にこのユーザー ID を入力します。
KeyValue
id2244994945
ステップ 4: 取得する fields を特定して指定する ステップ 3 の後に「Send」ボタンをクリックすると、レスポンスではデフォルトで返される Space object の唯一のフィールドである id が得られます。 追加の fields を取得したい場合は、リクエストで space.fields または expansions パラメータを指定する必要があります。 この演習では、異なるオブジェクトから 3 つの追加のフィールドセットをリクエストします:
  • プライマリの Spaces オブジェクトの追加フィールド title
  • 指定した creator ID の完全な user object
  • 関連ユーザーオブジェクトの追加フィールド user.created_at
Postman で「Params」タブを開き、「Query Params」テーブルに次の key:value を追加します:
KeyValueReturned fields
space.fieldstitlecreator_id
expansionscreator_idincludes.users.id, includes.users.name, includes.users.username
user.fieldscreated_atincludes.users.created_at
これで、「Send」ボタンの横に次の URL が表示されるはずです: https://api.x.com/2/spaces/by/creator_ids?user_ids=2244994945&space.fields=creator_id&expansions=creator_id&user.fields=created_at ステップ5：リクエストを送信し、レスポンスを確認する 準備が整ったら「Send」ボタンをクリックし、次のレスポンスを受け取ります。 
{
   "data": [
    {
        "creator_id": "2244994945",
        "id": "1zqKVXPQhvZJB",
        "title": "Hello world 👋",
        "state": "Running"
   },
   "includes": {
       "users": [
           {
               "created_at": "2013-12-14T04:35:55.000Z",
               "name": "Twitter Dev",
               "id": "2244994945",
               "username": "TwitterDev"
           }
       ]
   }
]
}