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

​
Spaces の lookup endpoint を使い始める

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

​
前提条件

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

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

この例では、作成者 ID によるユーザー Spaces ルックアップ endpoint へのリクエストを行いますが、このクイックスタートで得た内容は他のルックアップリクエストにも適用できます。 手順 1: ツールまたはライブラリを用意する この endpoint にリクエストを送信するために使用できるツール、コード例、ライブラリはいくつかありますが、ここでは手順を簡素化するために Postman を使用します。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください:
Postman に X API v2 コレクションを読み込んだら、Spaces フォルダーに移動し、“Lookup Spaces created by one or more users” リクエストを見つけてください。   手順 2: リクエストを認証する X API に正しくリクエストを行うには、権限があることを確認する必要があります。そのためこの endpoint では、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」フィールドにキーおよびトークンを追加します（環境ドロップダウン横の目のアイコンをクリック）。 正しく設定できていれば、これらの変数はリクエストの Authorization タブに自動的に反映されます。   手順 3: どのユーザーから Posts を取得するか特定して指定する リクエスト内で、ライブまたは今後予定されている Spaces を取得したいユーザーを指定する必要があります。この例では、単一のユーザー ID を渡します。 ユーザー ID は、アカウントのプロフィール URL 内で確認できるアカウントのハンドルを表す数値です。例えば、次のアカウントのユーザー名は XDevelopers です。 https://x.com/XDevelopers このユーザー名をユーザー ID に変換するには、ユーザー名を使って user lookup endpoint を呼び出し、ペイロード内の数値のユーザー ID を確認します。@XDevelopers の場合、ユーザー ID は 2244994945 です。 Postman で “Params” タブに移動し、このユーザー ID を id パラメータの “Value” 列に入力します。
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"
           }
       ]
   }
]
}
⌘I