问题排查

在使用 Display & Video 360 API 时，您可能会在许多情况下遇到错误。这些问题可能与代码中的 bug、用户输入无效或 API 本身的问题有关。无论原因如何，了解如何排查错误是开发流程的重要环节。本指南将提供一些最佳实践提示，帮助您轻松上手。

回顾基本知识

  1. 查看前提条件指南。确保您有权访问 Display & Video 360 以及正确配置的 API 项目。
  2. 如果您的响应包含 HTTP 错误，请务必仔细查看这些错误，并确保请求是发送到正确的 API 和服务。
  3. 查看授权指南。确保您的请求包含必要的 OAuth 2.0 凭据。

  4. 确认您使用的是正确凭据。如需详细了解如何生成身份验证凭据，请参阅设置应用指南。您还可以将访问令牌传递给 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 对象的内容包含足够的信息，可帮助您确定问题所在。如果没有，您可能需要做一些额外的研究来了解错误的含义。

研究错误

  1. 请参阅常见错误部分，其中详细介绍了一些最常见的错误。

  2. 如果常见错误部分未涵盖您遇到的错误，请参阅参考文档，并尝试搜索错误代码、状态和消息。

  3. 如果您遇到尚无相关记录的错误，请告诉我们。

确定根本原因

至此，您已经找到了错误并了解了其含义。如果没有，请返回了解错误；如果您认为自己在 API 中遇到了无法自行解决的错误，请直接跳转到获取帮助。

您需要先确定导致错误的原因，然后才能修正错误。这通常是代码中存在 bug 或输入值无效所致。

如需确定问题是否与代码中的 bug 有关，您应先验证代码是否按预期运行。首先，不妨查看负责发出失败请求的代码部分，看看是否存在明显问题。在某些情况下，可能需要使用调试工具逐行调试代码，以确保其正常运行。

检查 HTTP 请求是发现潜在 bug 以及无效输入情况的另一种有用方法。许多官方客户端库都可以配置为记录 HTTP 请求和响应；如需了解详情，请参阅您选择的库的文档。您还可以使用 HTTP 代理（例如 Charles、Squid 或 Fiddler）来捕获请求和响应日志。获取这些日志后，请查看这些日志，确保应用提供的请求参数值正确无误且与您的预期一致。

确定导致错误的 bug 或无效输入后，修复方法应该会很明显。不过，如果您遇到问题或不确定如何最好地解决问题，可以在寻求帮助时使用您到目前为止收集的信息。

获取帮助

如果您无法自行解决错误，可以通过 Display & Video 360 帮助中心内的此表单与我们的支持团队联系。

在填写此表单时，您应尽可能提供有关您遇到的问题以及您已采取的问题排查步骤的详细信息。要包含的实用信息：

  • HTTP 请求和响应日志。请务必隐去敏感信息，例如 OAuth 2.0 访问令牌、电子邮件地址等。
  • 代码段。如果您能够将问题归因于代码的特定部分，或者怀疑问题与语言相关，请附上一段小段代码来说明您在做什么。
  • 其他信息，例如运行时/解释器版本和平台，这些信息可能对尝试重现问题的其他人有用。

解决问题

确定问题原因并找到解决方案后，接下来就该实施修复措施了。在部署到生产环境之前，请尽可能在受控环境（例如专门用于测试的合作伙伴或广告客户）中针对一系列良好和不良输入测试您的修复程序。