メインコンテンツへスキップ
このページでは、mutes エンドポイントをシステムに統合する際に把握しておくべき各種ツールと主要な概念について説明します。内容は次のセクションに分かれています。

役立つツール

このエンドポイントの統合に役立つ重要な概念に入る前に、次の内容に慣れておくことをおすすめします。

Postman

Postman は、エンドポイントのテストに役立つ優れたツールです。各 Postman リクエストには、利用可能な内容をすばやく把握できるよう、すべてのパスおよびボディのパラメータが含まれています。Postman コレクションの詳細については、“Postman の使い方”ページをご覧ください。 

コードサンプル

お好みのプログラミング言語で、このエンドポイントのセットアップをコードと併せて試してみませんか?出発点として使える複数のコードサンプルを、GitHub ページで提供しています。

サードパーティ製ライブラリ

コミュニティが提供しているサードパーティ製ライブラリを活用して、スムーズに始めましょう。適切なバージョンタグを確認すれば、v2 エンドポイントに対応するライブラリを見つけられます。

主要な概念

認証

すべての X API v2 エンドポイントでは、キーやトークンとも呼ばれる一連の認証情報を用いてリクエストを認証する必要があります。これらのエンドポイントへのリクエストの認証には、OAuth 1.0a ユーザーコンテキスト、または OAuth 2.0 認可コード(PKCE 対応)のいずれかを使用できます。 OAuth 1.0a ユーザーコンテキスト では、API Keys、ユーザーの Access Tokens、その他いくつかのパラメータを用いてauthorization ヘッダーを作成し、それをリクエストに付与する必要があります。Access Tokens は、あなたが代理してリクエストを行うユーザーに紐づいていなければなりません。別のユーザーの Access Tokens を生成したい場合は、そのユーザーが 3-legged OAuth フローを使用してあなたのアプリを承認する必要があります。 なお、OAuth 1.0a は扱いが難しい場合があります。この認証方式に不慣れな場合は、ライブラリを利用する、Postman のようなツールを使う、または OAuth 2.0 でリクエストを認証することを推奨します。 OAuth 2.0 認可コード(PKCE 対応) は、アプリケーションのスコープや複数デバイス間での認可フローをより柔軟かつ細かく制御できます。OAuth 2.0 では、ユーザーに代わって特定の権限を付与するためのきめ細かなスコープを選択できます。 アプリで OAuth 2.0 を有効にするには、開発者ポータルの App 設定セクションにあるアプリの認証設定で有効化する必要があります。

開発者ポータル、プロジェクト、開発者アプリ

X API v2 のエンドポイントで使用できる認証情報一式を取得するには、開発者アカウントに登録し、そのアカウント内でプロジェクトを設定し、そのプロジェクト内に開発者アプリを作成する必要があります。キーとトークンは開発者アプリ内で確認できます。  

レート制限

毎日、数多くの開発者が X API にリクエストを送信しています。これらの膨大なリクエスト量を管理するため、各エンドポイントにはレート制限が設定されており、アプリまたは認証済みユーザーに代わって実行できるリクエスト数が制限されています。  これらのエンドポイントはユーザーレベルでレート制限されています。つまり、リクエスト対象の認証済みユーザーは、どの開発者アプリ経由であっても、そのエンドポイントを一定回数までしか呼び出せません。 POST および DELETE メソッドについては、エンドポイントごとに 15 分あたり 50 回のユーザー単位のレート制限があります。ただし、GET メソッドでは、レート制限は 15 分あたり 15 回です。  

fields と expansions

X API v2 の GET エンドポイントでは、fields と expansions という一連の機能を使って、API から返す data を正確に指定できます。expansions パラメータを使用すると、ペイロード内で参照されているオブジェクトを展開できます。たとえば、このエンドポイントでは次の expansions を取得できます:
  • pinned_tweet_id
fields パラメータを使用すると、受け取りたい各種データオブジェクト内のどの fields を返すかを正確に指定できます。このエンドポイントは主に User オブジェクトを返します。既定では、User オブジェクトは idnameusername の fields を返します。user.created_atuser.entities などの追加の fields を受け取るには、fields パラメータで明示的にリクエストする必要があります。 X API v2 data dictionary に、fields と expansions を組み合わせて使用する方法に関するガイドを追加しました。 ミュートのルックアップは大量のデータを返す場合があります。常に一貫性があり高パフォーマンスな結果を提供するため、ページネーションを使用します。ページネーションは、単一のレスポンスで返せる件数を超える結果を返す X API v2 のエンドポイントに備わる機能です。その場合、data は複数の「ページ」に分割されて返されます。結果をページネーションで取得する方法をご確認ください。
ご注意: ユーザーが X 上でミュートした場合、15 分あたり 200 リクエストの上限があります。