在大多数文档页面上,屏幕右侧都会显示精简版 API Explorer。如果未显示 APIs Explorer,请点击试用!以显示精简版 APIs Explorer。
如果参考文档页面的右侧未显示试用!,则表示该方法不受 API Explorer 支持。例如,API Explorer 与需要服务账号的 API 不兼容,因此不会显示在这些 API 的文档页面上。
显示展开版 API Explorer
展开后的 API Explorer 包含 c网址、HTTP 和可能其他代码示例。如需显示展开版的 API Explorer,请点击“全屏”图标 。
执行方法
借助 APIs Explorer,您可以为 API 方法输入必需参数、可选参数以及请求正文(如果适用)。对于许多 REST 方法(例如列表方法),您只需填写一两个字段即可执行该方法。例如,Books API 的 books.volumes.list 方法仅需要一个查询参数 (q) 即可列出图书。如需尝试 books.volumes.list 方法,请执行以下操作:
- 前往
books.volumes.list。 - 如果未显示 API Explorer,请点击试用!
- 在
q字段中,输入饥饿游戏(不含任何引号或特殊字符)。 - 向下滚动,然后点击执行。
- (可选)系统会显示 Google 登录界面,要求您选择一个 Google 账号。
- (可选)系统会显示一个 Google 授权对话框,询问您是否同意“管理您的图书”。点击允许。结果会显示在“执行”按钮下方。
如果 API Explorer 显示结果为 200,则表示方法调用成功。
排查 API 探索器问题
您收到了 401 或 403 错误
如果您在使用 APIs Explorer 执行方法时收到 401 或 403 错误,很可能是以下某方面出了问题:
- 您使用的授权类型有误(使用了 API 密钥,而不是 OAuth 2.0)。尝试切换授权类型。
- 您使用的是 OAuth 2.0,但范围过窄。尝试使用更广泛的范围。
授权对话框未显示
API 浏览器使用弹出式窗口授予对您私有数据的访问权限。如果您的浏览器阻止弹出式窗口,则此弹出式窗口不会显示,您将无法授予访问权限。
如果您在授权对话框中点击允许后没有任何反应,请尝试更改浏览器的弹出式窗口设置以启用弹出式窗口。