您向 Google Ads API 发送请求时,该请求可能会因各种原因而失败。例如,您可能提供了无效实参,或者您的账号已达到制作新广告系列的限额。在这种情况下,API 会返回错误,告知您出了什么问题。
本指南介绍了如何读取和处理 API 错误,以便您构建更强大的应用。
错误结构
如果您使用的是我们的某个客户端库,则 API 错误会显示为异常。这些异常包含有助于您了解错误发生原因的详细信息。
Google Ads API 以标准格式返回错误信息。如果发生错误,响应将包含一个 GoogleAdsFailure 对象。此对象包含各个 GoogleAdsError 对象的列表,每个对象都详细说明了一个特定错误。
每个 GoogleAdsError 对象都提供:
error_code:一种特定的错误代码,用于告知您错误类型,例如AuthenticationError.NOT_ADS_USER。message:直观易懂的错误原因说明。trigger:导致错误的值,例如“1234”。location:有关请求的哪个部分导致了错误的详细信息,例如特定字段名称。
除了错误列表之外,GoogleAdsFailure 还包含 requestId,这是导致错误的 API 请求的唯一标识符。
错误示例
以下是 JSON 格式的错误示例。此错误表示请求中缺少索引为 0 的 ad_group 的 name 字段。
{
"code": 3,
"message": "Request contains an invalid argument.",
"details": [
{
"@type": "type.googleapis.com/google.ads.googleads.v22.errors.GoogleAdsFailure",
"errors": [
{
"errorCode": {
"requestError": "REQUIRED_FIELD_MISSING"
},
"message": "Required field is missing",
"location": {
"fieldPathElements": [
{
"fieldName": "ad_group",
"index": 0
},
{
"fieldName": "name"
}
]
}
}
],
"requestId": "unique_request_id_12345"
}
]
}
如何处理错误
如果您遇到错误,请按以下步骤操作:
- 检查
errors列表:查看GoogleAdsFailure对象中的每个GoogleAdsError。error_code和message会告诉您出了什么问题。 - 检查
location:location字段可帮助您查明请求中出现问题的位置。 - 查阅文档:对于特定错误代码,请查看常见错误页面或完整的错误代码参考,详细了解相应错误及修正方法。
- 调整请求:根据错误消息,更正 API 请求。例如,如果您看到
REQUIRED_FIELD_MISSING,请确保在请求中提供该字段。 - 记录
request_id:如果您无法找到解决错误的方法,需要通过论坛与支持团队联系,请附上request_id。此 ID 可帮助 Google 工程师调查您的问题。