RBM Management API 可复制 RBM 开发者控制台的功能。对于运营自己的广告系列平台并希望将 RBM 无缝集成为渠道的集合商家和合作伙伴来说,此 API 尤其有用。
RBM Management API 是一种 REST API,可让开发者以编程方式执行以下操作:
- 创建和修改 RBM 代理定义并上传素材资源
- 提交 RBM 代理以进行验证和发布
- 检索验证和发布信息
RBM Management API 会作为 RCS 扩展程序公开给 Google 的 Business Communications API。
如需更好地了解如何使用 RBM Management API,请下载 Java 或 JavaScript (node.js) 示例代码:
- 下载 Java 示例
- 下载 Node.js 示例
如需使用 RBM Management API 创建和发布代理,请按照以下步骤操作:
- 创建品牌。
- 在品牌中创建代理。
- 提交代理以进行验证。
- 提交代理以在一个或多个运营商处发布。
- 检查发布状态。
所有代理都属于一个品牌(商家、组织或群组)。您必须先创建一个自有品牌,然后才能创建代理。品牌只是一种组织方式,可帮助您将相关代理归为一组。
本页中的代码段摘自 Java 示例和 Node.js 示例。
品牌具有 和唯一标识符 。
此代码会返回新的品牌信息和分配给该品牌的唯一标识符:
您可以使用品牌的唯一标识符 () 检索品牌。
以下代码会返回品牌信息:
您可以检索到目前为止已创建的所有品牌的列表。
以下代码会返回您的所有品牌的列表:
您可以使用 操作更改品牌的显示名称:
以下代码会返回更新后的品牌信息:
所有代理都属于某个品牌(企业、组织或群组)。在创建代理之前,您必须先创建所有者品牌。品牌只是一种组织方式,可帮助您将相关客服人员归为一组
此页面上的代码段取自 Java 示例和 Node.js 示例。
如需创建 RBM 代理,您需要定义其基本信息。
此代码会返回新的代理信息以及分配给代理的唯一标识符:
您可以使用代理的唯一标识符 () 进行检索。
以下代码会返回代理信息:
必须进行品牌验证才能发布代理。您必须先提交验证信息,然后才能提交发布请求。请注意,您无需等待品牌审批即可发出发布请求;品牌审批是发布审批流程的一部分。
此代码会返回验证信息:
您可以查询代理的品牌验证状态。
此代码会返回验证状态:
您可以提交代理,以供一个或多个运营商发布。有些发布活动由 Google 管理,有些则由运营商直接管理。运营商管理的发布可能有额外的要求。如需了解详情,请参阅由 Google 管理的发布与运营商管理的发布。
首次发布代理之前,您需要提交验证信息。这样一来,Google、运营商或两者都可以向您的品牌联系人验证您是否有权代表他们管理代理。如需了解详情,请参阅品牌验证。
提交验证信息并完成发布前提条件后,您就可以提交发布请求了。
您可以提交代理,以供一个或多个运营商发布。必须在发布时提供已填写的发布调查问卷。
此代码会返回代理发布信息:
请注意, 已被弃用,我们很快就会将其移除。
可以检索代理的当前启动状态。
此代码会返回每个目标运营商的发布信息和发布状态:
请注意, 已被弃用,我们很快就会将其移除。
您可以通过检索当前发布信息并添加更多运营商来添加其他目标运营商。
此代码会返回更新后的发布信息:
开发者可以检索为品牌创建的所有代理的列表。
以下代码会返回品牌拥有的所有代理的列表:
出于安全考虑,您无法再删除 RBM 代理。请与 RBM 支持团队联系以寻求帮助。
默认情况下,通过 RBM Management API 创建的所有代理都使用单个 webhook 来接收通知。此合作伙伴级 webhook 是在 Business Communications 开发者控制台中配置的,适用于合作伙伴账号中的所有客服人员。
或者,您也可以使用 RBM Management API 配置代理级 webhook。如果您管理多个具有不同行为的代理,这可能是一个不错的选择。
本页中的代码段摘自 Java 示例和 Node.js 示例。
如需添加客服人员网络钩子集成,请先定义网络钩子的网址并定义一个验证令牌。然后,按照验证步骤配置该网络钩子。配置完成后,使用网址和令牌值调用 方法。如果该调用成功,您可以继续验证和处理传入消息。
以下代码会返回新的 webhook 对象:
您可以检索某个代理所属的所有 webhook 集成的列表。在实践中,RBM 代理只能有一个 webhook 集成。
以下代码会返回代理的 webhook 集成列表:
有了对集成的引用,就可以检索其详细信息。
以下代码会返回 webhook 集成详情:
您可以使用 webhook 的引用从智能体中移除 webhook:
系统会返回空对象:
版权声明:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符,请将相关资料发送至xkadmin@xkablog.com进行投诉反馈,一经查实,立即处理!
转载请注明出处,原文链接:https://www.xkablog.com/rfx/63418.html