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

​
mutes lookup エンドポイントの始め方

このクイックスタートガイドでは、Postman を使用して mutes lookup エンドポイントに最初のリクエストを送信する方法を説明します。 各言語のサンプルコードを確認したい場合は、GitHub の X API v2 sample code リポジトリをご覧ください。
前提条件このガイドを完了するには、リクエストを認証するためのキーとトークンが必要です。これらのキーとトークンは、次の手順で生成できます。

​
ミュートのルックアップリクエストを作成する手順

​
ステップ1：ツールまたはライブラリから始める

このエンドポイントにリクエストを送信する方法として、いくつかのツール、コード例、ライブラリがありますが、ここでは手順を簡略化するために Postman を使用します。 X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください。
Postman で X API v2 コレクションを読み込んだら、「Mutes」フォルダに移動し、「Mutes lookup」を選択します。  

​
ステップ2：リクエストを認証する

X API に正しくリクエストを送信するには、権限があることを確認する必要があります。このエンドポイントでは、OAuth 1.0a ユーザーコンテキスト または OAuth 2.0 認可コード（PKCE 対応） のいずれかでリクエストを認証する必要があります。 この例では、OAuth 1.0a ユーザーコンテキストを使用します。 API Key、API Secret Key、OAuth 1.0a user Access Token、OAuth 1.0a user Access Token Secret を Postman に追加してください。Postman 右上の環境ドロップダウンで “X API v2” という名前の環境を選択し、“initial value” と “current value” の fields にキーとトークンを追加します（環境ドロップダウン横の目のアイコンをクリック）。 正しく設定できていれば、これらの変数はリクエストの authorization タブに自動的に反映されます。  

​
ステップ3：ユーザーを指定する

このエンドポイントでは、あなたまたは認証済みユーザーがミュートしている相手を確認するために、あなたのユーザーIDまたは認証済みユーザーのIDを指定する必要があります。 Postman で「Params」タブに移動し、セクション下部の「Path Variables」にある id の「Value」列に認証済みユーザーの ID を入力します。ID の前後にスペースを入れないでください。 「Path Variables」セクションの上には、追加可能な任意の「Query Params」があります。この例では、変数 max_results を選択し、値に 5 を指定します。
KeyValueParameter Type
id（あなたのユーザーID）Path
max_results5Query

​
ステップ4：取得したい fields を特定して指定する

ステップ3の後に「Send」ボタンをクリックすると、レスポンスにはデフォルトのユーザーオブジェクトの fields（id、name、username）が含まれます。 id、name、username 以外の追加の fields を受け取りたい場合は、リクエストで fields および／または expansions パラメータを使用して、それらの fields を指定する必要があります。 この演習では、異なるオブジェクトから次の3つの追加の fields セットをリクエストします:
  1. プライマリのユーザーオブジェクトに user.created_at の追加 field。
  2. 返されるユーザーに関連付けられた固定された Post のオブジェクトに対するデフォルト fields：id と text。
  3. 関連する Post オブジェクトに tweet.created_at の追加 field。
Postman で「Params」タブに移動し、「Query Params」テーブルに次のキー:値のペアを追加します:
KeyValueReturned fields
user.fieldscreated_atuser.created_at
expansionspinned_tweet_idtweet.id, tweet.text
tweet.fieldscreated_atincludes.tweets.created_at
「Send」ボタンの横に、例の ID URL の代わりに自分のユーザーIDが入った、これに類似したURLが表示されるはずです: https://api.x.com/2/users/1324848235714736129/muting?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=created_at&max_results=5

​
ステップ5：リクエストを送信し、レスポンスを確認する

すべての準備が整ったら、「Send」ボタンをクリックします。次の例のようなレスポンスが返ってきます。 
{
  "data": [
    {
      "username": "TwitterDev",
      "created_at": "2013-12-14T04:35:55.000Z",
      "id": "2244994945",
      "name": "Twitter Dev",
      "pinned_tweet_id": "1430984356139470849"
    }
  ],
  "includes": {
    "tweets": [
      {
        "created_at": "2021-08-26T20:03:51.000Z",
        "id": "1430984356139470849",
        "text": "より良いTwitter Developer Platformづくりにご協力ください！\n \n年次開発者アンケートにご参加ください >>> https://t.co/9yTbEKlJHH https://t.co/fYIwKPzqua"
      }
    ]
  },
  "meta": {
    "result_count": 1
  }
}

​
ステップ6：結果をページングする

レスポンスの末尾に meta オブジェクトがあることに気づくかもしれません。next_token を受け取っている場合は、取得可能な次の結果ページがあることを示します。次のページを取得するには、next_token フィールドの値を取り出し、追加の pagination_token クエリパラメータの値としてリクエストに付与します。  
キー値
pagination_token1710819323648428707
この追加パラメータを付けてリクエストを送信すると、ステップ3で max_results を 5 に指定しているため、次の5件の結果が後続のペイロードで返されます。すべての結果が返るまでこの手順を繰り返せますが、max_results パラメータを使って1回のリクエストで最大1,000ユーザーまで取得することもできるため、頻繁にページングする必要はありません。