显示 API Explorer 并执行方法

在大多数文档页面上,屏幕右侧都会显示一个简化版 API Explorer。如果 API Explorer 未显示,请点击 Try it! 以显示 API Explorer 的精简版本。

如果参考文档页面中没有显示试试看!字样,则 API Explorer 不支持该方法。例如,API Explorer 与需要服务帐号的 API 不兼容,因此它不会显示在这些 API 的文档页面上。

显示 API Explorer 的展开版本

API Explorer 的展开版本包含 c网址、HTTP 及可能的其他代码示例。要显示 API Explorer 的展开版本,请点击“全屏”图标

执行方法

您可以使用 API Explorer 输入 API 方法的必需参数、可选参数和请求正文(如果适用)。对于许多 REST 方法(例如 list 方法),您只需要填充一个或两个字段即可执行该方法。例如,Books API 的 books.volumes.list 方法只需要查询参数 (q) 即可列出图书。如需试用 books.volumes.list 方法,请执行以下操作:

  1. 转到 books.volumes.list
  2. 如果未显示 APIs Explorer,请点击 Try it!
  3. q 字段中,输入 Hunger Games(不含任何引号或特殊字符)。
  4. 向下滚动,然后点击执行
  5. (可选)Google 登录屏幕会要求您选择 Google 帐号。
  6. (可选)Google 授权对话框会询问您是否允许“管理您的图书”。点击允许。结果显示在“执行”按钮下方。

如果 API Explorer 显示 200 的结果,则表示方法成功。

排查 API Explorer 问题

您收到了 401 或 403 错误

如果您在使用 API Explorer 执行方法时收到 401 或 403 错误,则可能是由于以下某种原因所致:

  • 您使用的授权类型有误(使用 API 密钥,而不是 OAuth 2.0)。 请尝试切换授权类型。
  • 您使用的是 OAuth 2.0,但范围太窄。请尝试使用更宽泛的范围。

“授权”对话框未显示

API Explorer 使用弹出式窗口授予对私有数据的访问权限。如果浏览器拦截了弹出式窗口,该弹出式窗口就不会出现,而您也将无法授予访问权限。

如果您在授权对话框中点击允许,但没有任何反应,请尝试更改浏览器的弹出式窗口设置以启用弹出式窗口。