referenced_tweets.id
および author_id
fields は、完全なオブジェクトに展開できます。特定の Post を投稿したユーザー、またはその Post に含まれるメディア、投票、場所に関連する fields を取得したい場合は、レスポンスで該当の data を受け取れるよう、リクエストに関連する expansion の query パラメータを指定する必要があります。現在、Posts、Users、Lists、Spaces、Direct Message のイベントオブジェクトを返す v2 の endpoint は、いずれも expansions をサポートしています(以下の例を参照)。
リクエストに expansion を含めると、同一のレスポンス内にその展開されたオブジェクトのデフォルト fields を含めて返します。これにより、別個のリクエストを行うことなく、同一レスポンスで追加の data を取得できます。展開されたオブジェクトに関連する追加の fields を取得したい場合は、その展開対象オブジェクトに対応する field パラメータと、レスポンスで受け取りたい fields のカンマ区切りリストを併せて指定してください。なお、fields は必ずしも query で指定した順序で返されるとは限りません。
以下の Post のペイロードには、展開可能な補助オブジェクトに対する参照 ID が含まれています。これには、Post を投稿したユーザーの author_id
、参照されている Post の id
、およびメディア添付のための media_key
が含まれます。
Post ペイロードで利用可能な expansions
Expansion | Description |
---|---|
author_id | Post の作成者を表す ユーザーオブジェクト を返します |
referenced_tweets.id | この Post が参照している(リツイート、引用 Tweet、または返信としての) Post オブジェクトを返します |
edit_history_tweet_ids | Post の編集履歴に含まれる Post オブジェクトを返します |
in_reply_to_user_id | この要求された Post が返信している相手の Post 作成者を表す ユーザーオブジェクト を返します |
attachments.media_keys | Post に含まれる画像、動画、GIF を表す メディアオブジェクト を返します |
attachments.poll_ids | Post に含まれる投票の metadata を含む 投票オブジェクト を返します |
geo.place_id | Post にタグ付けされた場所の metadata を含む プレイスオブジェクト を返します |
entities.mentions.username | Post で言及されたユーザーの ユーザーオブジェクト を返します |
referenced_tweets.id.author_id | 参照されている Post の作成者の ユーザーオブジェクト を返します |
ユーザーペイロードで利用可能なエクスパンション
Expansion | 説明 |
---|---|
pinned_tweet_id | ユーザーのプロフィールの先頭にピン留めされた Post を表す Post オブジェクトを返します |
ダイレクトメッセージイベントのペイロードで利用可能な expansions
Expansion | 説明 |
---|---|
attachments.media_keys | ダイレクトメッセージに添付された Media オブジェクトを返します |
referenced_tweets.id | ダイレクトメッセージで参照された Post オブジェクトを返します |
sender_id | ダイレクトメッセージの作成者であり、会話への参加に参加者を招待したユーザーを表す User オブジェクトを返します |
participant_ids | 会話に参加または退出した参加者を表す User オブジェクトを返します |
Spaces ペイロードで利用可能な expansions
Expansion | 説明 |
---|---|
invited_user_ids | 招待されたアカウントを表すユーザーオブジェクトを返します |
speaker_ids | Space で発言したアカウントを表すユーザーオブジェクトを返します |
creator_id | Space を作成したアカウントを表すユーザーオブジェクトを返します |
host_ids | ホストとして設定されたアカウントを表すユーザーオブジェクトを返します |
topics_ids | クリエイターが設定したトピックの説明を返します |
List ペイロードで利用可能な拡張
Expansion | Description |
---|---|
owner_id | List を作成および管理しているアカウントを表すユーザーオブジェクトを返します |
Media オブジェクトの拡張
geo.place_id
の expansion を含めるよう指定しています。
サンプルリクエスト
Poll オブジェクトの拡張
attachments.poll_ids
の expansions をリクエストします。
サンプルリクエスト
サンプルレスポンス
Place オブジェクトの拡張
geo.place_id
の expansions を指定しています。
サンプルリクエスト
サンプルレスポンス