はじめに
- Native フォーマットから X API v2 へ (standard v1.1)
- Native Enriched から X API v2 へ (enterprise)
- Activity Streams から X API v2 へ (enterprise)
全般的な違い
オブジェクトとフィールドのリクエスト
更新された JSON 設計
- JSON のルートレベルでは、従来の標準エンドポイントは Post オブジェクトを statuses 配列で返しますが、X API v2 は data 配列で返します。
- Retweeted や Quoted の「statuses」を参照する代わりに、X API v2 の JSON では Retweeted および Quoted ツイートを参照します。contributors や user.translator_type など、多くのレガシーおよび非推奨フィールドは削除されます。
- Post オブジェクトの favorites と user オブジェクトの favourites の両方を使用する代わりに、X API v2 では like という用語を使用します。
- X では、値を持たない JSON 値 (たとえば null) はペイロードに含めないという規約を採用しています。Post および user の属性は、null ではない値を持つ場合にのみ含められます。
新しい v2 フィールド
- conversation_id フィールド
- context と entities を含む、2 つの新しい annotations フィールド
- いくつかの新しい metrics フィールド
- 新しい reply_setting フィールド。特定のポストに誰が返信できるかを示すフィールドです
standard v1.1 のデータフォーマットから v2 への移行
標準 v1.1 と v2 のペイロード構造の比較
| v1.1 structure | v2 structure | |
|---|---|---|
| Default | { “entities”: { “hashtags”: [], “symbols”: [], “user_mentions”: [], “urls”: [], “media”: [] }, “extended_entities”: , “user”: , “place”: , “retweeted_status/quoted_status” } | { “data”: [{ “id”, “text”, “edit_history_tweet_ids” }] } |
| With defined field and expansion parameters | { “data”: [{ “entities”: { “hashtags”: [], “cashtags”: [], “mentions”: [], “urls”: [], }, “attachments”: { “media_keys”: [], “poll_ids”: [] } }], “includes”: [ “tweets”: [ “users”: [ “media”: [ “places”: [ “polls”: [ ], “matching_rules”: [] } |
ツイートオブジェクト
| Twitter 1.1 format | Twitter v2 の形式 | 必須の v2 パラメータ |
| created_at | data.created_at | tweet.fields=created_at |
| id | N/A id は文字列です | |
| id_str | data.id | default |
| text | data.text | default |
| full_text | N/A text フィールドにはツイート本文全体が含まれます | |
| truncated | N/A text フィールドにはツイート本文全体が含まれます | |
| display_text_range | N/A text フィールドにはツイート本文全体が含まれます | |
| edit_history | data.edit_history_tweet_ids | default |
| edit_controls | data.edit_controls | tweet.fields=edit_controls |
| editable | data.edit_controls.is_edit_eligible | tweet.fields=edit_controls |
| entities | data.entities | tweet.fields=entities |
| entities.user_mentions | data.entities.mentions | tweet.fields=entities |
| entities.symbols | data.entities.cashtags | tweet.fields=entities |
| entities.hashtags | data.entities.hashtags | tweet.fields=entities |
| entities.urls | data.entities.urls | tweet.fields=entities |
| entities.media | includes.media | expansions=attachments.media_keys |
| extended_entities | data.attachments | tweet_fields=attachments |
| in_reply_to_status_id | N/A referenced_tweets.id は文字列です | |
| in_reply_to_status_id_str | data.referenced_tweets.id (if type=replied_to) | expansions=referenced_tweets.id |
| in_reply_to_user_id | N/A in_reply_to_user_id は文字列です | |
| in_reply_to_user_id_str | data.in_reply_to_user_id | tweet.fields=in_reply_to_user_id |
| in_reply_to_screen_name | includes.users..username | tweet.fields=in_reply_to_user_id&expansions=entities.mentions.username |
| user | includes.users | expansions=author_id |
| geo | data.geo.place_id | tweet.fields=geo |
| coordinates | data.geo.place_id | expansions=geo.place_id |
| place | data.geo.place_id | expansions=geo.place_id |
| retweeted_status | data.referenced_tweets.id (if type=retweeted) | expansions=referenced_tweets.id |
| is_quoted_status | 利用できません | |
| quoted_status_id | N/A referenced_tweets.id は文字列です | |
| quoted_status_id_str | data.referenced_tweets.id (if type=quoted) | expansions=referenced_tweets.id |
| quoted_status_permalink | 利用できません | |
| quoted_status | data.referenced_tweets (if type=quoted) | expansions=referenced_tweets.id |
| retweet_count | data.public_metrics.retweet_count | tweet.fields=public_metrics |
| favorite_count | data.public_metrics.like_count | tweet.fields=public_metrics |
| favorited | 利用できません | |
| retweeted | 利用できません | |
| possibly_sensitive | data.possibly_sensitive | tweet.fields=possibly_sensitive |
| lang | data.lang | tweet.fields=lang |
| scopes | 利用できません | |
| withheld | data.withheld | tweet.fields=withheld |
| 1.1 のツイートオブジェクト パラメーター付き URI の例: https://api.x.com/1.1/statuses/lookup.json?id=1359554366051504129&tweet_mode=extended | v2 における Tweet オブジェクトとリクエスト パラメータ付きの URI の例: https://api.x.com/2/tweets?ids=1359554366051504129&tweet.fields=attachments,author_id,context_annotations,conversation_id,created_at,entities,geo,id,in_reply_to_user_id,lang,possibly_sensitive,public_metrics,referenced_tweets,reply_settings,text,withheld |
| { “created_at”: “Wed Feb 10 17:26:34 +0000 2021”, “id”: 1359554366051504129, “id_str”: “1359554366051504129”, “text”: “さあ、ほかの子犬アカウントもフォローしましょう。誰も責めたりしません。 \n\n新しいフォロー管理用エンドポイントを紹介します… https://t.co/3cBZKZUevF”, “truncated”: true, “entities”: { “hashtags”: [], “symbols”: [], “user_mentions”: [], “urls”: [{ “url”: “https://t.co/3cBZKZUevF”, “expanded_url”: “https://twitter.com/i/web/status/1359554366051504129”, “display_url”: “twitter.com/i/web/status/1…”, “indices”: [ 111, 134 ] }] }, “in_reply_to_status_id”: null, “in_reply_to_status_id_str”: null, “in_reply_to_user_id”: null, “in_reply_to_user_id_str”: null, “in_reply_to_screen_name”: null, “user”: { … }, “geo”: null, “coordinates”: null, “place”: null, “contributors”: null, “is_quote_status”: false, “retweet_count”: 18, “favorite_count”: 98, “favorited”: false, “retweeted”: false, “possibly_sensitive”: false, “possibly_sensitive_appealable”: false, “lang”: “en” } | { “data”: [{ “id”:“1359554366051504129”, “テキスト”:“どうぞ、別の子犬アカウントをフォローしてください。私たちは批判しません。\n\n新しい#TwitterAPIにフォロー管理エンドポイントを導入します。v2 APIを使用してアカウントのフォローとフォロー解除ができるようになりました。詳細はこちら https://t.co/mtpd9VIMDa”, “lang”:“ja”, “スレッド_id”:“1359554366051504129”, “possibly_sensitive”: false, “リプライ_設定”:“everyone”, “作成日時_at”:“2021-02-10T17:26:34.000Z”, “著者_id”:“2244994945”, “public_メトリック”:{ “リツイート_count”: 18, “リプライ_count”: 11, “like_count”: 98, “引用ツイート_count”: 7 }, “entities”:{ “hashtags”: [{ “start”: 110, “end”: 121, “tag”:“TwitterAPI” }], “urls”: [{ “start”: 194, “end”: 217, “url”:“https://t.co/mtpd9VIMDa”, “展開後_url”:“https://devcommunity.x.com/t/introducing-the-new-manage-follows-endpoints-to-the-twitter-api-v2/149465”, “display_url”:“devcommunity.com/t/introducing-…”, “images”: [{ “url”:“https://pbs.twimg.com/news_img/1359554367905427457/DczC72__?format=jpg&name=orig”, “width”: 1200, “height”: 630 }, { “url”:“https://pbs.twimg.com/news_img/1359554367905427457/DczC72__?format=jpg&name=150x150”, “width”: 150, “height”: 150 } ], “status”: 200, “title”:“X API v2の新しいフォロー管理エンドポイントのご紹介”, “説明”:“フォローする、しない?X API v2を使えば、この質問に自由に答えることができます。本日、新しいTwitter APIに新しいフォロー管理エンドポイントをリリースすることを発表いたします。約1か月前にフォロー検索エンドポイントをリリースした際に予告したとおり、フォロー関係を管理する機能がついに登場しました。これらはv1.1 APIで最も人気のあるエンドポイントの一部であり、X API v2で幅広いユースケースを実現できることを嬉しく思います。W…”, “unwound_url”:“https://devcommunity.x.com/t/introducing-the-new-manage-follows-endpoints-to-the-twitter-api-v2/149465” }] }, “context_annotations”: [{ “domain”:{ “id”:“46”, “name”:“ブランドカテゴリー”, “説明”:“ブランドバーティカル内でブランドの範囲を絞り込むカテゴリ” }, “entity”:{ “id”:“781974596752842752”, “name”:“サービス” } }, { “domain”:{ “id”:“47”, “name”:“ブランド”, “説明”:“ブランドおよび企業” }, “entity”:{ “id”:“10045225402”, “name”:“X” } } ] }] } |
User オブジェクト
| Twitter 1.1 の形式 | Twitter v2 の形式 | 必須の v2 パラメーター |
| user_id | data.author_id | tweet.fields=author_id |
| user.id | N/A。includes.users.id を使用 | |
| user.id_str | includes.users.id | expansions=author_id |
| user.name | includes.users.name | expansions=author_id |
| user.screen_name | includes.user.username | expansions=author_id |
| user.location | includes.users.location | expansions=author_id&user.fields=location |
| user.description | includes.users.description | expansions=author_id&user.fields=description |
| user.url | includes.users.url | expansions=author_id&user.fields=entities |
| user.entities | includes.users.entities | |
| user.entities.url.urls.url | includes.users.entities.url.urls.url | |
| user.entities.url.urls.expanded_url | includes.users.entities.url.urls.expanded_url | expansions=author_id&user.fields=entities |
| user.entities.url.urls.display_url | includes.users.entities.url.urls.display_url | expansions=author_id&user.fields=entities |
| user.entities.url.urls.display_url.indicies[0] | includes.users.entities.url.urls.start | expansions=author_id&user.fields=entities |
| user.entities.url.urls.display_url.indicies[1] | includes.users.entities.url.urls.end | expansions=author_id&user.fields=entities |
| user.protected | includes.users.protected | expansions=author_id&user.fields=protected |
| user.followers_count | includes.users.public_metrics.followers_count | expansions=author_id&user.fields=public_metrics |
| user.friends_count | includes.users.public_metrics.following_count | expansions=author_id&user.fields=public_metrics |
| user.listed_count | includes.users.public_metrics.listed_count | expansions=author_id&user.fields=public_metrics |
| user.created_at | includes.users.created_at | expansions=author_id&user.fields=created_at |
| user.favourites_count | ||
| user.verified | includes.users.verified | expansions=author_id&user.fields=verified |
| user.statuses_count | includes.users.public_metrics.tweet_count | expansions=author_id&user.fields=public_metrics |
| user.profile_image_url_https | includes.users.profile_image_url | expansions=author_id&user.fields=profile_image_url |
| v1.1 の User オブジェクト | v2 の User オブジェクトとリクエスト |
| ”user”:{ “id”: 2244994945, “id_str”:“2244994945”, “name”:“Twitter Dev”, “screen_name”:“TwitterDev”, “location”:“127.0.0.1”, “description”:“#TwitterDevチームの声であり、#TwitterAPIに関する最新情報、ニュース、イベントの公式情報源です。”, “url”:“https://t.co/3ZX3TNiZCY”, “entities”:{ “url”:{ “urls”: [{ “url”:“https://t.co/3ZX3TNiZCY”, “展開_url”:“https://developer.x.com/ja/community”, “display_url”:“developer.x.com/ja/community”, “indices”: [ 0, 23 ] }] }, “description”:{ “urls”: [] } }, “protected”: false, “フォロワー_count”: 517232, “friends_count”: 2032, “リストに登録された_count”: 1722, “作成日時_at”:“Sat Dec 14 04:35:55 +0000 2013”, “favourites_count”: 2134, “utc_offset”: null, “タイムゾーン_タイムゾーン”: null, “geo_有効”: true, “認証済み”: true, “ステータス数_count”: 3677, “lang”: null, “コントリビューター_有効”: false, “です_translator”: false, “です_translation_有効”: false, “profile_背景_color”:“FFFFFF”, “profile_背景_image_url”:“http://abs.twimg.com/images/themes/theme1/bg.png”, “profile_背景_画像_url_https”:“https://abs.twimg.com/images/themes/theme1/bg.png”, “profile_背景_タイル”: false, “profile_image_url”:“http://pbs.twimg.com/profile_images/1354494203451961345/d8HkZl6p_normal.jpg”, “profile_image_url_https”:“https://pbs.twimg.com/profile_images/1354494203451961345/d8HkZl6p_normal.jpg”, “profile_banner_url”:“https://pbs.twimg.com/profile_banners/2244994945/1611792896”, “profile_リンク_color”:“0084B4”, “profile_サイドバー_ボーダー_color”:“FFFFFF”, “profile_サイドバー_fill_color”:“DDEEF6”, “profile_text_color”:“333333”, “profile_使用_背景_image”: false, “has_extended_profile”: true, “default_profile”: false, “default_profile_画像”: false, “following”: null, “follow_リクエスト_送信済み”: null, “notifications”: null, “translator_type”:“regular” } | { “data”: [{ “author_id”: “2244994945”, “id”: “1362876655061073928”, “text”: “私たちのリビングルームから皆さんのリビングルームへ 🐱💻🛋️ 新しい #TwitterAPI を使い始めるのに役立つ、デベロッパーアドボケートによるエキサイティングな Twitch 配信やオンラインイベントをいくつか予定しています。詳しくはスケジュールをご確認のうえ、もっと見たいという方はぜひお知らせください!\n👇\nhttps://t.co/cixDY9qkvH” }], “includes”: { “users”: [{ “public_metrics”: { “followers_count”: 517233, “following_count”: 2034, “tweet_count”: 3677, “listed_count”: 1727 }, “username”: “TwitterDev”, “entities”: { “url”: { “urls”: [{ “start”: 0, “end”: 23, “url”: “https://t.co/3ZX3TNiZCY”, “expanded_url”: “https://developer.x.com/en/community”, “display_url”: “developer.x.com/en/community” }] }, “description”: { “hashtags”: [{ “start”: 17, “end”: 28, “tag”: “TwitterDev” }, { “start”: 105, “end”: 116, “tag”: “TwitterAPI” } ] } }, “description”: “#TwitterDev チームの声であり、#TwitterAPI に関する最新情報やニュース、イベントを公式にお届けする情報源です。”, “name”: “Twitter Dev”, “verified”: true, “location”: “127.0.0.1”, “id”: “2244994945”, “protected”: false, “url”: “https://t.co/3ZX3TNiZCY”, “profile_image_url”: “https://pbs.twimg.com/profile_images/1354494203451961345/d8HkZl6p_normal.jpg”, “created_at”: “2013-12-14T04:35:55.000Z” }] } } |
Entities および expanded entities オブジェクト
| Twitter 1.1 フォーマット | Twitter v2 フォーマット | 必要な v2 パラメータ | v2 における型 |
| entities | data.entities | tweet.fields=entities | object |
| entities.hashtags | data.entities.hashtags | tweet.fields=entities | オブジェクトの配列 |
| entities.hashtags.indices[0] | data.entities.hashtags.start | tweet.fields=entities | number |
| entities.hashtags.indices[1] | data.entities.hashtags.end | tweet.fields=entities | number |
| entities.hashtags.text | data.entities.hashtags.tag | tweet.fields=entities | string |
| entities.urls | data.entities.urls | tweet.fields=entities | オブジェクトの配列 |
| entities.urls.indices[0] | data.entities.urls.start | tweet.fields=entities | number |
| entities.urls.indices[1] | data.entities.urls.end | tweet.fields=entities | number |
| entities.urls.url | data.entities.urls.url | tweet.fields=entities | string |
| entities.user_mentions | data.entities.mentions | tweet.fields=entities | オブジェクトの配列 |
| entities.user_mentions.indicies[0] | data.entities.mentions.start | tweet.fields=entities | number |
| entities.user_mentions.indicies[1] | data.entities.mentions.end | tweet.fields=entities | number |
| entities.user_mentions.screen_name | data.entities.mentions.username | tweet.fields=entities | string |
| entities.symbols | data.entities.cashtags | tweet.fields=entities | オブジェクトの配列 |
| entities.symbols.indices[0] | data.entities.cashtags.start | tweet.fields=entities | number |
| entities.symbols.indices[1] | data.entities.cashtags.end | tweet.fields=entities | number |
| entities.symbols.text | data.entities.cashtags.tag | tweet.fields=entities | string |
| entities.media | includes.media | expansions=attachments.media_keys | オブジェクトの配列 |
| entities.media.id_str | includes.media.media_key | expansions=attachments.media_keys | string |
| entities.media.type | includes.media.media.type | expansions=attachments.media_keys | string |
| entities.media.media_url | N/A:includes.media.url を使用してください | string | |
| entities.media.media_url_https | includes.media.url | expansions=attachments.media_keys&media.fields=url | string |
| entities.media.url | |||
| entities.media.display_url | |||
| entities.media.expanded_url | |||
| entities.media.media_url_https | includes.media.preview_image_url | expansions=attachments.media_keys&media.fields=preview_image_url | string |
| extended_entities | data.attachments | tweet_fields=attachments | object |
| extended_entities | data.attachments.media_keys | tweet.fields=attachments | オブジェクトの配列 |
| extended_entities.media | includes.media | expansions=attachments.media_keys | オブジェクトの配列 |
| extended_entities.media.id_str | includes.media.media_key | expansions=attachments.media_keys | string |
| extended_entities.media.type | includes.media.media.type | expansions=attachments.media_keys | string |
| extended_entities.media.sizes.thumb.w | 利用不可 | ||
| extended_entities.media.sizes.thumb.h | 利用不可 | ||
| extended_entities.media.sizes.thumb.resize | 利用不可 | ||
| extended_entities.media.sizes.large.w | includes.media.height | expansions=attachments.media_keys&media.fields=height | |
| extended_entities.media.sizes.large.h | includes.media.width | expansions=attachments.media_keys&media.fields=width | |
| extended_entities.media.sizes.large.resize | 利用不可 | ||
| extended_entities.media.sizes.small.w | 利用不可 | ||
| extended_entities.media.sizes.small.h | 利用不可 | ||
| extended_entities.media.sizes.small.resize | 利用不可 | ||
| extended_entities.media.sizes.medium.w | 利用不可 | ||
| extended_entities.media.sizes.medium.h | 利用不可 | ||
| extended_entities.media.sizes.medium.resize | 利用不可 | ||
| extended_entities.media.media_url_https | includes.media.url | expansions=attachments.media_keys&media.fields=url | string |
| extended_entities.media.media_url_https | includes.media.preview_image_url | expansions=attachments.media_keys&media.fields=preview_image_url | string |
| extended_entities.media.video_info.duration_millis | includes.media.duration_ms | expansions=attachments.media_keys&media.fields=duration_ms | number |
| v1.1 における entities および extended_entities (動画あり) | v2 の entities、attachments、includes https://api.x.com/2/tweets?ids=1370161532013735937&expansions=attachments.media_keys,entities.mentions.username&tweet.fields=entities&user.fields=created_at,description,entities,location,name,profile_image_url,protected,public_metrics,url,username,verified,withheld&media.fields=duration_ms,height,media_key,preview_image_url,public_metrics,type,url,width |
| ”entities”:{ “hashtags”: [{ “text”:“test”, “indices”: [ 8, 13 ] }], “symbols”: [], “ユーザー_mentions”: [{ “screen_name”:“TwitterDev”, “name”:“Twitter Dev”, “id”: 2244994945, “id_str”:“2244994945”, “indices”: [ 31, 42 ] }], “urls”: [{ “url”:“https://t.co/XVLZ3uwikc”, “展開_url”:“https://developer.x.com/en”, “display_url”:“developer.x.com/en”, “indices”: [ 91, 114 ] }], “media”: [{ “id”: 1370161464028196868, “id_str”:“1370161464028196868”, “indices”: [ 115, 138 ], “media_url”:“http://pbs.twimg.com/ext_tw_video_thumb/1370161464028196868/pu/img/cGLCoXBHVktkwlC5.jpg”, “media_url_https”:“https://pbs.twimg.com/ext_tw_video_thumb/1370161464028196868/pu/img/cGLCoXBHVktkwlC5.jpg”, “url”:“https://t.co/dz4oByygWA”, “display_url”:“pic.x.com/dz4oByygWA”, “展開_url”:“https://twitter.com/furiouscamper/status/1370161532013735937/video/1”, “type”:“photo”, “sizes”:{ “thumb”:{ “w”: 150, “h”: 150, “resize”:“crop” }, “small”:{ “w”: 383, “h”: 680, “resize”:“fit” }, “large”:{ “w”: 720, “h”: 1280, “resize”:“fit” }, “medium”:{ “w”: 675, “h”: 1200, “resize”:“fit” } } }] }, “extended_entities”:{ “media”: [{ “id”: 1370161464028196868, “id_str”:“1370161464028196868”, “indices”: [ 115, 138 ], “media_url”:“http://pbs.twimg.com/ext_tw_video_thumb/1370161464028196868/pu/img/cGLCoXBHVktkwlC5.jpg”, “media_url_https”:“https://pbs.twimg.com/ext_tw_video_thumb/1370161464028196868/pu/img/cGLCoXBHVktkwlC5.jpg”, “url”:“https://t.co/dz4oByygWA”, “display_url”:“pic.x.com/dz4oByygWA”, “展開_url”:“https://twitter.com/furiouscamper/status/1370161532013735937/video/1”, “type”:“video”, “sizes”:{ “thumb”:{ “w”: 150, “h”: 150, “resize”:“crop” }, “small”:{ “w”: 383, “h”: 680, “resize”:“fit” }, “large”:{ “w”: 720, “h”: 1280, “resize”:“fit” }, “medium”:{ “w”: 675, “h”: 1200, “resize”:“fit” } }, “video_info”:{ “アスペクト比_アスペクト比”: [ 9, 16 ], “duration_ミリ秒”: 5140, “variants”: [{ “ビットレート”: 950000, “content_type”:“video/mp4”, “url”:“https://video.twimg.com/ext_tw_video/1370161464028196868/pu/vid/480x852/rAuFVMEqs0MeP4P4.mp4?tag=12” }, { “ビットレート”: 2176000, “content_type”:“video/mp4”, “url”:“https://video.twimg.com/ext_tw_video/1370161464028196868/pu/vid/720x1280/ZxVL5qYO-DNVuSyq.mp4?tag=12” }, { “content_type”:“application/x-mpegURL”, “url”:“https://video.twimg.com/ext_tw_video/1370161464028196868/pu/pl/EGVpuZpo-wYxTNCq.m3u8?tag=12” }, { “ビットレート”: 632000, “content_type”:“video/mp4”, “url”:“https://video.twimg.com/ext_tw_video/1370161464028196868/pu/vid/320x568/M7VtocAwKPFdkqzF.mp4?tag=12” } ] }, “追加の_media_info”:{ “収益化可能”: false } }] } | { “data”: [{ “entities”:{ “hashtags”: [{ “start”: 8, “end”: 13, “タグ”:“test” }], “mentions”: [{ “start”: 31, “end”: 42, “username”:“TwitterDev” }], “urls”: [{ “start”: 91, “end”: 114, “url”:“https://t.co/XVLZ3uwikc”, “展開_url”:“https://developer.x.com/en”, “display_url”:“developer.x.com/ja”, “status”: 200, “title”:“ユースケース、チュートリアル、&ドキュメント”, “説明”:“投稿&ツイートを分析し、広告を最適化し、&Twitter API、Twitter Ads APIを使用して独自の顧客体験を創出し、&Twitter for Websites。‘s start building.”, “unwound_url”:“https://developer.x.com/en” }, { “start”: 115, “end”: 138, “url”:“https://t.co/dz4oByygWA”, “展開_url”:“https://x.com/furiouscamper/status/1370161532013735937/video/1”, “display_url”:“pic.x.com/dz4oByygWA” } ] }, “id”:“1370161532013735937”, “text”:“動画と@TwitterDevメンションを含む別の#test。新しいフォーマットの移行ドキュメントが楽しみです! https://t.co/XVLZ3uwikc https://t.co/dz4oByygWA”, “添付ファイル”:{ “media_keys”: [ “7_1370161464028196868” ] } }], “includes”:{ “media”: [{ “type”:“video”, “height”: 1280, “public_メトリック”:{ “閲覧_件数”: 37 }, “width”: 720, “media_key”:“7_1370161464028196868”, “duration_ms”: 5140, “プレビュー_image_url”:“https://pbs.twimg.com/ext_tw_video_thumb/1370161464028196868/pu/img/cGLCoXBHVktkwlC5.jpg” }], “users”: [{ “public_メトリック”:{ “フォロワー数_count”: 517233, “following_count”: 2034, “ツイート_件数”: 3677, “リスト登録数_count”: 1727 }, “作成日時_at”:“2013-12-14T04:35:55.000Z”, “profile_画像_url”:“https://pbs.twimg.com/profile_images/1354494203451961345/d8HkZl6p_normal.jpg”, “説明”:“#TwitterDevチームの声であり、#TwitterAPIに関するアップデート、ニュース、イベントの公式情報源です。”, “認証済み”: true, “id”:“2244994945”, “username”:“TwitterDev”, “protected”: false, “entities”:{ “url”:{ “urls”: [{ “start”: 0, “end”: 23, “url”:“https://t.co/3ZX3TNiZCY”, “展開_url”:“https://developer.x.com/en/community”, “display_url”:“developer.x.com/ja/community” }] }, “description”:{ “hashtags”: [{ “start”: 17, “end”: 28, “tag”:“TwitterDev” }, { “start”: 105, “end”: 116, “tag”:“TwitterAPI” } ] } }, “url”:“https://t.co/3ZX3TNiZCY”, “name”:“Twitter Dev”, “location”:“127.0.0.1” }] } } |
Place オブジェクト
| Twitter 1.1 形式 | Twitter v2 形式 | 必須の v2 パラメータ |
| place | data.geo.place_id | tweet.fields=geo |
| place.id | includes.places.id | expansions=geo.place_id |
| place.id.place_type | includes.places.place_type | expansions=geo.place_id&place.fields=place_type |
| place.id.name | includes.places.name | expansions=geo.place_id&place.fields=name |
| place.id.full_name | includes.places.full_name | expansions=geo.place_id |
| place.id.country_code | includes.places.country_code | expansions=geo.place_id&place.fields=country_code |
| place.id.country | includes.places.country | expansions=geo.place_id&place.fields=country |
| place.id.contained_within | includes.places.contained_within | expansions=geo.place_id&place.fields=contained_within |
| place.id.bounding_box.type | includes.places.geo.type | expansions=geo.place_id&place.fields=place_type |
| place.id.bounding_box.coordinates | includes.places.geo.bbox | expansions=geo.place_id&place.fields=geo |
| place.id.attributes | includes.places.properties | expansions=geo.place_id&place.fields=geo |
| v1.1 の Place オブジェクト | v2 の Place オブジェクト https://api.x.com/2/tweets?ids=1370161532013735937&expansions=geo.place_id&tweet.fields=geo&place.fields=contained_within,country,country_code,full_name,geo,id,name,place_type |
| ”place”: { “id”: “f7eb2fa2fea288b1”, “url”: “https://api.x.com/1.1/geo/id/f7eb2fa2fea288b1.json”, “place_type”: “city”, “name”: “Lakewood”, “full_name”: “Lakewood, CO”, “country_code”: “US”, “country”: “United States”, “contained_within”: [], “bounding_box”: { “type”: “Polygon”, “coordinates”: [ [ [ -105.193475, 39.60973 ], [ -105.053164, 39.60973 ], [ -105.053164, 39.761974 ], [ -105.193475, 39.761974 ] ] ] }, “attributes”: } | { “data”: [{ “id”: “1370161532013735937”, “text”: “Another #test with a video and @TwitterDev mention. Excited for new format migration docs! https://t.co/XVLZ3uwikc https://t.co/dz4oByygWA”, “geo”: { “place_id”: “f7eb2fa2fea288b1” } }], “includes”: { “places”: [{ “name”: “Lakewood”, “place_type”: “city”, “full_name”: “Lakewood, CO”, “id”: “f7eb2fa2fea288b1”, “geo”: { “type”: “Feature”, “bbox”: [ -105.193475, 39.60973, -105.053164, 39.761974 ], “properties”: }, “country_code”: “US”, “country”: “United States” }] } |
- フィールドについてさらに学ぶ
- expansionsについてさらに学ぶ
- フィールドと expansions の使い方を学ぶ
Native Enriched データ形式から v2 への移行
- JSON のルートレベルでは、Native Enriched 形式は results 配列でツイートオブジェクトを返しますが、X API v2 は data 配列を返します。
- ツイートオブジェクト内の favorites とユーザーオブジェクト内の favourites の両方を使用する代わりに、X API v2 では like という用語を使用します。
- X では、値を持たない JSON 値 (たとえば null) はペイロードに書き込まないという規約を採用しています。ツイートおよびユーザーの属性は、null 以外の値を持つ場合にのみ含まれます。
- v2 のすべての id フィールドは文字列形式になります
- conversation_id
- reply_settings
- メディアの alt_text
- context と entities を含む 2 つの新しいアノテーションフィールド
- 複数の新しいメトリクスフィールド
- 複数の新しい投票フィールド
- contributors
- 特定の entities.media および extended_entities.media フィールド
- filter_level
- timestamp_ms
- truncated
Native Enriched と v2 のペイロード構造の比較
| Native Enriched の構造 | v2 の構造 | |
|---|---|---|
| デフォルト | { “user”: , “place”: , “entities”: { “hashtags”: [], “urls”: [], “user_mentions”: [], “symbols”: [], “annotations”: [], “media”: [] }, “extended_entities”: , “matching_rules”: [] } | { “data”: [{ “id”, “text”, “edit_history_tweet_ids” }] } |
| フィールドと expansions パラメータを指定した場合 | { “data”: [{ “entities”: { “hashtags”: [], “cashtags”: [], “mentions”: [], “urls”: [], }, “attachments”: { “media_keys”: [], “poll_ids”: [] } }], “includes”: [ “tweets”: [ “users”: [ “media”: [ “places”: [ “polls”: [ ], “matching_rules”: [] } |
Tweet オブジェクト
| Native Enriched データ形式 | Twitter v2 フォーマット | 必須となる v2 パラメーター | v2 の type |
| created_at | data.created_at | tweet.fields=created_at | 文字列 |
| id | 該当なし (id を参照) | ||
| id_str | data.id | デフォルト | 文字列 |
| text | data.text | デフォルト | 文字列 |
| edit_history | data.edit_history_tweet_ids | デフォルト | 配列 |
| edit_controls | data.edit_controls | tweet.fields=edit_controls | オブジェクト |
| editable | data.edit_controls.is_edit_eligible | tweet.fields=edit_controls | ブール値 |
| display_text_range | 該当なし (text には常に完全なテキストが含まれます) | ||
| source | data.source | tweet.fields=source | 文字列 |
| truncated | 該当なし (text には常に完全なテキストが含まれます) | ||
| 利用不可 | data.conversation_id | tweet.fields=conversation_id | 文字列 |
| 利用不可 | data.reply_settings | tweet.fields=reply_settings | 文字列 |
| in_reply_to_status_id | 該当フィールドなし - referenced_tweets.id を参照 | ||
| in_reply_to_status_id_str | data.referenced_tweets.id (if type=replied_to) | expansions=referenced_tweets.id | 文字列 |
| in_reply_to_user_id | 該当フィールドなし - in_reply_to_user_id_str を参照 | ||
| in_reply_to_user_id_str | data.in_reply_to_user_id | tweet.fields=in_reply_to_user_id | 文字列 |
| in_reply_to_screen_name | includes.users..username | tweet.fields=in_reply_to_user_id&expansions=entities.mentions.username | 文字列 |
| user | includes.users | expansions=author_id | オブジェクト |
| user.id_str | data.author_id | tweet.fields=author_id | 文字列 |
| geo | data.geo.place_id | tweet.fields=geo | |
| coordinates | data.geo.place_id | tweet.fields=geo | |
| place | data.geo.place_id | tweet.fields=geo | |
| is_quoted_status | data.referenced_tweets.id (if type=quoted) | tweet.fields=referenced_tweets | 文字列 |
| extended_tweet.full_text | 該当なし (テキスト全体が本文です) | ||
| 利用不可 | data.public_metrics | tweet.fields=public_metrics | オブジェクト |
| quote_count | data.public_metrics.quote_count | tweet.fields=public_metrics | Int |
| reply_count | data.public_metrics.reply_count | tweet.fields=public_metrics | Int |
| retweet_count | data.public_metrics.retweet_count | tweet.fields=public_metrics | Int |
| favorite_count | data.public_metrics.like_count | tweet.fields=public_metrics | Int |
| 利用不可 | data.non_public_metrics | tweet.fields=non_public_metrics | オブジェクト |
| 利用不可 | data.non_public_metrics.impression_count | tweet.fields=non_public_metrics | Int |
| 利用不可 | data.non_public_metrics.url_link_count | tweet.fields=non_public_metrics | Int |
| 利用不可 | data.non_public_metrics.user_profile_count | tweet.fields=non_public_metrics | Int |
| 利用不可 | data.organic_metrics | tweet.fields=organic_metrics | オブジェクト |
| 利用不可 | data.organic_metrics.like_count | tweet.fields=organic_metrics | 整数 |
| 利用不可 | data.organic_metrics.retweet_count | tweet.fields=organic_metrics | 整数 |
| 利用不可 | data.organic_metrics.reply_count | tweet.fields=organic_metrics | 整数 |
| 利用不可 | data.organic_metrics.impression_count | tweet.fields=organic_metrics | 整数 |
| 利用不可 | data.organic_metrics.url_link_count | tweet.fields=organic_metrics | 整数 |
| 利用不可 | data.organic_metrics.user_profile_count | tweet.fields=organic_metrics | 整数 |
| 利用不可 | data.promoted_metrics | tweet.fields=promoted_metrics | オブジェクト |
| 利用不可 | data.promoted_metrics.like_count | tweet.fields=promoted_metrics | 整数 |
| 利用不可 | data.promoted_metrics.retweet_count | tweet.fields=promoted_metrics | 整数 |
| 利用不可 | data.promoted_metrics.reply_count | tweet.fields=promoted_metrics | Int |
| なし | data.promoted_metrics.impression_count | tweet.fields=promoted_metrics | Int |
| なし | data.promoted_metrics.url_link_count | tweet.fields=promoted_metrics | Int |
| なし | data.promoted_metrics.user_profile_count | tweet.fields=promoted_metrics | Int |
| contributors | なし | なし | |
| entities | data.entities | tweet.fields=entities | オブジェクト |
| entities.user_mentions | data.entities.mentions | tweet.fields=entities | オブジェクトの配列 |
| entities.symbols | data.entities.cashtags | tweet.fields=entities | オブジェクトの配列 |
| entities.hashtags | data.entities.hashtags | tweet.fields=entities | オブジェクトの配列 |
| entities.urls | data.entities.urls | tweet.fields=entities | オブジェクトの配列 |
| entities.media | includes.media | expansions=attachments.media_keys | オブジェクトの配列 |
| entities.annotations | tweet.fields=entities,context_annotations | オブジェクト | |
| entities.annotations.context | data.context_annotations | tweet.fields=entities,context_annotations | オブジェクトの配列 |
| 該当なし | data.context_annotations.domain | tweet.fields=context_annotations | オブジェクト |
| entities.annotations.context.context_domain_id_str | data.context_annotations.domain.id | tweet.fields=context_annotations | 文字列 |
| entities.annotations.context.context_domain_id | 利用不可 | 利用不可 - 文字列形式については data.context_annotations.domain.id を参照してください | |
| entities.annotations.context.context_domain_name | data.context_annotations.domain.name | tweet.fields=context_annotations | 文字列 |
| entities.annotations.context.context_domain_description | data.context_annotations.domain.description | tweet.fields=context_annotations | 文字列 |
| 該当なし | data.context_annotations.entity | tweet.fields=context_annotations | オブジェクト |
| entities.annotations.context.context_entity_id_str | data.context_annotations.entity.id | tweet.fields=context_annotations | 文字列 |
| entities.annotations.context.context_entity_id | 利用不可 | 利用不可 - 文字列形式については data.context_annotations.entity.id を参照してください | |
| entities.annotations.context.context_entity_name | data.context_annotations.entity.name | tweet.fields=context_annotations | 文字列 |
| entities.annotations.context.context_entity_description | data.context_annotations.entity.description | tweet.fields=context_annotations | 文字列 |
| entities.annotations.entity | data.entities.annotations | tweet.fields=entities,context_annotations | オブジェクトの配列 |
| extended_entities | data.attachments | tweet.fields=attachments | オブジェクト |
| favorited | 利用不可 | 利用不可 | |
| retweeted | 利用不可 | 利用不可 | |
| retweeted_status | |||
| possibly_sensitive | data.possibly_sensitive | tweet.fields=possibly_sensitive | 真偽値 |
| lang | data.lang | tweet.fields=lang | 文字列 |
| filter_level | 利用不可 | 利用不可 | |
| scopes | 利用不可 | 利用不可 | |
| timestamp_ms | 利用不可 | 利用不可 | |
| withheld | data.withheld | tweet.fields=withheld | オブジェクトの配列 |
| matching_rules | matching_rules | オブジェクトの配列 | |
| matching_rules.id | 使用不可 | 使用不可 | |
| matching_rules.id_str | matching_rules.id | フィルタ済みストリームのデフォルト | 文字列 |
| matching_rules.tag | matching_rules.tag | フィルタ済みストリームのデフォルト | 文字列 |
User オブジェクト
| Native Enriched データ形式 | Twitter v2 形式 | v2 で必須のパラメータ | v2 の type |
| user | includes.users | expansions=author_id | オブジェクトの配列 |
| user.id | 利用不可 | 該当なし (includes.users.id を参照) | 文字列 |
| user.id_str | includes.users.id | expansions=author_id | 文字列 |
| user.name | includes.users.name | expansions=author_id | 文字列 |
| user.screen_name | includes.user.username | expansions=author_id | 文字列 |
| user.location | includes.users.location | expansions=author_id&user.fields=location | オブジェクト |
| user.description | includes.users.description | expansions=author_id&user.fields=description | 文字列 |
| 利用不可 | includes.users.url | expansions=author_id&user.fields=url | 文字列 |
| user.followers_count | includes.users.public_metrics.followers_count | expansions=author_id&user.fields=public_metrics | 整数 |
| user.friends_count | includes.users.public_metrics.following_count | expansions=author_id&user.fields=public_metrics | 整数 |
| user.listed_count | includes.users.public_metrics.listed_count | expansions=author_id&user.fields=public_metrics | Int |
| user.created_at | includes.users.created_at | expansions=author_id&user.fields=created_at | String |
| user.favourites_count | まだ利用できません | ||
| user.verified | includes.users.verified | expansions=author_id&user.fields=verified | Boolean |
| 利用できません | includes.users.pinned_tweet_id | expansions=author_id&user.fields=pinned_tweet_id | String |
| user.statuses_count | includes.users.public_metrics.tweet_count | expansions=author_id&user.fields=public_metrics | Int |
| user.profile_image_url_https | includes.users.profile_image_url | expansions=author_id&user.fields=profile_image_url | String |
| user.translator_type | 利用できません | 利用できません | |
| user.utc_offset | 利用できません | 利用できません | |
| user.time_zone | 利用できません | 利用できません | |
| user.geo_enabled | 利用できません | 利用できません | |
| user.lang | 利用できません | 利用できません (ツイートの言語から推定) | |
| user.contributors_enabled | 利用できません | 利用できません | |
| user.is_translator | 利用できません | 利用できません | |
| user.profile_background_color | 利用できません | 利用できません | |
| user.profile_background_image_url | 利用できません | 利用できません | |
| user.profile_background_image_url_https | 利用できません | 利用できません | |
| user.profile_background_title | 利用できません | 利用できません | |
| user.profile_sidebar_border_color | 利用できません | 利用できません | |
| user.profile_sidebar_fill_color | 利用できません | 利用できません | |
| user.profile_text_color | 利用できません | 利用できません | |
| user.profile_user_background_image | 利用できません | 利用できません | |
| user.profile_image_url | includes.user.profile_image_url を参照 | ||
| user.default_profile | 利用できません | 利用できません | |
| user.default_profile_image | 利用できません | 利用できません | |
| user.following | 利用不可 | 利用不可 | |
| user.follow_request_sent | 利用不可 | 利用不可 | |
| user.notifications | 利用不可 | 利用不可 | |
| user.withheld_in_countries | includes.users.withheld | expansions=author_id&user.fields=withheld | オブジェクト |
| user.protected | includes.users.protected | expansions=author_id&user.fields=protected | ブール値 |
| 利用不可 | includes.users.entities | expansions=author_id&user.fields=entities | オブジェクト |
| 利用不可 | includes.users.entities.url | expansions=author_id&user.fields=entities | オブジェクト |
| 利用不可 | includes.users.entities.url.urls | expansions=author_id&user.fields=entities | オブジェクトの配列 |
| 利用不可 | includes.users.entities.url.urls.start | expansions=author_id&user.fields=entities | 整数 |
| 利用不可 | includes.users.entities.url.urls.end | expansions=author_id&user.fields=entities | 整数 |
| 利用不可 | includes.users.entities.url.urls.url | expansions=author_id&user.fields=entities | 文字列 |
| user.url | includes.users.entities.url.urls.expanded_url | expansions=author_id&user.fields=entities | 文字列 |
| 該当なし | includes.users.entities.url.urls.display_url | expansions=author_id&user.fields=entities | 文字列 |
| 該当なし | includes.users.entities.descriptions | expansions=author_id&user.fields=entities | オブジェクト |
| 該当なし | includes.users.entities.descriptions.hashtags | expansions=author_id&user.fields=entities | オブジェクトの配列 |
| 該当なし | includes.users.entities.descriptions.hashtags.start | expansions=author_id&user.fields=entities | 整数 |
| 該当なし | includes.users.entities.descriptions.hashtags.end | expansions=author_id&user.fields=entities | 整数 |
| user.description 内に含まれる | includes.users.entities.descriptions.hashtags.tag | expansions=author_id&user.fields=entities | 文字列 |
| 該当なし | includes.users.entities.descriptions.mentions | expansions=author_id&user.fields=entities | オブジェクトの配列 |
| 該当なし | includes.users.entities.descriptions.mentions.start | expansions=author_id&user.fields=entities | 整数 |
| 該当なし | includes.users.entities.descriptions.mentions.end | expansions=author_id&user.fields=entities | 整数 |
| user.description に含まれる値 | includes.users.entities.descriptions.mentions.username | expansions=author_id&user.fields=entities | 文字列 |
| 利用不可 | includes.users.entities.descriptions.cashtags | expansions=author_id&user.fields=entities | オブジェクトの配列 |
| 利用不可 | includes.users.entities.descriptions.cashtags.start | expansions=author_id&user.fields=entities | 整数 |
| 利用不可 | includes.users.entities.descriptions.cashtags.end | expansions=author_id&user.fields=entities | 整数 |
| user.description に含まれる値 | includes.users.entities.descriptions.cashtags.tag | expansions=author_id&user.fields=entities | 文字列 |
Entities オブジェクトと expanded_entities オブジェクト
| Native Enriched 形式 | Twitter v2 フォーマット | v2 で必須のパラメーター | v2 における type |
| entities | data.entities | tweet.fields=entities | オブジェクト |
| entities.hashtags | data.entities.hashtags | tweet.fields=entities | オブジェクトの配列 |
| entities.hashtags.indices[0] | data.entities.hashtags.start | tweet.fields=entities | 整数 |
| entities.hashtags.indices[1] | data.entities.hashtags.end | tweet.fields=entities | 整数 |
| entities.hashtags.text | data.entities.hashtags.tag | tweet.fields=entities | 文字列 |
| entities.urls | data.entities.urls | tweet.fields=entities | オブジェクトの配列 |
| entities.urls.indices[0] | data.entities.urls.start | tweet.fields=entities | 整数 |
| entities.urls.indices[1] | data.entities.urls.end | tweet.fields=entities | 整数 |
| entities.urls.url | data.entities.urls.url | tweet.fields=entities | 文字列 |
| entities.urls.expanded_url | data.entities.urls.expanded_url | tweet.fields=entities | 文字列 |
| entities.urls.display_url | data.entities.urls.display_url | tweet.fields=entities | String |
| entities.urls.unwound.url | data.entities.urls.unwound_url | tweet.fields=entities | String |
| entities.urls.unwound.status | data.entities.urls.status | tweet.fields=entities | String |
| entities.urls.unwound.title | data.entities.urls.title | tweet.fields=entities | String |
| entities.urls.unwound.description | data.entities.urls.description | tweet.fields=entities | String |
| 該当なし | data.entities.urls.images | tweet.fields=entities | オブジェクトの配列 |
| 該当なし | data.entities.urls.images.url | tweet.fields=entities | String |
| 該当なし | data.entities.urls.images.width | tweet.fields=entities | Int |
| 該当なし | data.entities.urls.images.height | tweet.fields=entities | Int |
| entities.user_mentions | data.entities.mentions | tweet.fields=entities | オブジェクトの配列 |
| entities.user_mentions.indicies[0] | data.entities.mentions.start | tweet.fields=entities | 整数 |
| entities.user_mentions.indicies[1] | data.entities.mentions.end | tweet.fields=entities | 整数 |
| entities.user_mentions.screen_name | data.entities.mentions.username | tweet.fields=entities | 文字列 |
| entities.symbols | data.entities.cashtags | tweet.fields=entities | オブジェクトの配列 |
| entities.symbols.indices[0] | data.entities.cashtags.start | tweet.fields=entities | 整数 |
| entities.symbols.indices[1] | data.entities.cashtags.end | tweet.fields=entities | 整数 |
| entities.symbols.text | data.entities.cashtags.tag | tweet.fields=entities | 文字列 |
| entities.media OR extended_entities.media | includes.media | expansions=attachments.media_keys | オブジェクトの配列 |
| entities.media.id_str OR extended_entities.media.id_str | includes.media.media_key | expansions=attachments.media_keys | 文字列 |
| entities.media.id OR extended_entities.media.id | 利用できません (id は文字列です) | ||
| entities.media.type OR extended_entities.media.type | includes.media.media.type | expansions=attachments.media_keys | 文字列 |
| entities.media.indices OR extended_entities.media.indices | 利用不可 | 利用不可 | |
| 利用不可 | includes.media.alt_text | expansions=attachments.media_keys&media.fields=alt_text | 文字列 |
| entities.media.additional_media_info OR extended_entities.media.additional_media_info | 利用不可 | 利用不可 | |
| entities.media.additional_media_info.monetizable OR extended_entities.media.additional_media_info.monetizable | 利用不可 | 利用不可 | |
| entities.media.media_url OR extended_entities.media.media_url | 該当なし (includes.media.url を参照) | 文字列 | |
| entities.media.media_url_https OR extended_entities.media.media_url_https | includes.media.url | expansions=attachments.media_keys&media.fields=url | 文字列 |
| entities.media.url OR extended_entities.media.url | |||
| entities.media.display_url OR extended_entities.media.expanded_url | |||
| entities.media.expanded_url | |||
| entities.media.media_url_https | includes.media.preview_image_url | expansions=attachments.media_keys&media.fields=preview_image_url | 文字列 |
| extended_entities | data.attachments | tweet_fields=attachments | オブジェクト |
| extended_entities | data.attachments.media_keys | tweet.fields=attachments | オブジェクトの配列 |
| 利用不可 | data.attachments.poll_ids | tweet.fields=attachments | オブジェクトの配列 |
| extended_entities.media.sizes.thumb.w | 利用不可 | ||
| extended_entities.media.sizes.thumb.h | 利用不可 | ||
| extended_entities.media.sizes.thumb.resize | 利用不可 | ||
| extended_entities.media.sizes.large.w | includes.media.height | expansions=attachments.media_keys&media.fields=height | |
| extended_entities.media.sizes.large.h | includes.media.width | expansions=attachments.media_keys&media.fields=width | |
| extended_entities.media.sizes.large.resize | 利用不可 | 利用不可 | |
| extended_entities.media.sizes.small.w | 利用不可 | 利用不可 | |
| extended_entities.media.sizes.small.h | 利用不可 | 利用不可 | |
| extended_entities.media.sizes.small.resize | 利用不可 | 利用不可 | |
| extended_entities.media.sizes.medium.w | 利用不可 | 利用不可 | |
| extended_entities.media.sizes.medium.h | 利用不可 | 利用不可 | |
| extended_entities.media.sizes.medium.resize | 利用不可 | 利用不可 | |
| extended_entities.media.media_url_https | includes.media.preview_image_url | expansions=attachments.media_keys&media.fields=preview_image_url | 文字列 |
| extended_entities.media.video_info.aspect_ratio | 利用不可 | 該当なし | |
| extended_entities.media.variants | 該当なし | 該当なし | |
| extended_entities.media.variants.bitrate | 該当なし | 該当なし | |
| extended_entities.media.variants.content_type | 該当なし | 該当なし | |
| extended_entities.media.variants.url | 該当なし | 該当なし | |
| extended_entities.media.video_info.duration_millis | includes.media.duration_ms | expansions=attachments.media_keys&media.fields=duration_ms | Int |
| 該当なし | includes.media.public_metrics | expansions=attachments.media_keys&media.fields=public_metrics | Object |
| 該当なし | includes.media.public_metrics.view_count | expansions=attachments.media_keys&media.fields=public_metrics | Int |
| 該当なし | includes.media.non_public_metrics | expansions=attachments.media_keys&media.fields=non_public_metrics | Object |
| 該当なし | includes.media.non_public_metrics.playback_0_count | expansions=attachments.media_keys&media.fields=non_public_metrics | Int |
| 該当なし | includes.media.non_public_metrics.playback_25_count | expansions=attachments.media_keys&media.fields=non_public_metrics | Int |
| 該当なし | includes.media.non_public_metrics.playback_50_count | expansions=attachments.media_keys&media.fields=non_public_metrics | Int |
| 該当なし | includes.media.non_public_metrics.playback_75_count | expansions=attachments.media_keys&media.fields=non_public_metrics | Int |
| 該当なし | includes.media.non_public_metrics.playback_100_count | expansions=attachments.media_keys&media.fields=non_public_metrics | Int |
| 該当なし | includes.media.organic_metrics | expansions=attachments.media_keys&media.fields=organic_metrics | Object |
| 該当なし | includes.media.organic_metrics.playback_0_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| 該当なし | includes.media.organic_metrics.playback_25_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| 該当なし | includes.media.organic_metrics.playback_50_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| 該当なし | includes.media.organic_metrics.playback_75_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| 該当なし | includes.media.organic_metrics.playback_100_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| 該当なし | includes.media.organic_metrics.view_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| 該当なし | includes.media.promoted_metric | expansions=attachments.media_keys&media.fields=promoted_metrics | オブジェクト |
| 該当なし | includes.media.promoted_metric.playback_0_count | expansions=attachments.media_keys&media.fields=promoted_metrics | 整数 |
| 該当なし | includes.media.promoted_metric.playback_25_count | expansions=attachments.media_keys&media.fields=promoted_metrics | 整数 |
| 該当なし | includes.media.promoted_metric.playback_50_count | expansions=attachments.media_keys&media.fields=promoted_metrics | 整数 |
| 該当なし | includes.media.promoted_metric.playback_75_count | expansions=attachments.media_keys&media.fields=promoted_metrics | 整数 |
| 該当なし | includes.media.promoted_metric.playback_100_count | expansions=attachments.media_keys&media.fields=promoted_metrics | 整数 |
| 該当なし | includes.media.promoted_metrics.view_count | expansions=attachments.media_keys&media.fields=promoted_metrics | 整数 |
Place オブジェクト
| Native Enriched 形式 | Twitter v2 形式 | 必須の v2 パラメータ | v2 での型 |
| place | includes.places | expansions=geo.place_id | オブジェクトの配列 |
| place.id | includes.places.id | expansions=geo.place_id | 文字列 |
| place.url | 利用不可 | 利用不可 | |
| place.id.place_type | includes.places.place_type | expansions=geo.place_id&place.fields=place_type | 文字列 |
| place.id.name | includes.places.name | expansions=geo.place_id&place.fields=name | 文字列 |
| place.id.full_name | includes.places.full_name | expansions=geo.place_id | 文字列 |
| place.id.country_code | includes.places.country_code | expansions=geo.place_id&place.fields=country_code | 文字列 |
| place.id.country | includes.places.country | expansions=geo.place_id&place.fields=country | 文字列 |
| place.id.contained_within | includes.places.contained_within | expansions=geo.place_id&place.fields=contained_within | 配列 |
| place.id.bounding_box.type | includes.places.geo.type | expansions=geo.place_id&place.fields=place_type | 文字列 |
| place.id.bounding_box.coordinates | includes.places.geo.bbox | expansions=geo.place_id&place.fields=geo | 配列 |
| place.id.attributes | includes.places.properties | expansions=geo.place_id&place.fields=geo | オブジェクト |
投票オブジェクト
| ネイティブ Enriched 形式 | Twitter v2 形式 | 必須の v2 パラメーター | v2 における型 |
| entities.polls | includes.polls | expansions=attachments.poll_ids | オブジェクトの配列 |
| なし | includes.polls.id | expansions=attachments.poll_ids | String |
| entities.poll.options | includes.polls.options | expansions=attachments.poll_ids | オブジェクトの配列 |
| entities.polls.options.position | includes.polls.options.position | expansions=attachments.poll_ids | Int |
| entities.polls.options.text | includes.polls.options.label | expansions=attachments.poll_ids | String |
| なし | includes.polls.options.votes | expansions=attachments.poll_ids | Int |
| なし | includes.polls.voting_status | expansions=attachments.poll_ids&poll.fields=voting_status | String |
| entities.polls.duration_minutes | includes.polls.duration_minutes | expansions=attachments.poll_ids&poll.fields=duration_minutes | Int |
| entities.polls.end_datetime | includes.polls.end_datetime | expansions=attachments.poll_ids&poll.fields=end_datetime | 日付 (ISO 8601) |
Activity Streams データフォーマットから v2 への移行
- JSON のルートレベルでは、Activity Streams フォーマットは results 配列内にツイートオブジェクトを返しますが、X API v2 は data 配列を返します。
- リツイートおよび引用の「activities」を参照する代わりに、X API v2 の JSON ではリツイートおよび引用ツイートを参照します。
- ツイートオブジェクト内の favorites とユーザーオブジェクト内の favourites を両方使用する代わりに、X API v2 では like という用語を使用します。
- Twitter では、値を持たない JSON 値 (たとえば null) はペイロードに書き出さないという規約を採用しています。ツイートおよびユーザー属性は、null 以外の値を持っている場合にのみ含まれます。
- v2 のすべての id フィールドは文字列形式になります。
- conversation_id
- reply_settings
- メディア上の alt_text
- context と entities を含む 2 つの新しい annotations フィールド
- 複数の新しい metrics フィールド
- 複数の新しい polls フィールド
- display_text_range
- generator
- gnip
- link
- objectType
- provider
- twitter_entities.symbols は data.entities.cashtags に置き換え
- 一部の twitter_extended_entities.media および twitter_entities.media フィールド
- twitter_filter_level
- twitterTimeZone
- verb
ツイートオブジェクト
| Activity Streams フォーマット | Twitter v2 形式 | 必須の v2 パラメータ | v2 における type |
| postedTime | data.created_at | tweet.fields=created_at | 日付 (ISO 8601) |
| generator | 利用不可 | 利用不可 | |
| generator.link | 利用不可 | 利用不可 | |
| generator.displayName | data.source | tweet.fields=source | 文字列 |
| twitter_lang | data.lang | tweet.fields=lang | 文字列 |
| 利用不可 | data.conversation_id | tweet.fields=conversation_id | 文字列 |
| 利用不可 | data.reply_settings | tweet.fields=reply_settings | 文字列 |
| 利用不可 | data.possibly_sensitive | tweet.fields=possibly_sensitive | ブール値 |
| 利用不可 | data.withheld | tweet.fields=withheld | オブジェクト |
| objectType | 利用不可 | 利用不可 | |
| verb | 利用不可 | 利用不可 | |
| プロバイダー | 該当なし | 該当なし | |
| provider.objectType | 該当なし | 該当なし | |
| provider.displayName | 該当なし | 該当なし | |
| provider.link | 該当なし | 該当なし | |
| リンク | 該当なし | 該当なし | |
| display_text_range | 該当なし | 該当なし | |
| オブジェクト | 該当なし | 該当なし | |
| object.objectType | 該当なし | 該当なし | |
| object.id | 該当なし | 該当なし | |
| object.summary | data.text | 既定値 | String |
| object.edit_history | data.edit_history_tweet_ids | 既定値 | Array |
| object.edit_controls | data.edit_controls | tweet.fields=edit_controls | Object |
| object.editable | data.edit_controls.is_edit_eligible | tweet.fields=edit_controls | ブール値 |
| object.link | 利用不可 | 利用不可 | |
| object.postedTime | data.created_at | tweet.fields=created_at | 日付 (ISO 8601) |
| actor.id から導出 | data.author_id | tweet.fields=author_id | |
| twitter_filter_level | 利用不可 | 利用不可 | |
| inReplyTo.link 内のユーザー名から導出 | data.in_reply_to_user_id | tweet.fields=in_reply_to_user_id | 文字列 |
| 利用不可 | data.referenced_tweets | tweet.fields=referenced_tweets | オブジェクトの配列 |
| 利用不可 | data.referenced_tweets.type | tweet.fields=referenced_tweets | 文字列 |
| inReplyTo.link から導出 | data.referenced_tweets.id | tweet.fields=referenced_tweets | 文字列 |
| 利用不可 | data.attachments | tweet.fields=attachments | オブジェクト |
| twitter_entities.media.id_str から導出 | data.attachments.media_keys | tweet.fields=attachments | 配列 |
| 該当なし | data.attachments.poll_ids | tweet.fields=attachments | 配列 |
| twitter_entities | data.entities | tweet.fields=entities | オブジェクト |
| 該当なし | data.entities.annotations | tweet.fields=entities | オブジェクトの配列 |
| 該当なし | data.entities.annotations.start | tweet.fields=entities | Int |
| 該当なし | data.entities.annotations.end | tweet.fields=entities | Int |
| 該当なし | data.entities.annotations.probability | tweet.fields=entities | Float |
| 該当なし | data.entities.annotations.type | tweet.fields=entities | String |
| 該当なし | data.entities.annotations.normalized_text | tweet.fields=entities | String |
| twitter_entities.urls | data.entities.urls | tweet.fields=entities | オブジェクトの配列 |
| twitter_entities.urls.indices[0] | data.entities.urls.start | tweet.fields=entities | Int |
| twitter_entities.urls.indices[1] | data.entities.urls.end | tweet.fields=entities | 整数 |
| twitter_entities.urls.url | data.entities.urls.url | tweet.fields=entities | 文字列 |
| twitter_entities.urls.expanded_url | data.entities.urls.expanded_url | tweet.fields=entities | 文字列 |
| twitter_entities.urls.display_url | data.entities.urls.display_url | tweet.fields=entities | 文字列 |
| 使用不可 | data.entities.urls.images | tweet.fields=entities | オブジェクトの配列 |
| 使用不可 | data.entities.urls.images.url | tweet.fields=entities | 文字列 |
| 使用不可 | data.entities.urls.images.width | tweet.fields=entities | 整数 |
| 使用不可 | data.entities.urls.images.height | tweet.fields=entities | 整数 |
| gnip.urls.expanded_status | data.entities.urls.status | tweet.fields=entities | 整数 |
| gnip.urls.expanded_url_title | data.entities.urls.title | tweet.fields=entities | 文字列 |
| gnip.urls.expanded_url_description | data.entities.urls.description | tweet.fields=entities | 文字列 |
| gnip.urls.expanded_url | data.entities.urls.unwound_url | tweet.fields=entities | 文字列 |
| twitter_entities.symbols | data.entities.cashtags | tweet.fields=entities | オブジェクトの配列 |
| twitter_entities.symbols.indices[0] | data.entities.cashtags.start | tweet.fields=entities | 整数 |
| twitter_entities.symbols.indices[1] | data.entities.cashtags.end | tweet.fields=entities | 整数 |
| twitter_entities.symbols.text | data.entities.cashtags.tag | tweet.fields=entities | 文字列 |
| twitter_entities.hashtags | data.entities.hashtags | tweet.fields=entities | オブジェクトの配列 |
| twitter_entities.hashtags.indices[0] | data.entities.hashtags.start | tweet.fields=entities | 整数 |
| twitter_entities.hashtags.indices[1] | data.entities.hashtags.end | tweet.fields=entities | 整数 |
| twitter_entities.hashtags.text | data.entities.hashtags.tag | tweet.fields=entities | 文字列 |
| twitter_entities.user_mentions | data.entities.mentions | tweet.fields=entities | オブジェクトの配列 |
| twitter_entities.user_mentions.indices[0] | data.entities.mentions.start | tweet.fields=entities | 整数 (Int) |
| twitter_entities.user_mentions.indices[1] | data.entities.mentions.end | tweet.fields=entities | 整数 (Int) |
| twitter_entities.user_mentions.screen_name | data.entities.mentions.tag | tweet.fields=entities | 文字列 (String) |
| twitter_entities.user_mentions.id_str | data.entities.mentions.id | tweet.fields=entities | 文字列 (String) |
| twitter_entities.user_mentions.id | 利用不可 | 利用不可 | |
| 利用不可 | data.context_annotations | tweet.fields=context_annotations | オブジェクトの配列 |
| 利用不可 | data.context_annotations.domain | tweet.fields=context_annotations | オブジェクト |
| 利用不可 | data.context_annotations.domain.id | tweet.fields=context_annotations | 文字列 (String) |
| 利用不可 | data.context_annotations.domain.name | tweet.fields=context_annotations | 文字列 (String) |
| 利用不可 | data.context_annotations.domain.description | tweet.fields=context_annotations | String |
| 利用不可 | data.context_annotations.entity | tweet.fields=context_annotations | Object |
| 利用不可 | data.context_annotations.entity.id | tweet.fields=context_annotations | String |
| 利用不可 | data.context_annotations.entity.name | tweet.fields=context_annotations | String |
| 利用不可 | data.context_annotations.entity.description | tweet.fields=context_annotations | String |
| geo | data.geo | tweet.fields=geo | Object |
| location.link から導出される値 | data.geo.place_id | tweet.fields=geo | String |
| 利用不可 | data.public_metrics | tweet.fields=public_metrics | Object |
| favoritesCount | data.public_metrics.like_count | tweet.fields=public_metrics | Int |
| retweetCount | data.public_metrics.retweet_count | tweet.fields=public_metrics | Int |
| 利用不可 | data.public_metrics.quote_count | tweet.fields=public_metrics | Int |
| 該当なし | data.public_metrics.reply_count | tweet.fields=public_metrics | Int |
| 該当なし | data.non_public_metrics | tweet.fields=non_public_metrics | Object |
| 該当なし | data.non_public_metrics.impression_count | tweet.fields=non_public_metrics | Int |
| 該当なし | data.non_public_metrics.url_link_count | tweet.fields=non_public_metrics | Int |
| 該当なし | data.non_public_metrics.user_profile_count | tweet.fields=non_public_metrics | Int |
| 該当なし | data.organic_metrics | tweet.fields=organic_metrics | Object |
| 該当なし | data.organic_metrics.like_count | tweet.fields=organic_metrics | Int |
| 該当なし | data.organic_metrics.retweet_count | tweet.fields=organic_metrics | Int |
| 該当なし | data.organic_metrics.reply_count | tweet.fields=organic_metrics | Int |
| 該当なし | data.organic_metrics.impression_count | tweet.fields=organic_metrics | Int |
| 利用不可 | data.organic_metrics.url_link_count | tweet.fields=organic_metrics | Int |
| 利用不可 | data.organic_metrics.user_profile_count | tweet.fields=organic_metrics | Int |
| 利用不可 | data.promoted_metrics | tweet.fields=promoted_metrics | Object |
| 利用不可 | data.promoted_metrics.like_count | tweet.fields=promoted_metrics | Int |
| 利用不可 | data.promoted_metrics.retweet_count | tweet.fields=promoted_metrics | Int |
| 利用不可 | data.promoted_metrics.reply_count | tweet.fields=promoted_metrics | Int |
| 利用不可 | data.promoted_metrics.impression_count | tweet.fields=promoted_metrics | Int |
| 利用不可 | data.promoted_metrics.url_link_count | tweet.fields=promoted_metrics | Int |
| 利用不可 | data.promoted_metrics.user_profile_count | tweet.fields=promoted_metrics | Int |
| gnip.profileLocations | 利用不可 | 利用不可 | |
| gnip.profileLocations.address | 利用不可 | 利用不可 | |
| gnip.profileLocations.address.country | 利用不可 | 利用不可 | |
| gnip.profileLocations.address.countryCode | 利用不可 | 利用不可 | |
| gnip.profileLocations.displayName | 利用不可 | 利用不可 | |
| gnip.profileLocations.geo | 利用不可 | 利用不可 | |
| gnip.profileLocations.geo.coordinates | 利用不可 | 利用不可 | |
| gnip.profileLocations.geo.type | 利用不可 | 利用不可 | |
| gnip.profileLocations.objectType | 利用不可 | 利用不可 |
User オブジェクト
| Activity Streams データ形式 | Twitter v2 フォーマット | v2で必須のパラメータ | v2 における type |
| actor | includes.users | expansions=author_id | オブジェクトの配列 |
| actor.id から導出される | includes.users.id | expansions=author_id | 文字列 |
| actor.displayName | includes.users.name | expansions=author_id | 文字列 |
| actor.preferredUsername | includes.users.username | expansions=author_id | 文字列 |
| actor.postedTime | includes.users.created_at | expansions=author_id&user.fields=created_at | 日付 (ISO 8601) |
| actor.summary | includes.users.description | expansions=author_id&user.fields=description | 文字列 |
| 使用不可 | includes.users.pinned_tweet_id | expansions=author_id&user.fields=pinned_tweet_id | 文字列 |
| 使用不可 | includes.users.protected | expansions=author_id&user.fields=protected | ブール値 |
| actor.link | 使用不可 | 使用不可 - includes.users.username から生成 | |
| actor.twitterTimeZone | 使用不可 | 使用不可 - Tweet の created_at から推定 | |
| actor.utcOffset | 使用不可 | 利用不可 (ツイートの created_at から推定) | |
| actor.favoritesCount | 利用不可 | 利用不可 | |
| actor.followersCount | includes.users.public_metrics.followers_count | expansions=author_id&user.fields=public_metrics | Int |
| actor.friendsCount | includes.users.public_metrics.following_count | expansions=author_id&user.fields=public_metrics | Int |
| actor.listedCount | includes.users.public_metrics.listed_count | expansions=author_id&user.fields=public_metrics | Int |
| actor.statusesCount | includes.users.public_metrics.tweet_count | expansions=author_id&user.fields=public_metrics | Int |
| actor.languages[] | 利用不可 | 利用不可 (ツイートの lang から推定) | |
| actor.location.displayName | includes.users.location | expansions=author_id&user.fields=location | String |
| actor.image | includes.users.profile_image_url | expansions=author_id&user.fields=profile_image_url | String |
| actor.links | includes.users.url | expansions=author_id&user.fields=url | String |
| actor.verified | includes.users.verified | expansions=author_id&user.fields=verified | Boolean |
| 利用不可 | includes.users.withheld | expansions=author_id&user.fields=withheld | オブジェクト |
| 該当なし | includes.users.entities | expansions=author_id&user.fields=entities | オブジェクト |
| 該当なし | includes.users.entities.url | expansions=author_id&user.fields=entities | オブジェクト |
| actor.links | includes.users.entities.url.urls | expansions=author_id&user.fields=entities | オブジェクトの配列 |
| 該当なし | includes.users.entities.url.urls.start | expansions=author_id&user.fields=entities | Int |
| 該当なし | includes.users.entities.url.urls.end | expansions=author_id&user.fields=entities | Int |
| 該当なし | includes.users.entities.url.urls.url | expansions=author_id&user.fields=entities | 文字列 |
| actor.links.href | includes.users.entities.url.urls.expanded_url | expansions=author_id&user.fields=entities | 文字列 |
| 該当なし | includes.users.entities.url.urls.display_url | expansions=author_id&user.fields=entities | 文字列 |
| 該当なし | includes.users.entities.description | expansions=author_id&user.fields=entities | オブジェクト |
| 該当なし | includes.users.entities.description.hashtags | expansions=author_id&user.fields=entities | オブジェクトの配列 |
| 該当なし | includes.users.entities.description.hashtags.start | expansions=author_id&user.fields=entities | Int |
| 該当なし | includes.users.entities.description.hashtags.end | expansions=author_id&user.fields=entities | Int |
| 該当なし | includes.users.entities.description.hashtags.tag | expansions=author_id&user.fields=entities | String |
| 該当なし | includes.users.entities.description.mentions | expansions=author_id&user.fields=entities | オブジェクトの配列 |
| 該当なし | includes.users.entities.description.mentions.start | expansions=author_id&user.fields=entities | Int |
| 該当なし | includes.users.entities.description.mentions.end | expansions=author_id&user.fields=entities | Int |
| 該当なし | includes.users.entities.description.mentions.username | expansions=author_id&user.fields=entities | String |
| 該当なし | includes.users.entities.description.cashtags | expansions=author_id&user.fields=entities | オブジェクトの配列 |
| 該当なし | includes.users.entities.description.cashtags.start | expansions=author_id&user.fields=entities | Int |
| 該当なし | includes.users.entities.description.cashtags.end | expansions=author_id&user.fields=entities | Int |
| 利用不可 | includes.users.entities.description.cashtags.tag | expansions=author_id&user.fields=entities | String |
Poll オブジェクト
| Activity Streams フォーマット | Twitter v2 フォーマット | 必要な v2 パラメータ | v2 の型 |
| 利用不可 | includes.polls | expansions=attachments.poll_ids | オブジェクトの配列 |
| 利用不可 | includes.polls.id | expansions=attachments.poll_ids | String |
| 利用不可 | includes.polls.options | expansions=attachments.poll_ids | オブジェクトの配列 |
| 利用不可 | includes.polls.options.position | expansions=attachments.poll_ids | Int |
| 利用不可 | includes.polls.options.label | expansions=attachments.poll_ids | String |
| 利用不可 | includes.polls.options.votes | expansions=attachments.poll_ids | Int |
| 利用不可 | includes.polls.voting_status | expansions=attachments.poll_ids&poll.fields=voting_status | String |
| 利用不可 | includes.polls.duration_minutes | expansions=attachments.poll_ids&poll.fields=duration_minutes | Int |
| 利用不可 | includes.polls.end_datetime | expansions=attachments.poll_ids&poll.fields=end_datetime | 日付 (ISO 8601) |
Place オブジェクト
| Activity Streams 形式 | Twitter v2 形式 | 必須の v2 パラメーター | v2 における型 |
| location | includes.places | expansions=geo.place_id | オブジェクトの配列 |
| location.displayName | includes.places.full_name | expansions=geo.place_id | string |
| Parsed from location.link | includes.places.id | expansions=geo.place_id | string |
| location.name | includes.places.name | expansions=geo.place_id&place.fields=name | string |
| location.country_code | includes.places.country | expansions=geo.place_id&place.fields=country | string |
| location.twitter_place_type | includes.places.place_type | expansions=geo.place_id&place.fields=place_type | string |
| location.twitter_country_code | includes.places.country_code | expansions=geo.place_id&place.fields=country_code | string |
| location.geo | includes.places.geo | expansions=geo.place_id&place.fields=geo | object |
| location.geo.type | includes.places.geo.type | expansions=geo.place_id&place.fields=geo | string |
| location.geo.coordinates | includes.places.geo.bbox | expansions=geo.place_id&place.fields=geo | array |
| 利用不可 | includes.places.geo.properties | expansions=geo.place_id&place.fields=geo | object |
メディアオブジェクト
| Activity Streams データ形式 | Twitter API v2 フォーマット | v2 の必須パラメータ | v2 での type |
| twitter_entities.media OR twitter_extended_entities.media | includes.media | expansions=attachments.media_keys | オブジェクトの配列 |
| twitter_entities.media.id_str OR twitter_extended_entities.media.id_str | includes.media.media_key | expansions=attachments.media_keys | 文字列 |
| twitter_entities.media.id OR twitter_extended_entities.media.id | 利用不可 | 利用不可 | |
| twitter_entities.media.indices OR twitter_extended_entities.media.indices | 利用不可 | 利用不可 | |
| twitter_entities.media.additional_media_info OR twitter_extended_entities.media.additional_media_info | 利用不可 | 利用不可 | |
| twitter_entities.media.additional_media_info.monetizable OR twitter_extended_entities.media.additional_media_info.monetizable | 利用不可 | 利用不可 | |
| twitter_entities.media.media_url OR twitter_extended_entities.media.media_url | 利用不可 | 利用不可 | |
| twitter_entities.media.media_url_https OR twitter_extended_entities.media.media_url_https | includes.media.preview_image_url | expansions=attachments.media_keys&media.fields=preview_image_url | 文字列 |
| twitter_entities.media.url OR twitter_extended_entities.media.url | 利用不可 | 利用不可 | |
| twitter_entities.media.display_url OR twitter_extended_entities.media.display_url | 利用不可 | 利用不可 | |
| twitter_entities.media.expanded_url OR twitter_extended_entities.media.expanded_url | 利用不可 | 利用不可 | |
| twitter_entities.media.type OR twitter_extended_entities.media.type | includes.media.type | expansions=attachments.media_keys | 文字列 |
| twitter_entities.media.sizes OR twitter_extended_entities.media.sizes | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.thumb OR twitter_extended_entities.media.sizes.thumb | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.thumb.h OR twitter_extended_entities.media.sizes.thumb.h | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.thumb.w OR twitter_extended_entities.media.sizes.thumb.w | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.thumb.resize OR twitter_extended_entities.media.sizes.thumb.resize | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.small OR twitter_extended_entities.media.sizes.small | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.small.h OR twitter_extended_entities.media.sizes.small.h | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.small.w OR twitter_extended_entities.media.sizes.small.w | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.small.resize OR twitter_extended_entities.media.sizes.small.resize | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.medium OR twitter_extended_entities.media.sizes.medium | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.medium.h OR twitter_extended_entities.media.sizes.medium.h | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.medium.w OR twitter_extended_entities.media.sizes.medium.w | 利用不可 | 利用不可 | |
| twitter_entities.media.sizes.medium.resize OR twitter_extended_entities.media.sizes.medium.resize | 利用できません | 利用できません | |
| twitter_entities.media.sizes.large OR twitter_extended_entities.media.sizes.large | 利用できません | 利用できません | |
| twitter_entities.media.sizes.large.h OR twitter_extended_entities.media.sizes.large.h | includes.media.height | expansions=attachments.media_keys&media.fields=height | Int |
| twitter_entities.media.sizes.large.w OR twitter_extended_entities.media.sizes.large.w | includes.media.width | expansions=attachments.media_keys&media.fields=width | Int |
| twitter_entities.media.sizes.large.resize OR twitter_extended_entities.media.sizes.large.resize | 利用できません | 利用できません | |
| twitter_extended_entities.media.video_info | 利用できません | 利用できません | |
| twitter_extended_entities.media.video_info.aspect_ratio | 利用できません | 利用できません | |
| twitter_extended_entities.media.video_info.duration_millis | includes.media.duration_ms | expansions=attachments.media_keys&media.fields=duration_ms | Int |
| twitter_extended_entities.media.video_info.variants | 利用できません | 利用できません | |
| twitter_extended_entities.media.video_info.variants.bitrate | 利用できません | 利用できません | |
| twitter_extended_entities.media.video_info.variants.content_type | 利用できません | 利用できません | |
| twitter_extended_entities.media.video_info.variants.url | 利用できません | 利用できません | |
| 利用できません | includes.media.alt_text | expansions=attachments.media_keys&media.fields=alt_text | 文字列 |
| 利用不可 | includes.media.public_metrics | expansions=attachments.media_keys&media.fields=public_metrics | オブジェクト |
| 利用不可 | includes.media.public_metrics.view_count | expansions=attachments.media_keys&media.fields=public_metrics | 整数 |
| 利用不可 | includes.media.non_public_metrics | expansions=attachments.media_keys&media.fields=non_public_metrics | オブジェクト |
| 利用不可 | includes.media.non_public_metrics.playback_0_count | expansions=attachments.media_keys&media.fields=non_public_metrics | 整数 |
| 利用不可 | includes.media.non_public_metrics.playback_25_count | expansions=attachments.media_keys&media.fields=non_public_metrics | 整数 |
| 利用不可 | includes.media.non_public_metrics.playback_50_count | expansions=attachments.media_keys&media.fields=non_public_metrics | 整数 |
| 利用不可 | includes.media.non_public_metrics.playback_75_count | expansions=attachments.media_keys&media.fields=non_public_metrics | 整数 |
| 利用不可 | includes.media.non_public_metrics.playback_100_count | expansions=attachments.media_keys&media.fields=non_public_metrics | 整数 |
| 利用不可 | includes.media.organic_metrics | expansions=attachments.media_keys&media.fields=organic_metrics | オブジェクト |
| なし | includes.media.organic_metrics.playback_0_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| なし | includes.media.organic_metrics.playback_25_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| なし | includes.media.organic_metrics.playback_50_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| なし | includes.media.organic_metrics.playback_75_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| なし | includes.media.organic_metrics.playback_100_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| なし | includes.media.organic_metrics.view_count | expansions=attachments.media_keys&media.fields=organic_metrics | Int |
| なし | includes.media.promoted_metrics | expansions=attachments.media_keys&media.fields=promoted_metrics | Object |
| なし | includes.media.promoted_metrics.playback_0_count | expansions=attachments.media_keys&media.fields=promoted_metrics | Int |
| なし | includes.media.promoted_metrics.playback_25_count | expansions=attachments.media_keys&media.fields=promoted_metrics | Int |
| なし | includes.media.promoted_metrics.playback_50_count | expansions=attachments.media_keys&media.fields=promoted_metrics | Int |
| 利用できません | includes.media.promoted_metrics.playback_75_count | expansions=attachments.media_keys&media.fields=promoted_metrics | 整数 |
| 利用できません | includes.media.promoted_metrics.playback_100_count | expansions=attachments.media_keys&media.fields=promoted_metrics | 整数 |
| 利用できません | includes.media.promoted_metrics.view_count | expansions=attachments.media_keys&media.fields=promoted_metrics | 整数 |
マッチングルールオブジェクト
| Activity Streams 形式 | Twitter v2 形式 | 必須の v2 パラメータ | v2 における type |
| gnip.matching_rules | matching_rules | フィルター済みストリームのデフォルト値 | オブジェクトの配列 |
| gnip.matching_rules.tag | matching_rules.tag | フィルター済みストリームのデフォルト値 | 文字列 |
| gnip.matching_rules.tag.id | 利用不可 | 利用不可 | |
| gnip.matching_rules.tag.id_str | matching_rules.id | フィルター済みストリームのデフォルト値 | 文字列 |