对 Search Ads 360 Reporting API 的调用通常通过客户端库进行。如需了解详情,请参阅客户端库说明。不过,在测试和调试时,了解底层请求详细信息的结构会很有用。
Search Ads 360 Reporting API 是一个带有 REST 绑定的 gRPC API。这意味着,您可以通过以下两种方式调用此 API:
如需了解详情,请参阅 Google Cloud API。
以下部分适用于 gRPC 和 REST 协议。
资源名称
API 中的大多数对象都通过其资源名称字符串进行标识。使用 REST 接口时,这些字符串还可用作网址。
如需详细了解受支持的资源及其路径表示法,请参阅参考 > REST。这种格式也适用于其他服务。
复合 ID
如果对象的 ID 不具有全局唯一性,则在构建该对象的复合 ID 时,要在前面加上其父级的 ID 和波浪符号 (~)。
例如,由于广告组广告 ID 不具有全局唯一性,因此系统会在其前面加上父级对象(即广告组)的 ID,从而形成具有唯一性的复合 ID。
示例:123
的 AdGroupId
+ 45678
的 ~
+ AdGroupAdId
= 123~45678
的复合广告组广告 ID。
请求标头
以下部分中的 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
标头是用于对请求进行唯一标识的字符串。