Skip to main content

​
v1.1 と v2 の Direct Message イベント lookup エンドポイントの比較

Direct Messages エンドポイントには v1.1 と v2 の両方に、Direct Message イベントを取得するためのメソッドが用意されています。このガイドは、両者の違いを理解し、v2 への移行に役立つ情報を提供することを目的としています。 両バージョン間の大きな違いは、v1.1 は 1 対 1 の会話のみをサポートしているのに対し、v2 ではグループ会話のサポートが導入されている点です。この結果として、v1.1 は「message created」イベントのみをサポートしていますが、v2 では会話への参加や退出に関連するイベントもサポートしています。実際、v2 の基本的な更新点として、dm_conversations がコア API オブジェクトとして確立されています。 v1.1 には Direct Messages を取得するための 2 つのエンドポイントがあります（繰り返しになりますが、v1.1 でサポートされるイベントタイプは新規メッセージのみです）。
  • GET direct_messages/events/show - 単一のイベントを ID で取得します。
  • GET direct_messages/events/list - 認証済みユーザーが送受信した 1 対 1 の Direct Messages を最大 30 日分取得します。このメソッドはグループ会話からメッセージを取得できないことに注意してください。
この v2 リリースでは、Direct Message 会話のイベントを取得するための GET メソッドが 3 つ用意されています。
  • GET /2/dm_conversations/with/:participant_id/dm_events - 1 対 1 の会話に関連する Direct Message イベントを取得します。:participant_id パスパラメータは、このリクエストを行う認証済みユーザーと会話している相手のアカウントの User ID です。
  • GET /2/dm_conversations/:dm_conversation_id/dm_events - :dm_conversation_id パスパラメータで示される特定の会話 ID に関連する Direct Message イベントを取得します。このメソッドは 1 対 1 とグループの両方の会話をサポートします。
  • GET /2/dm_events - 1 対 1 とグループの両方の会話を含む、ユーザーに関連する Direct Message イベントを取得します。過去 30 日までのイベントを取得できます。
重要な点として、会話 ID とイベント ID は X Platform の v1.1 と v2 間で共有されます。つまり、両バージョンを併用することが可能です。例えば、Direct Messages v1.1 エンドポイントには単一のイベントを返すメソッドやイベントを削除するメソッド（v2 ではまだ利用不可）が用意されており、ID が v1.1 と v2 で共通のため、v2 が返した ID や X アプリケーションの会話 URL に表示される会話 ID を基に v1.1 リクエストを行うことができます。 次の表は、v1.1 と v2 の Direct Message イベント lookup エンドポイントの基本的な側面を比較したものです。ここで示す X API v2 の特徴は、すべての Direct Message lookup エンドポイントに共通しています。 以下の表は、v2 の各 GET メソッドを v1.1 と比較したものです。これらの v2 の機能は、グループ会話をサポートすることで利用可能な機能を拡張していることに注意してください。 特定の 1 対 1 の会話のすべてのメッセージを取得
Path: GET /2/dm_conversations/with/:participant_id/dm_events 会話 ID ですべてのメッセージを取得 Path: GET /2/dm_conversations/:dm_conversation_id/dm_events 認証済みユーザーの 1 対 1 とグループの両方の会話にわたるすべてのイベントを取得 Path: GET /2/dm_events