Search Ads 360 Reporting API 调用结构

对 Search Ads 360 Reporting API 的调用通常通过您的客户端库进行。如需了解详情，请参阅客户端库说明。不过，在测试和调试时，了解底层请求详情的结构会很有帮助。

Search Ads 360 Reporting API 是一个具有 REST 绑定的 gRPC API。这意味着您可以通过以下两种方式调用该 API：

首选方法
使用客户端库：
  • 将请求正文创建为协议缓冲区。
  • 使用 HTTP/2 向服务器发送请求。
  • 将响应反序列化到协议缓冲区。
  • 解析结果。
可选的替代方法
使用 REST：
  • 以 JSON 对象的形式创建请求正文。
  • 使用 HTTP 1.1 向服务器发送请求。
  • 将响应反序列化为 JSON 对象。
  • 解析结果。

如需了解详情，请参阅 Google Cloud API。

以下部分适用于 gRPC 和 REST 协议。

资源名称

API 中的大多数对象都通过其资源名称字符串进行标识。使用 REST 接口时，这些字符串还可用作网址。

如需详细了解支持的资源及其路径表示形式，请参阅参考 > REST。 此政策同样适用于其他服务。

复合 ID

如果某个对象的 ID 不具有全局唯一性，则系统在构建该对象的复合 ID 时，要在前面加上其父级 ID 和一个波浪线 (~)。

例如，由于广告组广告 ID 不具有全局唯一性，因此系统会在其前面加上父对象（广告组）ID，从而生成唯一的复合 ID。

示例：AdGroupId（共 123）+ ~ + AdGroupAdId（共 45678）= 复合广告组广告 ID 123~45678。

请求标头

以下部分中的 HTTP 标头（或 gRPC 元数据）应包含在请求正文中。

授权

您需要在表单中包含 OAuth2 访问令牌：

Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]

该令牌应标识代表客户进行操作的经理帐号，或直接管理自己的子级经理帐号或客户帐号的广告客户。如需了解详情，请参阅 Search Ads 360 经理帐号简介和身份验证。

登录客户 ID 标头

使用经理帐号访问子级经理帐号或客户帐号时，必须使用 login-customer-id 标头。直接访问子级经理帐号或客户帐号时不需要这样做。虽然不是绝对必要，但我们建议您始终为已通过身份验证且有权访问多个帐号的用户指定 login-customer-id。这样可以避免歧义，并防止无意间将上下文设置为不正确的帐号。

请求应包含已授权用户的客户 ID，不带连字符 (-)，例如：

https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets

设置 login-customer-id 相当于在登录或点击右上角的个人资料图片后，在 Search Ads 360 界面中选择帐号。

响应标头

以下标头（或 gRPC trailing-metadata）随响应正文一起返回。我们建议您记录这些值，以便进行调试。

要求 ID

request-id 标头是用于唯一标识请求的字符串。