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

​
search Spaces エンドポイントを使い始める

このクイックスタートガイドでは、Postman を使用し、指定した一連の fields を含めて search Spaces エンドポイントへ最初のリクエストを送る方法を説明します。 他のプログラミング言語でのサンプルコードは、X API v2 sample code GitHub repositoryをご覧ください。
前提条件このガイドを完了するには、リクエストを認証するためのキーとトークンが必要です。以下の手順でこれらのキーとトークンを生成できます。

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

手順1: ツールまたはライブラリを用意する このエンドポイントにリクエストを送る方法はいくつかありますが、ここでは手順を簡素化するために Postman ツールを使用します。ツール、コード例、ライブラリには複数の選択肢があります。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください。
Postman に X API v2 コレクションを読み込んだら、Spaces フォルダーに移動し、「Search Spaces」リクエストを見つけてください。   手順2: リクエストを認証する X API に正しくリクエストするには、権限があることを確認する必要があります。このエンドポイントでは、OAuth 2.0 App-Only または OAuth 2.0 Authorization Code with PKCE のいずれかでリクエストを認証する必要があります。 ここでは簡単のため OAuth 2.0 App-Only を使用しますが、非公開のメトリクスや非公開ユーザーの Spaces を取得したい場合は、他の認証方法を使用する必要があります。  OAuth 2.0 App-Only を使用するには、キーとトークン、具体的には App Access Token（App-only Bearer Token とも呼ばれます）を Postman に追加します。Postman 右上の環境ドロップダウンで「X API v2」という名前の環境を選択し、「initial value」と「current value」フィールドにキーとトークンを入力します（環境ドロップダウン横の目のアイコンをクリック）。 これらの変数は、正しく設定されていれば、リクエストの Authorization タブに自動的に読み込まれます。   手順3: 検索クエリを作成する このエンドポイントは検索クエリとしてテキストを受け取ります。他の検索エンドポイントと異なり、演算子、グルーピング、論理演算子は使用できません。この演習では、シンプルなクエリとして「hello」を使用します。 Postman で「Params」タブに移動し、id パラメータの「Value」列にこのユーザー ID を入力します。
KeyValue
queryhello
手順4: 取得したい fields を特定して指定する 手順3の後に「Send」ボタンをクリックすると、デフォルトではレスポンスに返される唯一の Space オブジェクトの fields である、Spaces の ID とその state が返ってきます。 追加の fields を取得したい場合は、リクエストで space.fields または expansions パラメータを使用して指定します。 この演習では、異なるオブジェクトから次の3つの追加 fields セットをリクエストします:
  • プライマリの Spaces オブジェクトにおける追加の title field
  • 指定した creator ID に対応する完全な user オブジェクト
  • 関連する user オブジェクトにおける追加の user.created_at field
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/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"
           }
       ]
   }
]
}