前提条件
- 如果您是在 2022 年 3 月 7 日之前注册的合作伙伴账号,则需要启用 Business Messages API。请参阅启用 Business Communications API 和 Business Messages API。
创建代理
本指南将向您逐步介绍如何使用示例应用创建代理。该示例提供了一种探索代理功能的快速方法,可作为开发代理的着手点。如果您想要修改现有应用以添加代理,该示例可为您的应用逻辑提供一个良好的模型。
在本快速入门中,您将执行以下操作:
- 注册为合作伙伴
- 创建品牌和代理
- (可选)使用 Business Messages 小助手机器人在对话中探索功能
- 设置代理以发送和接收消息
如需在不使用示例的情况下创建代理,请参阅创建代理。
注册为合作伙伴
- 打开 Business Communications 开发者控制台。
- 在 Business Messages 下方,点击创建合作伙伴账号。
输入您的合作伙伴信息:
字段 价值 您的姓名 您的全名 合作伙伴名称 您的组织名称 合作伙伴网站 您的组织网站 区域 您要托管 Business Messages 服务的区域 查看并接受 Business Messages 服务条款。
点击创建。
您现在已注册为 Business Messages 合作伙伴。系统已为您创建新的 Google Cloud 项目,并启用 Business Messages API 和 Business Communications API。您无权访问此项目,并且不会干扰您的任何现有 Google Cloud 项目。
现在,您可以访问 Business Messages API 和 Business Communications API。
创建服务账号
- 在 Business Communications 开发者控制台首页,点击合作伙伴帐号设置。
- 在左侧导航栏中,点击服务帐号。
点击创建密钥,然后点击创建。
您的浏览器会下载服务账号密钥。将其存储在安全位置。您稍后会用到此密钥来部署 Web 应用以及访问 Business Messages API 和 Business Communications API。
创建品牌和代理
代理是品牌的对话表示形式,品牌是指用户与之互动的对话实体。您可以创建一个品牌来代表商家并创建代理,以便消费者可以通过对话方式与之建立联系。
- 打开 Business Communications 开发者控制台,然后使用您的 Business Messages Google 账号登录。
- 点击创建代理。
- 对于代理类型,请选择 Business Messages。
- 输入品牌名称和代理名称的值。
- 执行以下某项操作:
- 如需体验与代理的对话,您可以在其中探索可用功能,请选择启用 Business Messages 小助手机器人。
- 如需自定义您的代理并使其准备好处理消息,请取消选择启用 Business Messages 小助手机器人。
- 点击创建代理。
如果您启用了 Business Messages 小助手机器人,则可以立即发起对话。否则,请继续设置代理以进行消息处理。
使用 Business Messages 小助手机器人探索功能
借助 Business Messages 小助手机器人,您可以快速发起与代理的对话,以便体验该平台提供的功能。启用小助手机器人是可选操作,但强烈建议您在创建第一个代理时启用。
借助小助手机器人,您可以
- 探索丰富功能
- 了解如何实现功能
- 查找用于代理设置的资源
启用小助手机器人后,它可以为您的代理收发消息;不需要 webhook。您需要先停用小助手机器人,然后才能设置网络钩子或启用 Dialogflow 来处理用户消息。
与小助手机器人对话
启用 Business Messages 小助手机器人后,您就可以发起对话。 创建代理后,系统会立即打开一个对话框,帮助您开始操作。
如需与小助手机器人互动,请在此对话框中执行以下步骤:
访问代理的测试网址。您可以通过以下几种方式进行操作:
- 点击 Android 按钮或 iOS 按钮。然后,使用相应的移动设备扫描该二维码,并点击启动。或者,点击复制 Android 网址或复制 iOS 网址以复制代理的测试网址。
- 点击发送,将网址发送到您的电子邮件地址。
在您的移动设备上打开相应网址。(iOS 设备需要安装 Google 地图应用。)
停用小助手机器人
您需要先停用 Business Messages 小助手机器人,然后才能自定义代理并使其做好发布准备。
如需停用小助手机器人,请执行以下操作:
- 打开 Business Communications 开发者控制台。
- 选择您的代理。
- 在左侧导航栏中,点击集成。
- 对于小助手机器人,请点击停用。
停用小助手机器人后,它将不再为您的代理收发消息。现在,您可以设置代理来处理消息传递流程。
设置代理以进行消息处理
在本指南中,您将使用专为处理用户消息设计的 webhook,将 Echo 聊天机器人部署到 Google Cloud Platform (GCP)。
Echo Bot 是一个示例应用,可将消息回显给用户。借助此 API,您可以在与代理的对话中试用丰富的功能,例如建议操作和复合搜索卡。您还可以将 Echo Bot 作为开发代理的基础。
您将完成以下步骤:
- 将 Echo Bot 示例部署到 GCP
- 为您的 Business Messages 合作伙伴账号配置网络钩子网址
- 提供有关代理的基本信息
学完本指南后,您的代理就可以发送和接收消息了。
将 Web 应用部署到 GCP
Business Messages 将用户的消息转发到您基础架构中的网络钩子。在本指南中,您会将 Echo Bot 示例源代码部署到预配置的网络钩子。如果您已有可用于接收消息的 Web 基础架构,则可以在该 Web 服务上创建新的 Webhook,但需要自行配置逻辑。如需了解详情,请参阅设置合作伙伴级网络钩子。
创建 Cloud 环境
您需要一个云环境来部署 Echo Bot 示例。
如需创建 GCP 项目作为云环境,请按以下步骤操作:
-
如果您从未创建过 Google Cloud 项目,则需要接受《服务条款》。
点击创建项目。
为新项目输入名称和位置
- 项目 ID 是自动生成的,并显示在项目名称下方。
- 在位置字段中,点击浏览以显示项目的可能位置。如果您找不到自己的 Google Workspace 组织,则表示您尚未登录 Google Workspace 帐号。您也可以在没有组织的情况下创建项目,但部分功能会受到限制。如需了解详情,请参阅组织资源的优势。
点击创建。
点击
菜单。点击结算。
点击关联结算帐号。
创建新结算账号,或将现有结算账号添加到项目。请参阅 Google Cloud 免费计划功能,了解付款方式。
部署 Echo Bot 示例
- 安装 gcloud CLI。您将使用此文件将示例代码部署到 Google Cloud。
将您在创建服务帐号步骤中下载的 JSON 凭据文件复制到示例的资源文件夹中,然后将凭据重命名为“bm-agent-service-account-credentials.json”。此凭据文件的路径取决于您下载的示例。
Node.js
./bm-nodejs-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json
Java
./bm-java-echo-bot/full_sample/src/main/resources/bm-agent-service-account-credentials.json
Python
./bm-python-echo-bot/full_sample/resources/bm-agent-service-account-credentials.json
在终端中,导航到示例的 full_sample 目录。
在终端中运行以下命令以部署示例:
Node.js
gcloud config set project PROJECT_ID
gcloud app create
gcloud app deploy
PROJECT_ID 是您在创建 Cloud 环境中创建的项目的 ID。Google Cloud 的项目信息中心内会列出项目 ID。
Java
gcloud config set project PROJECT_ID
gcloud app create
mvn appengine:deploy
PROJECT_ID 是您在创建 Cloud 环境中创建的项目的 ID。Google Cloud 的项目信息中心内会列出项目 ID。
Python
gcloud config set project PROJECT_ID
gcloud app create
gcloud app deploy
PROJECT_ID 是您在创建 Cloud 环境中创建的项目的 ID。Google Cloud 的项目信息中心内会列出项目 ID。
记下最后一个命令的输出中已部署应用的网址。 这是您的网络钩子网址的基础:
Deployed service [default] to [https://PROJECT_ID.appspot.com]
设置网络钩子
在部署 Echo Bot 后,您需要指定(您操作的)网络钩子网址以开始接收消息。
- 在 Business Communications 开发者控制台中打开帐号设置。
- 请确保选择了正确的合作伙伴账号。
- 在 Business Messages 网络钩子网址部分,点击配置。
对于网络钩子端点网址,输入应用的网址 +“/callback”。
您的端点将采用以下格式:“https://PROJECT_ID.appspot.com/callback”。
此端点在您部署到 GCP 的示例的应用逻辑中预定义。
在 Developer Console 中,点击验证。
Business Messages 验证您的 webhook 后,对话框将关闭。
如需使用 Business Communications API 配置您的网络钩子,请参阅示例:更新网络钩子网址。
您可以使用 Business Messages 测试框架来测试网络钩子是否成功响应 Business Messages 载荷。
输入代理信息
提供一些基本信息以完成代理设置。
- 打开 Business Communications 开发者控制台。
- 在左侧导航栏中,点击代理信息。
您可以视需要更新这些值,或采用以下建议:
字段 价值 欢迎辞 欢迎与 Echo Bot 对话! 隐私权政策 https://policies.google.com/privacy 点击保存。
发起对话
如要与 Echo Bot 互动,请按以下步骤操作:
- 打开 Business Communications 开发者控制台。
- 在左侧导航栏中,点击代理信息。
- 在代理测试网址下,点击 Android 按钮或 iOS 按钮。
使用相应的移动设备扫描二维码,或点击复制 Android 网址或复制 iOS 网址以复制代理的测试网址。
您也可以点击发送,将网址发送到您的电子邮件地址。
在您的移动设备上打开相应网址。(iOS 设备需要安装 Google 地图应用。)
代理的欢迎辞会向您致以问候。此时,您就可以与 Echo Bot 互动了。它会回显您发回的消息。此外,您还可以通过发送特定字符串来调用丰富的功能:“轮播”“卡片”“条状标签”。
后续步骤
现在您已经创建了第一个代理,接下来可以详细了解 Business Messages 以及您还可以在该平台上执行哪些其他操作。
详细了解 Business Messages 的运作方式。
查看如何接收消息,修改 Echo Bot 并使用您的业务逻辑进行响应。