クイックスタート

​

blocks lookup endpoint の使い方を始める

このクイックスタート ガイドでは、Postman を使用して blocks lookup endpoint へ初めてのリクエストを送信する手順を説明します。

各種言語のサンプルコードをご覧になりたい場合は、X API v2 sample code の GitHub リポジトリをご参照ください。

​

前提条件

このガイドを完了するには、リクエストを認証するための キーおよびトークン 一式が必要です。以下の手順に従って、これらのキーおよびトークンを生成できます。

• デベロッパーアカウントに登録し、承認を受ける。
• developer portal で Project を作成し、関連付けられた 開発者用 App を作成する。
• App の “Keys and tokens” ページに移動して、必要な認証情報を生成する。すべての認証情報は安全な場所に保存すること。

​

ブロック参照リクエストを作成する手順

​

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

この endpoint にリクエストを送信する方法として使用できるツール、コード例、ライブラリはいくつかありますが、ここでは手順を簡素化するために Postman を使用します。

X API v2 の Postman コレクションを環境に読み込むには、次のボタンをクリックしてください:

X API v2 を Postman に追加

Postman で X API v2 コレクションを読み込んだら、「Blocks」フォルダーに移動し、「Blocks Lookup」を選択します。  

​

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

X API に正しくリクエストするには、権限があることを確認する必要があります。この endpoint で実行するには、OAuth 1.0a ユーザーコンテキスト または OAuth 2.0 Authorization Code（PKCE 付き） のいずれかでリクエストを認証します。

この例では、OAuth 1.0a ユーザーコンテキストを使用します。

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：ユーザーを指定する

このendpointでは、ブロックしている相手を確認するために、あなた自身のユーザーID、または認証済みユーザーのユーザーIDを指定する必要があります。

Postmanで「Params」タブに移動し、id パス変数の「Value」列（このセクションの下部）にこのユーザーIDを入力します。ユーザーIDの前後にスペースを入れないようにしてください。  

Key	Value
id	（あなたのユーザーID）
max_results	5

​

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

ステップ3の後に「Send」ボタンをクリックすると、レスポンスにはデフォルトの ユーザーオブジェクト の fields（id、name、username）が含まれます。

id、name、username 以外の追加の fields を取得したい場合は、リクエストで fields および/または expansions パラメータを使用して、それらの fields を指定する必要があります。

この演習では、異なるオブジェクトから次の3つの追加の fields セットをリクエストします:

1. プライマリのユーザーオブジェクトにおける追加の user.created_at field。
2. 返されたユーザーに関連付けられた固定された Posts のオブジェクトのデフォルト fields: id と text。
3. 関連する Post オブジェクトにおける追加の tweet.created_at field。

Postman で「Params」タブに移動し、「Query Params」テーブルに次の key:value のペアを追加します:

Key	Value	Returned fields
user.fields	created_at	user.created_at
expansions	pinned_tweet_id	tweet.id, tweet.text
tweet.fields	created_at	includes.tweets.created_at

「Send」ボタンの横に、TwitterDev の URL の代わりに自分のユーザーIDを含む、同様の URL が表示されるはずです。

      https://api.x.com/2/users/2244994945/blocking?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=created_at

​

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

すべての設定が完了したら、「Send」ボタンをクリックします。すると、以下の例と同様のレスポンスが返ってきます。

    {
  "data": [
    {
      "created_at": "2008-12-04T18:51:57.000Z",
      "id": "17874544",
      "username": "TwitterSupport",
      "name": "Twitter Support"
    },
    {
      "created_at": "2007-02-20T14:35:54.000Z",
      "id": "783214",
      "username": "Twitter",
      "name": "Twitter"
    },
    {
      "pinned_tweet_id": "1389270063807598594",
      "created_at": "2018-11-21T14:24:58.000Z",
      "id": "1065249714214457345",
      "username": "TwitterSpaces",
      "name": "Spaces"
    },
    {
      "pinned_tweet_id": "1293595870563381249",
      "created_at": "2007-05-23T06:01:13.000Z",
      "id": "6253282",
      "username": "XAPI",
      "name": "X API"
    }
  ],
  "includes": {
    "tweets": [
      {
        "created_at": "2021-05-03T17:26:09.000Z",
        "id": "1389270063807598594",
        "text": "現在、600人以上のフォロワーを持つすべてのユーザーがSpacesをホストできます。\n\n学んだことに基づくと、これらのアカウントは既存のオーディエンスがあるため、ホスティングで良い体験を得る可能性が高いです。Spacesを作成する機能をすべてのユーザーに提供する前に、私たちはいくつかのことに焦点を当てています。🧵"
      },
      {
        "created_at": "2020-08-12T17:11:04.000Z",
        "id": "1293595870563381249",
        "text": "X API v2: Early Accessリリース\n\n本日、新しいTwitter APIの最初のendpointへのEarly Accessを発表しました！\n\n#TwitterAPI #EarlyAccess #VersionBump https://t.co/g7v3aeIbtQ"
      }
    ]
  }

​

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

レスポンスの末尾に meta オブジェクトがあることに気づくかもしれません。next_token を受け取っている場合は、取得可能な次の結果ページが存在することを示します。次のページを取得するには、next_token フィールドの値を取り出し、リクエストに追加する pagination_token パラメータの値として設定します。  

キー	値
pagination_token	1D3PU6DRII9HEZZZ

この追加パラメータを付与してリクエストを送信すると、ステップ3で max_results を 5 と指定しているため、次の 5 件の結果が後続のペイロードで返されます。すべての結果が返されるまでこの手順を繰り返せますが、max_results パラメータを使って 1 回のリクエストで最大 1000 人のユーザーを取得することもでき、その場合はページング回数を減らせます。