在很多情况下,您在使用 Display & Video 360 API 时可能会遇到错误。这些问题可能与代码中的错误、无效的用户输入,甚至 API 本身的问题有关。无论出于何种原因,了解如何排查错误都是开发过程的重要组成部分。本指南将提供一些最佳实践提示,以帮助您上手。
基础知识回顾
- 查看前提条件指南。请确保您有权访问 Display & Video 360 和正确配置的 API 项目。
- 如果您的响应包含 HTTP 错误,请务必仔细查看这些错误,并确保向正确的 API 和服务发出请求。
- 查看授权指南。确保您的请求包含必要的 OAuth 2.0 凭据。
验证您使用的凭据是否正确。如需详细了解如何生成身份验证凭据,请参阅设置应用指南。您还可以将访问令牌传递给 Google OAuth2 API 的 tokeninfo 端点,以验证该访问令牌是否颁发给正确的 API 项目以及是否针对正确的范围进行了授权:
POST https://www.googleapis.com/oauth2/v2/tokeninfo?access_token={YOUR_ACCESS_TOKEN} 200 OK { "issued_to": "{API_PROJECT_CLIENT_ID}", "audience": "...", "scope": "{API_SCOPES}", "expires_in": ... }
了解错误
当 API 遇到错误时,它通常会返回包含 error
对象的 JSON 响应。此对象可提供关于所遇到特定错误的更多背景信息。
{
"error": {
"code": 404,
"message": "Resource type LINE_ITEM does not exist: advertisers/1/lineItems/1",
"status": "NOT_FOUND"
}
}
通常,error
对象的内容将包含足够的信息,可帮助您找出问题所在。如果不正确,您可能需要执行一些额外的研究,以确定错误的含义。
研究错误
确定根本原因
至此,您已经确定了错误并了解其含义。如果没有,请返回了解错误;如果您认为自己在 API 中遇到了无法自行修复的错误,请直接跳到获取帮助。
您需要确定错误的原因,然后才能修复错误。这通常是代码中的 bug 或输入值无效。
如需确定问题是否与代码中的 bug 有关,应首先验证您的代码是否按预期运行。首先,请考虑查看负责发出失败请求的代码段,以检查是否存在明显的问题。在某些情况下,可能需要使用调试工具逐行调试代码,以确保其正常运行。
检查 HTTP 请求是发现潜在 bug 以及无效输入情况的另一种实用方法。许多官方客户端库都可以配置为记录 HTTP 请求和响应;如需了解详情,请查看所选库的文档。HTTP 代理(例如 Charles、Squid 或 Fiddler)也可用于捕获请求和响应日志。获取这些日志后,请查看这些日志,确保应用提供的请求参数值正确无误,并且符合预期。
一旦您确定了导致该错误的错误或无效输入,便有望显而易见地进行修复。但是,如果您有疑问或不确定如何以最佳方式解决问题,可以在获取帮助时参考到目前为止收集到的信息。
获取帮助
如果您无法自行解决错误,可以通过 Display & Video 360 帮助中心内的此表单与我们的支持团队联系。
填写此表单时,请尽可能多地提供您遇到的问题以及已采取的问题排查步骤的相关信息。包含以下内容的实用信息:
- HTTP 请求和响应日志。请务必隐去敏感信息,例如 OAuth 2.0 访问令牌、电子邮件地址等。
- 代码段。如果您能够将问题隔离到某个特定的代码段中,或者怀疑问题特定于语言,请附上一小段代码来说明您正在进行的操作。
- 其他信息,例如运行时/解释器版本和平台,这些信息可能对尝试重现问题的其他人很有用。
解决问题
在您确定问题的原因并找到解决方案后,就可以实施修复方案了。尽可能在部署到生产环境之前,在受控环境(例如专门为测试配置的合作伙伴或广告主)中对照一系列良好和错误输入的内容测试修复效果。