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

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

このクイック概要では、Postman を使用して manage List エンドポイントに最初のリクエストを送信する方法を説明します。 さまざまな言語のサンプルコードを確認する場合は、GitHub の X API v2 sample code リポジトリをご覧ください。 注: この例では Create a List エンドポイントにリクエストを送信しますが、このクイックスタートで得た内容は他の manage 系リクエストにも適用できます。
前提条件このガイドを完了するには、リクエストを認証するための keys and tokens が必要です。以下の手順に従うことで、これらの keys と tokens を生成できます。
  • developer account に登録 し、承認を受けます。
  • 開発者ポータルで Project と、それに関連付けられた developer App を作成します。
  • アプリの “Keys and tokens” ページに移動し、必要な認証情報を生成します。すべての認証情報は安全な場所に保存してください。

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

ステップ1：ツールまたはライブラリから始める このエンドポイントにリクエストを送るために使用できるツール、コード例、ライブラリはいくつかありますが、ここではプロセスを簡素化するために Postman を使用します。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください。 Postman に X API v2 コレクションを読み込んだら、「List」フォルダに移動し、フォルダ「Manage List」を選択してから、“Create a List” を選びます。 ステップ2：リクエストを認証する X API に正しくリクエストを行うには、その権限があることを確認する必要があります。manage Posts エンドポイントでこれを行うには、OAuth 1.0a ユーザーコンテキスト または OAuth 2.0 認可コード（PKCE 対応） のいずれかでリクエストを認証する必要があります。 この例では、OAuth 1.0a ユーザーコンテキストを使用します。 Postman にキーとトークン（具体的には API Key、API Secret Key、OAuth 1.0a user Access Token、OAuth 1.0a user Access Token Secret）を追加する必要があります。これを行うには、Postman 右上の「X API v2」という名前の environment を選択し、“initial value” と “current value” の fields にキーとトークンを追加します（environment ドロップダウン横の目のアイコンをクリック）。 正しく設定できていれば、これらの変数は自動的にリクエストの authorization タブに取り込まれます。   ステップ3：新しい List の名前を指定する このエンドポイントで新しい 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で作成された新しいリスト"
  }
}
返却されたレスポンスオブジェクトに id と List の名前が含まれていれば、List の作成は成功です。  List を削除するには、Postman で読み込んだ X API v2 コレクションの「Lists」フォルダにある「Delete a List」リクエストを選択します。このエンドポイントでは、削除する List の ID が必要です。「Params」タブで、削除する List の ID を id 列の値として入力します。  削除に成功すると、次の例のようなレスポンスが返されます。 
{
  "data": {
    "deleted": true
  }
}