对象模型
Tweet
id
、text
和 created_at
。Tweet 对象还是多个子对象的“父”对象,包括 user
、media
、poll
和 place
。在请求 Tweet 对象的这些根级字段时,请使用参数 tweet.fields
。
可以在 user 资源中找到并展开(expand)Tweet 对象。与所请求 Tweet 相关的其他 tweets 也可在 Tweet 资源中找到并展开。该对象可在 user 资源中通过 ?expansions=pinned_tweet_id
,或在 Tweet 资源中通过 ?expansions=referenced_tweets.id
进行展开,以仅获取带有默认字段的对象。在请求额外字段以完善该对象时,请将 expansions 与参数 tweet.fields
搭配使用。
字段值 | 类型 | 描述 | 使用方式 |
---|---|---|---|
id (默认) | string | 请求的 Tweet 的唯一标识符。 | 使用此标识符以编程方式检索特定的 Tweet。 |
text (默认) | string | Tweet 的实际 UTF-8 文本。有关有效字符的详细信息,请参阅 twitter-text。 | 关键词提取和情感分析/分类。 |
edit_history_tweet_ids (默认) | object | 表示 Tweet 所有版本的唯一标识符。对于未编辑的 Tweet,将有一个 ID。对于有编辑历史的 Tweet,将有多个 ID。 | 使用此信息查找 Tweet 的编辑历史。 |
article | object | 包含此 Tweet 中存在的文章的元数据。 | 使用此字段获取文章的文本和实体。 |
attachments | object | 指定此 Tweet 中存在的附件类型(如果有)。 | 了解为请求的扩展返回的对象。 |
author_id | string | 发布此 Tweet 的用户的唯一标识符。 | 填充用户对象,共享数据集以供同行评审。 |
card_uri | string | 此 Tweet 中存在的卡片的 URI。 | |
community_id | string | 此 Post 所属社区的唯一标识符。 | |
context_annotations | array | 包含 Tweet 的上下文注释。 | 实体识别/提取,主题分析。 |
conversation_id | string | 对话的原始 Tweet 的 Tweet ID(包括直接回复、回复的回复)。 | 使用此字段从 Tweet 重构对话。 |
created_at | date (ISO 8601) | Tweet 的创建时间。 | 对时间序列分析和了解 Tweet 创建时间很有用。 |
display_text_range | array | 包含显示文本部分的开始和结束索引的数组。 | 对于了解长帖子默认显示的文本部分很有用。 |
edit_controls | object | 指示 Tweet 还能编辑多长时间以及剩余编辑次数。 | 使用此字段确定 Tweet 是否符合编辑条件。 |
entities | object | 从 Tweet 文本中解析出的实体。请参阅 Twitter 对象中的实体。 | 提供有关话题标签、URL、提及等的附加信息。 |
geo | object | 指示地理标记 Tweet 的位置或地点。 | 使用此字段获取地理标记 Tweet 的位置。 |
in_reply_to_user_id | string | 如果所表示的 Tweet 是回复,此字段将包含原始 Tweet 的作者 ID。 | 确定 Tweet 是否是对另一个 Tweet 的回复。 |
lang | string | Tweet 的语言,如果被 Twitter 检测到。 | 按口语对 Tweet 进行分类。 |
non_public_metrics | object | 请求时 Tweet 的非公开参与度量。需要用户上下文身份验证。 | 确定为 Tweet 生成的总展示次数。 |
note_tweet | object | 包含长篇 Post(>280 个字符)的完整文本。 | 获取帖子的完整文本。 |
organic_metrics | object | 请求时在自然上下文中跟踪的 Tweet 参与度量。需要用户上下文身份验证。 | 衡量 Tweet 的自然参与度。 |
possibly_sensitive | boolean | 指示内容是否可能被识别为敏感内容。 | 研究某些类型内容的传播。 |
promoted_metrics | object | 请求时在推广上下文中跟踪的 Tweet 参与度量。需要用户上下文身份验证。 | 衡量 Tweet 被推广时的参与度。 |
public_metrics | object | 请求时 Tweet 的公开参与度量。 | 衡量 Tweet 参与度。 |
referenced_tweets | array | 此 Tweet 引用的 Tweet 列表,例如转发、引用 Tweet 或回复。 | 了解转发等的对话方面。 |
reply_settings | string | 显示谁可以回复给定的 Tweet。选项有 “everyone”、“mentioned_users” 和 “followers”。 | 确定 Tweet 的对话回复设置。 |
withheld | object | 包含被扣留内容的扣留详细信息。 | |
scopes | object | 包含 Tweet 的范围详细信息。 | 指示谁可以查看帖子。仅对推广帖子返回。 |
media_metadata | array | 包含 Tweet 媒体附件的元数据。 | 获取附加元数据,如 Tweet 媒体附件的 alt_text 。 |
$BEARER_TOKEN
替换为你自行生成的 OAuth 2.0 Bearer Token。
用户
user.fields
参数。
用户对象也可以作为子对象出现,并在 Tweet 对象中进行展开。可通过 ?expansions=author_id
或 ?expansions=in_reply_to_user_id
进行展开,以获取仅包含默认字段的精简对象。若需补充完整该对象,请在使用 expansion 的同时配合字段参数 user.fields
请求额外字段。
字段值 | 类型 | 描述 | 使用方式 |
---|---|---|---|
id (default) | string | 该用户的唯一标识符。"id": "2244994945" | 用于以编程方式检索特定 Twitter 用户的信息。 |
name (default) | string | 用户的显示名称,由用户在其个人资料中定义。不一定是真实姓名。通常限制在 50 个字符以内,但可能会发生变化。"name": "Twitter Dev" | |
username (default) | string | 该用户的 Twitter 用户名、昵称或别名。用户名是唯一的,但可能会发生变化。通常最多 15 个字符长,但某些历史账户可能存在更长的名称。"username": "TwitterDev" | |
affiliation | object | 包含用户关联信息的详细信息。 | 可用于获取用户的关联徽章。 |
confirmed_email | string | 已认证用户的确认邮箱地址。 | |
connection_status | array | 提供认证用户与被查询用户之间的关系列表,如关注、被关注、发送关注请求、收到关注请求、屏蔽、静音 ”connection_status”: [ “follow_request_received”, “follow_request_sent”, “blocking”, “followed_by”, “following”, “muting” ] | 可用于确定认证用户与被查询用户之间的连接状态。 |
created_at | date (ISO 8601) | 用户账户在 Twitter 上创建的 UTC 日期时间。"created_at": "2013-12-14T04:35:55.000Z" | 可用于确定某人使用 Twitter 的时长 |
description | string | 该用户个人资料描述(也称为简介)的文本,如果用户提供了的话。"description": "The voice of the X Dev team and your official source for updates, news, and events, related to the X API." | |
entities | object | 包含用户描述中具有特殊含义的文本的详细信息。"entities": { <br/> "url": { <br/> "urls": [ <br/> { <br/> "start": 0, <br/> "end": 23, <br/> "url": "https://t.co/3ZX3TNiZCY", <br/> "expanded_url": "/content/developer-twitter/en/community", <br/> "display_url": "developer.x.com/en/community" <br/> } <br/> ] <br/> }, <br/> "description": { <br/> "urls": [ <br/> { <br/> "start": 0, <br/> "end": 23, <br/> "url": "https://t.co/3ZX3TNiZCY", <br/> "expanded_url": "/content/developer-twitter/en/community", <br/> "display_url": "developer.x.com/en/community" <br/> }, <br/> "hashtags": [ <br/> { <br/> "start": 23, <br/> "end": 30, <br/> "tag": "DevRel" <br/> }, <br/> { <br/> "start": 113, <br/> "end": 130, <br/> "tag": "BlackLivesMatter" <br/> }, <br/> "mentions": [ <br/> { <br/> "start": 0, <br/> "end": 10, <br/> "tag": "TwitterDev" <br/> }, <br/> "cashtags": [ <br/> { <br/> "start": 12, <br/> "end": 16, <br/> "tag": "twtr" <br/> } <br/> ] <br/> } <br/> } | 实体是 JSON 对象,提供与描述相关的话题标签、URL、用户提及和股票代码的附加信息。请参考各自的实体以获取更多详细信息。 所有用户 start 索引都是包含的,而所有用户 end 索引都是排除的。 |
is_identity_verified | boolean | 指示用户是否已通过身份验证。 | |
location | string | 用户在个人资料中指定的位置,如果用户提供了的话。由于这是一个自由格式的值,它可能不表示有效位置,但在执行位置查询搜索时可能会进行模糊匹配。"location": "127.0.0.1" | |
most_recent_tweet_id | string | 该用户最新 Tweet 的唯一标识符。 | 确定用户的最新 Tweet。 |
parody | boolean | 指示该用户账户是否具有恶搞标签。 | |
pinned_tweet_id | string | 该用户置顶 Tweet 的唯一标识符。"pinned_tweet_id": "1255542774432063488" | 确定置顶到用户个人资料顶部的 Tweet。可能用于确定用户的语言。 |
profile_banner_url | string | 该用户个人资料横幅的 URL,如用户个人资料中显示的那样。"profile_banner_url": "https://pbs.twimg.com/profile_banners/1716450569358098432/1721022977" | 可用于下载该用户的个人资料横幅。 |
profile_image_url | string | 该用户个人资料图像的 URL,如用户个人资料中显示的那样。"profile_image_url": "https://pbs.twimg.com/profile_images/1267175364003901441/tBZNFAgA_normal.jpg" | 可用于下载该用户的个人资料图像。 |
protected | boolean | 指示该用户是否选择保护他们的 Tweets(换句话说,该用户的 Tweets 是否为私密)。"protected": false | |
public_metrics | object | 包含此用户的活动详情。"public_metrics": { "followers_count": 507902, "following_count": 1863, "tweet_count": 3561, "listed_count": 1550 } | 可用于确定 X 用户的影响范围或影响力,量化用户的兴趣范围,以及用户在 X 上的参与度。 |
receives_your_dm | boolean | 指示此用户是否会接收已认证用户的私信。 | |
subscription | object | 包含用户是否订阅已认证用户的详情。 | |
subscription_type | string | 表示已认证用户拥有的 X Premium 订阅类型的字符串。示例:None 、Basic 、Premium 、PremiumPlus 。如果用户不是已认证用户,将始终返回 None 。 | |
url | string | 用户个人资料中指定的 URL(如果存在)。"url": "https://t.co/3ZX3TNiZCY" | X 用户在其个人资料中提供的 URL。这可能是主页,但并非总是如此。 |
verified | boolean | 指示此用户是否为已验证的 X 用户。"verified": true | 指示此 X 用户是否拥有已验证账户。已验证账户让人们知道公众关注的账户是真实的。 |
verified_followers_count | string | 表示用户已验证关注者数量的字符串。 | |
verified_type | string | 表示用户拥有的验证类型的字符串。示例:“blue”、“business”、“government” | |
withheld | object | 包含被屏蔽内容的屏蔽详情(如适用)。 |
$BEARER_TOKEN
替换为你自行生成的 OAuth 2.0 Bearer Token。
Space
expansions
query 参数中添加至少一个 host_ids
、creator_id
、speaker_ids
、mentioned_user_ids
,即可返回这些对象的扩展信息。
与 Tweets 不同,Spaces 具有时效性,在结束后或被创建者取消时将不可用。当你的 App 处理 Spaces 数据时,你有责任返回最新信息,并且必须移除平台上已不再可用的数据。Spaces lookup endpoints 可帮助你确保尊重用户的期望与意图。
字段值 | 类型 | 描述 | 使用方式 |
---|---|---|---|
id (default) | string | 所请求 Space 的唯一标识符。"id": "1zqKVXPQhvZJB" | 唯一标识响应中返回的 Space。 |
state (default) | string | 指示 Space 已开始、将开始或已结束。"state": "live" | 过滤实时或已排期的 Spaces。 |
created_at | date (ISO 8601) | 此 Space 的创建时间。"created_at": "2021-07-04T23:12:08.000Z" | 了解 Space 的创建时间并按时间排序。 |
creator_id | string | Space 创建者的唯一标识符。"creator_id": "2244994945" | |
ended_at | date (ISO 8601) | 如适用,Space 的结束时间。"ended_at": "2021-07-04T00:11:44.000Z" | 确定实时 Space 的结束时间以计算持续时长。 |
host_ids | array | Space 主持人的唯一标识符。"host_ids": ["2244994945", "6253282"] | 扩展用户对象,了解参与度。 |
lang | string | 如检测到,Space 的语言。"lang": "en" | 按语言对 Spaces 进行分类。 |
is_ticketed | boolean | 指示该 Space 是否为售票 Space。"is_ticketed": false | 突出重点内容。 |
invited_user_ids | array | 受邀担任发言者的用户 ID 列表。"invited_user_ids": ["2244994945", "6253282"] | 扩展用户对象,了解参与度。 |
participant_count | integer | Space 中的用户数量,包括主持人和发言者。"participant_count": 420 | 了解参与度,生成报告。 |
subscriber_count | integer | 为该 Space 设置提醒的人数。"subscriber_count": 36 | 了解事件关注度。 |
scheduled_start | date (ISO 8601) | Space 的计划开始时间。"scheduled_start": "2021-07-14T08:00:00.000Z" | 与日历通知集成。 |
speaker_ids | array | 任一时间点发言过的用户列表。"speaker_ids": ["2244994945", "6253282"] | 扩展用户对象,了解参与度。 |
started_at | date (ISO 8601) | Space 的实际开始时间。"started_at": "2021-07-14T08:00:12.000Z" | 确定 Space 的开始时间。 |
title | string | Space 的标题。"title": "Say hello to the Space data object!" | 识别关键词、话题标签和提及。 |
topic_ids | array | 由 Space 创建者选择的主题 ID。"topic_ids": ["2244994945", "6253282"] | 识别关键词、话题标签和提及。 |
updated_at | date (ISO 8601) | Space metadata 的最后一次更新。"updated_at": "2021-07-11T14:44:44.000Z" | 保持信息最新。 |
$BEARER_TOKEN
替换为你自行生成的 OAuth 2.0 Bearer Token。
List
list.fields
。
List 对象不会作为其他数据对象的子对象出现。不过,可以在用户资源中查找并展开用户对象。通过在 expansions
query 参数中添加 owner_id
,即可展开这些对象。当需要请求附加字段以完善主要的 List 对象时,将此展开与 list.fields
字段参数一起使用;并使用 user.fields
来完善展开对象。
Field Value | Type | Description | How it can be used |
---|---|---|---|
id (default) | string | 此 List 的唯一标识符。"id": "2244994945" | 用于以编程方式检索特定 List 的信息。 |
name (default) | string | 创建 List 时设定的名称。"name": "Twitter Lists" | |
created_at | date (ISO 8601) | 此 List 创建时的 UTC 日期时间。"created_at": "2013-12-14T04:35:55.000Z" | 用于判断某个 List 在 Twitter 上存在了多长时间。 |
description | string | 面向用户的该 List 的简要说明。"description": "People that are active members of the Bay area cycling community on Twitter." | |
follower_count | integer | 关注此 List 的用户数量。"follower_count": 198 | |
member_count | integer | 此 List 的成员数量。"member_count": 60 | |
private | boolean | 指示该 List 是否为私密。"private": false | |
owner_id | string | 此 List 所有者的唯一标识符。"owner_id": "1255542774432063488" | 可用于判断该用户是否拥有其他 Lists,并展开用户对象。 |
$BEARER_TOKEN
替换为你生成的 Bearer Token。
媒体
?expansions=attachments.media_keys
可展开并获取仅包含默认字段的精简对象。若需补全对象中的更多字段,请在使用该 expansions 的同时指定字段参数:media.fields
。
字段值 | 类型 | 说明 | 用途 |
---|---|---|---|
media_key(默认) | string | 已展开媒体内容的唯一标识符。 "media_key": "13_1263145212760805376" | 可用于以编程方式检索媒体 |
type(默认) | string | 内容类型(animated_gif、photo、video)。 "type": "video" | 将媒体归类为照片、GIF 或视频 |
url | string | 指向 X 上媒体文件的直接 URL。 | 对于照片,返回带有 URL 字段的 Media 对象 |
duration_ms | integer | 当 type 为 video 时可用。视频的时长(毫秒)。 "duration_ms": 46947 | |
height | integer | 此内容的高度(像素)。 "height": 1080 | |
non_public_metrics | object | 请求时刻媒体内容的非公开互动度量。需要用户 context 认证。 "non_public_metrics": { "playback_0_count": 1561, "playback_100_count": 116, "playback_25_count": 559, "playback_50_count": 305, "playback_75_count": 183,} | 用于判断视频互动:有多少用户分别播放到各四分位点。 |
organic_metrics | object | 请求时刻在自然场景(organic)下跟踪的媒体内容互动度量。需要用户 context 认证。 "organic_metrics": { "playback_0_count": 1561, "playback_100_count": 116, "playback_25_count": 559, "playback_50_count": 305, "playback_75_count": 183, "view_count": 629} | 判断自然流量下的媒体互动情况。 |
preview_image_url | string | 此内容的静态占位预览图 URL。 "preview_image_url": "https://pbs.twimg.com/media/EYeX7akWsAIP1_1.jpg" | |
promoted_metrics | object | 请求时刻在推广场景(promoted)下跟踪的媒体内容互动度量。需要用户 context 认证。 "promoted_metrics": { "playback_0_count": 259, "playback_100_count": 15, "playback_25_count": 113, "playback_50_count": 57, "playback_75_count": 25, "view_count": 124} | 用于评估 Tweet 被推广时的媒体互动。 |
public_metrics | object | 请求时刻媒体内容的公开互动度量。 "public_metrics": { "view_count": 6865141} | 用于确定附加到该 Tweet 的视频的总观看次数。 |
width | integer | 此内容的宽度(像素)。 "width": 1920 | |
alt_text | string | 用于提升无障碍性的图像描述。长度最多 1000 个字符。目前仅能为图像添加 alt 文本。 "alt_text": "Rugged hills along the Na Pali coast on the island of Kauai" | 可在用户视障时提供图像的文字说明。 |
variants | array | 每个媒体对象可能有多个显示或播放变体,分辨率或格式各不相同。 "variants": [{ "bit_rate": 632000, "content_type": "video/mp4", "url": "https://video.twimg.com/ext_tw_video/1527322141724532740/pu/vid/320x568/lnBaR2hCqE-R_90a.mp4?tag=12"}] |
attachment.media_keys
扩展。请务必将 $BEARER_TOKEN
替换为你自行生成的 OAuth 2.0 Bearer Token。
投票
?expansions=attachments.poll_ids
扩展以返回仅含默认字段的精简对象。若需请求更多字段以补全该对象,请在扩展的同时使用字段参数 poll.fields
。
字段值 | 类型 | 说明 |
---|---|---|
id(默认) | string | 已扩展投票的唯一标识符。 |
{"id": "1199786642791452673"} | ||
options(默认) | array | 包含描述所引用投票中每个选项的对象。 |
{"options": [ { "position": 1, "label": "“C Sharp”", "votes": 795 }, { "position": 2, "label": "“C Hashtag”", "votes": 156 } ]} | ||
duration_minutes | integer | 指定该投票的总持续时间。 |
{"duration_minutes": 1440} | ||
end_datetime | date (ISO 8601) | 指定该投票的结束日期和时间。 |
{"end_datetime": "2019-11-28T20:26:41.000Z"} | ||
voting_status | string | 指示该投票当前是否仍可投票,或投票是否已关闭。 |
{"voting_status": "closed"} |
attachments.poll_id
扩展。请务必将 $BEARER_TOKEN
替换为你自行生成的 Bearer Token。
地点
?expansions=geo.place_id
来展开该对象,以获取仅包含默认字段的精简对象。当需要补充更多字段以完善对象时,将该扩展与字段参数 place.fields
一起使用。
字段取值 | 类型 | 说明 | 可用方式 |
---|---|---|---|
full_name(默认) | string | 更长形式的详细地点名称。 | 按特定地点名称对 Tweet 进行分类 |
"full_name": "Manhattan, NY" | |||
id(默认) | string | 若这是在 Tweet 中标注的兴趣点,则为已展开地点的唯一标识符。 | 用于以编程方式检索某个地点 |
"id": "01a9a39529b27f36" | |||
contained_within | array | 返回包含所引用地点的已知地点的标识符。 | |
country | string | 此地点所属国家的全称。 | 按国家名称对 Tweet 进行分类 |
"country": "United States" | |||
country_code | string | 此地点所属国家的 ISO Alpha-2 国家代码。 | 按国家代码对 Tweet 进行分类 |
"country_code": "US" | |||
geo | object | 包含以 GeoJSON 格式表示的地点详细信息。 | |
`json | |||
”geo”: | |||
“type”: “Feature”, | |||
“bbox”: [ | |||
-74.026675, | |||
40.683935, | |||
-73.910408, | |||
40.877483 | |||
], | |||
“properties”: | |||
} | |||
` | |||
name | string | 此地点的简称。 | 按特定地点名称对 Tweet 进行分类 |
"name": "Manhattan" | |||
place_type | string | 指定该地点信息所代表的信息类型,例如城市名称或兴趣点。 | 按特定类型的地点对 Tweet 进行分类 |
"place_type": "city" |
geo.place_id
扩展。请务必将 $BEARER_TOKEN
替换为你自行生成的 Bearer Token。
私信事件
- sender_id - 发送消息的账号 ID,或将参与者邀请加入群组会话的账号 ID
- participant_ids - 账号 ID 的数组。对于 ParticipantsJoin 和 ParticipantsLeave 事件,此数组将仅包含创建该事件的账号的一个 ID
- attachments - 提供发送方上传至 X 的内容所对应的媒体 ID
- referenced_tweets - 如果在 text 字段中检测到 Tweet URL,响应中将包含该 Tweet 的 ID
字段值 | 类型 | 说明 | 用途 |
id (default) | string | 事件的唯一标识符。 “id”: “1050118621198921728” | 用于以编程方式检索特定会话事件(适用于 v1.1 endpoint)。 |
event_type (default) | string | 描述事件类型。目前支持三种类型: * MessageCreate * ParticipantsJoin * ParticipantsLeave ”event_type”: “MessageCreate” | 在检索会话历史时用于判断消息创建时间;对于群组会话,用于了解参与者的加入与离开。所有 GET 方法均支持使用 event_type= 查询参数过滤特定事件类型。 |
text (default) | string | 私信的实际 UTF-8 文本。 “text”: “Hello, just you!” | 在聊天机器人场景中,可用于分析消息内容并确定自动化响应;也可用于构建会话搜索功能。 |
entities | object | 从私信文本中解析出的实体。 | 提供关于话题标签、URL、提及等的补充信息。 |
sender_id | string | 创建该事件的用户 ID。若要在响应中展开该对象,请将 sender_id 作为 expansion,并使用 user.fields 查询参数指定所需的用户对象属性。 “sender_id”: “906948460078698496” | 检索创建 MessageCreate 或 ParticipantsJoin 事件的用户对象。 |
participant_ids | array (of strings) | 加入和离开群组会话的参与者 ID。创建新群组会话时也会使用。若要在响应中展开该对象,请将 participant_ids 作为 expansion,并使用 user.fields 查询参数指定所需的用户对象属性。 “participant_ids”: [ “906948460078698496” ] | 用于检索加入和离开群组会话的参与者的用户对象。 |
dm_conversation_id | string | 该事件所属会话的唯一标识符。 “dm_conversation_id”: “1584988213961031680” | 用于以编程方式从会话中检索事件,并向其中添加私信。 |
created_at | date (ISO 8601) | Tweet 的创建时间(UTC)。 “created_at”: “2019-06-04T23:12:08.000Z” | 可用于了解私信的创建时间,或会话参与者的加入/离开时间。 |
referenced_tweets | array | 私信文本中提到的任何 Tweet 的 ID。若要在响应中展开该对象,请将 referenced_tweets.id 作为 expansion,并使用 tweet.fields 查询参数指定所需的 Tweet 对象属性。 “referenced_tweets”: [ “id”: “1578868150510456833” ] | 当私信引用了某条 Tweet 时,这些 ID 可用于查询该 Tweet 的详细信息。 |
attachments | object | 对于附带媒体的私信,提供已上传内容(照片、视频或 GIF)的 media key。若要在响应中展开该对象,请将 attachments.media_keys 作为 expansion,并使用 media.fields 查询参数指定所需的媒体对象属性。目前仅支持一个附件。 “attachments”: “media_keys”: [ “3_1136048009270239232” ] | 用于了解附加到私信的媒体对象。 |
- 基础事件属性,例如其创建时间及其所属的会话(dm_conversation)。
- 发送私信者的账号 ID 和描述。
- 任何被引用 Tweet 的文本及其发布时间。
- 任何被引用 Tweet 作者的账号 ID 和描述。
?dm_event.fields=id,sender_id,text,created_at,dm_conversation_id&expansions=sender_id,referenced_tweets.id&tweet.fields=created_at,text,author_id&user.fields=description
社区
字段值 | 类型 | 描述 | |
---|---|---|---|
created_at | 日期(ISO 8601) | 社区的创建时间。 | |
id | 字符串 | 社区的唯一标识符。 | |
name | 字符串 | 社区的名称。 | |
description | 字符串 | 社区描述的文本(如有)。 | |
access | 字符串 | 社区的访问级别。 可能的取值: | |
- Public | |||
- Closed | |||
join_policy | 字符串 | 社区的加入策略。 可能的取值: | |
- Open | |||
- RestrictedJoinRequestsDisabled | |||
- RestrictedJoinRequestsRequireAdminApproval | |||
- RestrictedJoinRequestsRequireModeratorApproval | |||
- SuperFollowRequired | |||
member_count | 整数 | 已加入该社区的成员数量。 |
$BEARER_TOKEN
替换为你自己生成的 Bearer Token。
如何使用 fields 和 expansions
fields
和 expansions
query(查询)参数,以在响应中获取更多对象和字段。
在本指南中,我们将基于下方的 Tweet 截图请求多个字段。

请求额外的 fields 和对象
- 通过我们的object model,或查看各 endpoint 的 API 参考页面中的 fields 列表,确定你希望请求的其他 fields。 在这种情况下,我们将请求以下附加 fields: attachments、author_id、created_at、public_metrics。
-
使用逗号分隔的列表,将上述字段作为其值来构建
tweet.fields
query(查询)参数:?tweet.fields=attachments,author_id,created_at,public_metrics
- 将 query 参数添加到你之前发起的 GET /tweets 请求中。
curl --request GET --url 'https://api.x.com/2/tweets?ids=1260294888811347969&tweet.fields=attachments,author_id,created_at,public_metrics' \ --header 'Authorization: Bearer $BEARER_TOKEN'
响应:
- 接下来,我们将请求与 Tweet 中包含的视频相关的 fields。为此,我们将使用
expansions
参数,将其值设为attachments.media_keys
,并将此参数添加到请求中。
- 最后,我们将请求视频的观看次数和时长。这些不是默认字段,所以我们必须明确请求它们。在您的请求中使用
media.fields
参数,并使用逗号分隔的值public_metrics
和duration_ms
。
curl --request GET --url 'https://api.x.com/2/tweets?ids=1260294888811347969&tweet.fields=attachments,author_id,created_at,public_metrics&expansions=attachments.media_keys&media.fields=duration_ms,public_metrics' --header 'Authorization: Bearer $BEARER_TOKEN'
响应:现在包含了 Tweet 截图中可见的全部 data。
- ids=1260294888811347969
- tweet.fields=attachments,author_id,created_at,public_metrics
- expansions=attachments.media_keys
- media.fields=public_metrics,duration_ms