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

​
search Spaces endpoint のはじめ方

このクイックスタート ガイドでは、Postman を使用して、指定した一連の fields を含めた search Spaces endpoint への最初のリクエストの実行手順を説明します。 さまざまなプログラミング言語でのサンプルコードをご覧になりたい場合は、X API v2 sample code GitHub repositoryにアクセスしてください。
前提条件このガイドを完了するには、リクエストを認証するためのキーおよびトークンが必要です。これらのキーおよびトークンは、次の手順で生成できます。
  • デベロッパーアカウントに登録し、承認を受けます。
  • developer portal でProjectを作成し、関連する開発者用 Appを作成します。
  • App の「Keys and tokens」ページに移動して、必要な認証情報を生成します。すべての認証情報は安全な場所に保存してください。

​
検索 Spaces リクエストを作成する手順

ステップ1: ツールまたはライブラリから始める この endpoint へリクエストを送るために使用できるツール、コード例、ライブラリはいくつかありますが、ここでは手順を簡素化するため Postman を使用します。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください:
Postman に X API v2 コレクションを読み込んだら、Spaces フォルダーに移動して「Search Spaces」リクエストを見つけてください。   ステップ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: 検索 query を作成する この endpoint は検索用の query としてテキストを受け付けます。他の検索 endpoint と異なり、演算子、グルーピング、論理演算子は使用できません。この演習では、簡単な query として「hello」を使用します。 Postman で「Params」タブに移動し、id パラメーターの「Value」列にこのユーザー ID を入力します。
KeyValue
queryhello
ステップ4: 取得したい fields を特定して指定する ステップ3の後に「Send」ボタンをクリックすると、デフォルトではレスポンスに返される Space オブジェクトの唯一の fields である、Spaces の ID とその状態が返されます。 追加の fields を受け取りたい場合は、space.fields または expansions パラメーターでリクエストに指定する必要があります。 この演習では、異なるオブジェクトから追加で 3 つの fields セットをリクエストします:
  • プライマリの Spaces オブジェクト内の追加の title フィールド
  • 指定した creator ID の完全な ユーザーオブジェクト
  • 関連する ユーザーオブジェクト 内の追加の user.created_at フィールド
Postman で「Params」タブに移動し、「Query Params」テーブルに次のキー:値のペアを追加します:
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/search?query=hello&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