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

​
manage Lists エンドポイントグループのはじめ方

このクイック概要では、Postman を使用して manage List エンドポイントへの最初のリクエストを送信する方法を説明します。 各種言語のサンプルコードをご覧になりたい場合は、X API v2 sample code の GitHub リポジトリをご参照ください。 注: この例では Create a List エンドポイントにリクエストを送信しますが、このクイックスタートで得た内容は他の manage 系リクエストにも適用できます。
前提条件このガイドを完了するには、リクエストを認証するための一連の キーおよびトークン が必要です。次の手順でこれらのキーおよびトークンを生成できます。

​
List 管理リクエストを作成する手順

ステップ1: ツールまたはライブラリを用意する この endpoint にリクエストを送るためのツール、コード例、ライブラリはいくつかありますが、ここでは手順を簡素化するため Postman を使用します。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください:
Postman に X API v2 コレクションを読み込んだら、「List」フォルダに移動し、その中の「Manage List」フォルダを選択して、“Create a List” を選びます。 ステップ2: リクエストを認証する X API に適切にリクエストを送信するには、権限があることを確認する必要があります。manage Posts の endpoints を使用する場合は、OAuth 1.0a User Context または OAuth 2.0 Authorization Code with PKCE のいずれかでリクエストを認証してください。 この例では、OAuth 1.0a User Context を使用します。 Postman にキーおよびトークン（具体的には API Key、API Secret Key、OAuth 1.0a ユーザー Access Token、OAuth 1.0a ユーザー Access Token Secret）を追加する必要があります。Postman 右上の “X API v2” という environment を選択し、environment ドロップダウン横の目のアイコンをクリックして、“initial value” と “current value” の fields にキーおよびトークンを入力します。 正しく設定できていれば、これらの変数はリクエストの authorization タブに自動的に反映されます。   ステップ3: 新しい List の名前を指定する この endpoint で新しい List を作成する場合、List 名は必須の body パラメータです。任意で説明を追加したり、List を非公開にするかどうかを指定できます。 Postman では「Body」タブに移動し、name パラメータの値として List の名前を入力します。さらに、List に説明を追加したい場合は、name と同様の形式で description というキーを追加し、その値として List の説明を入力します。List を非公開にする場合も同様で、このパラメータには true または false のみが指定できます。 
KeyValueParameter type
nameName of the list (required)body
descriptionDescription for the list (optional)body
privatetrue or false (optional)body
これで、“Send” ボタンの横に次のような URL が表示されるはずです: https://api.x.com/2/lists ステップ4: リクエストを送信してレスポンスを確認する すべての設定が完了したら、“Send” ボタンをクリックすると、次の例と同様のレスポンスが返されます: 
{
  "data": {
    "id": "1441162269824405510",
    "name": "Postmanから作成された新しいList"
  }
}
返ってきたレスポンスオブジェクトに id と List の名前が含まれていれば、List は正常に作成されています。  List を削除するには、Postman に読み込んだ X API v2 コレクションの「Lists」フォルダー内にある「Delete a List」リクエストを選択します。この endpoint では、削除対象の List の ID が必要です。「Params」タブで、削除する List の ID を id 列の値として入力します。  delete リクエストが成功すると、次の例のようなレスポンスが返されます。 
{
  "data": {
    "deleted": true
  }
}
⌘I