跳转到主要内容

开始使用 List Posts 查询 endpoint

本快速上手指南将帮助您使用 Postman 向 List Posts 查询 endpoint 发出第一个请求。 如果您想查看不同语言的示例代码,请访问我们的 X API v2 示例代码 GitHub 仓库。

先决条件

要完成本指南,您需要一组用于对请求进行身份验证的密钥和令牌。您可以按照以下步骤生成这些密钥和令牌:
  • 注册开发者账户并获得批准。
  • 在开发者门户中创建一个Project以及关联的开发者 App
  • 前往您的 App 的“Keys and tokens”页面以生成所需的凭据。请确保将所有凭据保存在安全的位置。

构建 List Posts 查询请求的步骤

第一步:选择一种工具或库

有多种工具、代码示例和库可用于向此 endpoint 发起请求,但这里我们将使用 Postman 来简化流程。 要将 X API v2 的 Postman 集合加载到您的环境,请点击以下按钮: 在您将 X API v2 集合加载到 Postman 后,进入“List”文件夹,选择“List Posts”文件夹,然后选择“List Posts lookup”。  

第二步:对请求进行身份验证

要正确向 X API 发起请求,您需要确认自己具有相应权限。对于此 endpoint,您必须使用 App onlyOAuth 2.0 Authorization Code with PKCEOAuth 1.0a User Context 等身份验证方式对请求进行认证。 为简化流程,我们将在此请求中使用 App only;但如果您希望请求私有的 metrics 或 Post,则需要改用上述其他身份验证方式之一。 要使用 App only,需将您的 密钥和令牌(尤其是 App only Access Token,也称为 App only Bearer Token)添加到 Postman:选择名为“X API v2”的环境(位于 Postman 右上角),并将您的 密钥和令牌 填入“initial value”和“current value”字段(点击环境下拉菜单旁的眼睛图标进行设置)。 如果配置正确,这些变量会自动注入到请求的 Authorization 选项卡。  

第三步:确定并指定要从哪个 List 中检索 Posts

你必须在请求中指定要接收的 List。你可以通过访问 x.com,点击某个 List,然后查看其 URL 来找到该 List 的 ID。例如,以下 URL 的 List ID 为 84839422。 https://x.com/i/lists/84839422 目标 ID 可以是任意有效的 List ID。在 Postman 中,前往“Params”选项卡,在 id 路径变量的“Value”列中输入你的 ID。务必不要在任何 ID 的前后包含空格。
KeyValue
id84839422(List ID)

步骤四:确定并指定要检索的 fields

如果在步骤三后点击“Send”按钮,你将会在响应中收到默认的 Post 对象 fields:id 和 text。 如果你希望获取更多 fields,需要在请求中通过 tweet.fields 和/或 expansions 参数进行指定。 在本练习中,我们将从不同对象请求三组额外的 fields:
  • 主 Lists 对象中的额外 created_at field。
  • 使用 expansions 参数返回完整的 用户对象
  • 关联用户对象中的额外 user.created_at field。
在 Postman 中,转到“Params”选项卡,并在“Query Params”表中添加以下键值对:
KeyValueReturned fields
tweet.fieldscreated_atcreated_at
expansionsauthor_idincludes.users.id,
includes.users.name,
includes.users.username
user.fieldscreated_atincludes.users.created_at
现在你应当能在“Send”按钮旁看到类似的 URL: https://api.x.com/2/lists/84839422/tweets?expansions=author_id&user.fields=created_at&max_results=1

第五步:发起请求并查看响应

完成所有设置后,点击“Send”按钮,您将收到与下方示例相似的响应:
{
  "data": [
    {
      "author_id": "4172587277",
      "id": "1458172421115101189",
      "text": "德国本周新冠肺炎新增病例创下纪录。据政府和卫生专家表示,未接种疫苗的人群是造成这一局面的原因 \nhttps://t.co/4POyaPwMLu"
    }
  ],
  "includes": {
    "users": [
      {
        "username": "MomentsBrasil",
        "name": "X Moments Brasil",
        "created_at": "2015-11-12T16:46:02.000Z",
        "id": "4172587277"
      }
    ]
  },
  "meta": {
    "result_count": 1,
    "next_token": "7140dibdnow9c7btw3z2vwioavpvutgzrzm9icis4ndix"
  }
}
请注意: 此 endpoint 的响应将支持针对指定的 List 查询最新的 800 条 Post
I