統合ガイド

このページでは、リツイート endpoint をシステムに統合する際に把握しておくべき各種ツールと主要な概念について説明します。ページは次のセクションに分かれています。

• 便利なツール
• 主要な概念
• 認証
• developer portal、Project、App
• レートリミット
• fields と expansions

​

便利なツール

この endpoint を統合する際に役立つ重要な概念に入る前に、次の内容にあらかじめ慣れておくことをおすすめします。

​

Postman

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

​

コードサンプル

お好みのプログラミング言語でこの endpoint の利用を始めたい方へ。出発点として使える各種コードサンプルをGitHub ページで提供しています。

​

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

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

​

重要な概念

​

認証

すべての X API v2 endpoint では、リクエストを認証するために、キーおよびトークンとしても知られる一連の認証情報が必要です。

Retweets ルックアップ endpoint へのリクエストの認証には、OAuth 1.0a ユーザーコンテキストまたは OAuth 2.0 Bearer Token のいずれかを使用できます。

Retweets 管理用の endpoint では OAuth 1.0a ユーザーコンテキストが必要です。これは、リクエストを成功させるために API Key とユーザーの Access Tokens のセットを使用する必要があることを意味します。Access Tokens は、あなたが代理してリクエストを行うユーザーに関連付けられていなければなりません。別のユーザーの Access Tokens を生成する場合、そのユーザーは 3-legged OAuth フローを用いてあなたの App を認可または認証する必要があります。

OAuth 1.0a の利用は難しい場合があります。この認証方式に不慣れな場合は、リクエストを適切に認証するためにlibraryの使用を推奨します。

ご注意

以下の fields をリクエストする場合は、OAuth 1.0a ユーザーコンテキストが必要です:

• tweet.fields.non_public_metrics
• tweet.fields.promoted_metrics
• tweet.fields.organic_metrics
• media.fields.non_public_metrics
• media.fields.promoted_metrics
• media.fields.organic_metrics

​

developer portal、Projects、開発者用 App

X API v2 の endpoint で動作する認証情報のセットを取得するには、デベロッパーアカウントに登録し、そのアカウント内でProjectを作成し、その Project 内に開発者用 Appを作成する必要があります。キーおよびトークンは、開発者用 App 内で確認できます。   

​

レートリミット

毎日、数千人の開発者が X API にリクエストを送信しています。これらの膨大なリクエスト量を管理するために、レートリミット が各 endpoint に設定されており、App または認証済みユーザーに代わって行えるリクエスト数が制限されています。

Retweet 管理用の endpoints は、15分あたり50リクエスト（ユーザー単位）に制限されています。さらに、POST endpoint については、3時間ウィンドウあたり300リクエスト（ユーザー単位、App 単位）に制限されています。

Retweet ルックアップ endpoint は、15分ウィンドウあたり75リクエストに制限されています。加えて、この endpoint で返されるのは、Retweet を行ったユーザーのうち直近の100名のみです。

​

fields と expansions

X API v2 では、fields と expansions と呼ばれる一連のツールを使って、API から返す data を正確に選択できます。expansions パラメータを使用すると、ペイロード内で参照されているオブジェクトを展開できます。たとえば、この endpoint では次の expansions を取得できます:

• attachments.poll_ids
• attachments.media_keys
• author_id, entities.mentions.username
• geo.place_id
• in_reply_to_user_id,
• referenced_tweets.id,
• referenced_tweets.id.author_id

fields パラメータを使用すると、受け取りたい各種データオブジェクト内のどの fields を返すかを正確に指定できます。これらの endpoint は主に Post オブジェクトを返します。デフォルトでは、Post オブジェクトは id と text の fields を返します。tweet.created_at や tweet.entities などの追加の fields を受け取るには、fields パラメータで明示的にリクエストする必要があります。統合での利用を検討すべき重要な fields には、poll の data、metrics、Post の annotations、会話 ID の fields などがあります。

X API v2 data dictionary に、fields と expansions を併用する方法に関するガイドを追加しました。