統合ガイド

このページでは、Retweet エンドポイントをシステムに統合するにあたって把握しておくべき、各種ツールや主要な概念について説明します。内容は以下のセクションに分かれています。

• 便利なツール
• 主要な概念
• 認証
• 開発者ポータル、プロジェクト、アプリ
• レート制限
• fields と Expansions

​

役立つツール

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

​

Postman

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

​

コードサンプル

お好みのプログラミング言語でこのエンドポイントをセットアップしたい方へ。出発点として使える各種コードサンプルをGitHub ページで提供しています。

​

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

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

​

重要な概念

​

認証

すべての X API v2 エンドポイントでは、リクエストを認証するために、キーやトークンとも呼ばれる一式の資格情報が必要です。

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

Retweets 管理エンドポイントでは OAuth 1.0a ユーザーコンテキストが必須です。これは、リクエストを成功させるには API キーとユーザーアクセストークンのセットを使用する必要があることを意味します。アクセストークンは、あなたが代理してリクエストを行う対象ユーザーに関連付けられている必要があります。別のユーザー向けにアクセストークンを生成したい場合は、そのユーザーが 3-legged OAuth フローを使用してあなたのアプリを承認または認証する必要があります。

OAuth 1.0a の使用は難しい場合があります。この認証方法に不慣れな場合は、ライブラリ を使用して適切にリクエストを認証することをお勧めします。

ご注意

以下の 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

​

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

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

​

レート制限

毎日、非常に多くの開発者が X API にリクエストを送信しています。これらのリクエストの膨大な量を管理するため、レート制限 が各エンドポイントに設定されており、アプリまたは認証済みユーザーとして行えるリクエスト数が制限されています。

Retweet 管理エンドポイントは、15 分あたり 50 リクエスト（ユーザー単位）に制限されています。さらに、POST エンドポイントでは、3 時間ウィンドウあたり 300 リクエスト（ユーザーごと、アプリごと）に制限されています。 

Retweet ルックアップエンドポイントでは、15 分ウィンドウあたり 75 リクエストに制限されています。加えて、このエンドポイントで返されるのは、直近に Retweet したユーザー上位 100 人のみです。

​

fields と expansions

X API v2 では、fields と expansions と呼ばれる一連のツールを使って、API から返す data を正確に指定できます。expansions パラメータを使用すると、ペイロード内で参照されているオブジェクトを展開できます。たとえば、このエンドポイントでは次の 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 を選択できます。これらのエンドポイントは主に Post オブジェクトを返します。デフォルトでは、Post オブジェクトは id と text の fields を返します。tweet.created_at や tweet.entities などの追加の fields を受け取るには、fields パラメータで明示的にリクエストする必要があります。インテグレーションでの利用を検討すべき重要な fields には、poll の data、metrics、Post annotations、そして conversation ID があります。

fields と expansions の使い方 をまとめたガイドを、X API v2 data dictionary に追加しました。