如需检索 PartnerLink 资源,请发送 SearchPartnerLinksRequest。
请求的 parent 字段是必需的。使用以下格式将 parent 设置为特定账号的资源名称:
accountTypes/{account_type}/accounts/{account}
为了在不同使用场景中实现灵活性,SearchPartnerLinksResponse
包含所有 PartnerLink 资源,其中请求中的 parent 为
以下任一值:
- 由
owner_account字段标识的账号 - 由
partner_account字段标识的账号
设置请求标头如果您使用
合作伙伴关联、Google Ads 经理账号或 Display & Video 360 父级合作伙伴
账号访问parent账号。
过滤结果,将响应限制为具有特定 属性的资源。
Search 方法会返回结果页面。如需检索请求的所有资源,请检查 next_page_token 并对结果进行分页。
设置请求标头
Search 方法支持 login-account 标头,以定义凭据对请求中的 parent 账号的访问路径。PartnerLinkService
方法不支持 linked-account 标头。
如需详细了解如何在不同访问场景中设置标头,请参阅目标和标头。
过滤结果
使用请求的 filter 字段检索特定合作伙伴关联。filter 字段是一个字符串,用于定义您要应用的一组条件,以及 API 是否应使用 AND 或 OR 组合这些条件。如需详细了解过滤选项和语法,请参阅
AIP-160:过滤。
您可以使用所有者账号或合作伙伴账号的 account_id 定义 filter:
owning_account.account_id:所有者账号的account_id。partner_account.account_id:合作伙伴账号的account_id。
例如,以下 filter 会返回所有者账号的账号 ID 为 OWNING_ACCOUNT_ID 的所有合作伙伴关联:
owning_account.account_id = OWNING_ACCOUNT_ID
以下是另一个 filter 示例。此示例会返回所有者账号的账号 ID 为 OWNING_ACCOUNT_ID 或合作伙伴账号的账号 ID 为 PARTNER_ACCOUNT_ID 的所有合作伙伴关联:
owning_account.account_id = OWNING_ACCOUNT_ID OR partner_account.account_id = PARTNER_ACCOUNT_ID
将该 filter 修改为使用 AND 而不是 OR,会将返回的
资源限制为所有者账号的账号 ID 为
OWNING_ACCOUNT_ID 且合作伙伴账号的账号 ID 为
PARTNER_ACCOUNT_ID 的合作伙伴关联:
owning_account.account_id = OWNING_ACCOUNT_ID AND partner_account.account_id = PARTNER_ACCOUNT_ID
对结果进行分页
使用 page_size 字段控制单个响应中返回的结果数量。例如,如果您将 page_size 设置为 10,则 API 每个响应最多返回 10 个结果。 如果与您的请求匹配的结果少于 10 个,API 可能会返回少于 10 个结果。
默认 page_size 为 50,最大值为 1000。
如果结果数量超过单个响应可容纳的数量,响应将包含 next_page_token。如需检索下一页或下一组结果,请再次发送相同的请求,并将 page_token 字段设置为此值。所有其他参数必须与之前的请求相同。
如果响应中未包含 next_page_token 字段,则表示没有更多结果。