创建您的第一个代理

前提条件

创建代理

本指南将介绍如何使用示例应用创建代理。该示例提供了一种快速探索代理功能的方法,并且可以作为您开发代理的起点。如果您想修改现有应用以包含代理,该示例可以为您的应用逻辑提供一个很好的模型。

在本快速入门中,您将执行以下操作:

  • 注册成为合作伙伴
  • 创建品牌和代理
  • (可选)与 Business Messages 小助手机器人进行对话,探索各项功能
  • 设置代理以发送和接收消息

如需在不使用示例的情况下创建代理,请参阅创建代理

注册成为合作伙伴

  1. 打开 Business Communications 开发者控制台
  2. Business Messages 下,点击 创建合作伙伴账号
  3. 输入您的合作伙伴信息:

    字段
    您的姓名 您的全名
    合作伙伴名称 您的组织名称
    合作伙伴网站 您的组织网站
    区域 您要托管 Business Messages 服务的区域
  4. 查看并接受 Business Messages 服务条款

  5. 点击创建

您现在已注册成为 Business Messages 合作伙伴。系统已为您创建一个新的 Google Cloud 项目,并启用了 Business Messages 和 Business Communications API。您无权访问此项目,它也不会干扰您的任何现有 Google Cloud 项目。

您现在可以使用 Business Messages 和 Business Communications API 了。

创建服务账号

  1. Business Communications 开发者控制台 首页上,点击 合作伙伴账号设置
  2. 在左侧导航栏中,点击服务账号
  3. 点击创建密钥 ,然后点击创建

    您的浏览器会下载该服务账号密钥。请将其存储在安全的位置。您稍后需要使用此密钥来部署 Web 应用,并在将来访问 Business Messages 和 Business Communications API。

创建品牌和代理

代理是品牌的对话代表,即与用户互动的对话实体。您需要创建品牌来代表商家,并创建代理,以便消费者可以通过对话方式与商家联系。

  1. 打开 Business Communications Developer Console ,然后使用您的 Business Messages Google 账号登录。
  2. 点击 Create agent
  3. 对于代理类型,请选择 Business Messages
  4. 输入品牌名称代理名称的值。
  5. 执行以下某项操作:
    • 如需体验与代理的对话并在对话中探索可用功能,请选择启用 Business Messages 小助手机器人
    • 如需自定义您的代理并使其准备好处理消息,请取消选择启用 Business Messages 小助手机器人
  6. 点击 Create agent

如果您启用了 Business Messages 小助手机器人,则可以立即发起对话。否则, 请继续设置代理以处理消息

使用 Business Messages 小助手机器人探索各项功能

借助 Business Messages 小助手机器人,您可以快速发起与代理的对话,以便体验平台提供的功能。创建第一个代理时,强烈建议您启用小助手机器人,但这不是必需的。

借助小助手机器人,您可以

  • 探索富媒体功能
  • 了解如何实现各项功能
  • 查找代理设置资源

小助手机器人启用后,会为您的代理收发消息;无需设置网络钩子。您需要先停用小助手机器人 ,然后才能设置网络钩子启用 Dialogflow 来处理用户消息。

与小助手机器人发起对话

启用 Business Messages 小助手机器人后,您就可以发起对话了。 代理创建后,系统会立即打开一个对话框,帮助您入门。

如需与小助手机器人互动,请在此对话框中执行以下步骤:

  1. 访问代理的测试网址。您可以通过多种方式完成此操作:

    • 点击 Android 按钮或 iOS 按钮。然后,使用相应的移动设备扫描二维码,并点击发布 。 或者,点击复制 Android 网址复制 iOS 网址 ,以复制代理的测试网址。
    • 点击发送 ,将网址发送到您的电子邮件地址。
  2. 在您的移动设备上打开相应网址。(iOS 设备需要安装 Google 地图 应用。)

停用小助手机器人

您需要先停用 Business Messages 小助手机器人,然后才能自定义代理并准备发布代理。

如需停用小助手机器人,请执行以下操作:

  1. 打开 Business Communications 开发者 控制台
  2. 选择您的代理。
  3. 在左侧导航栏中,点击集成
  4. 对于 Helper Bot ,点击 停用

停用小助手机器人后,它将不再为您的代理收发消息。现在,您可以设置代理来处理消息传递流程。

设置代理以处理消息

在本指南中,您将使用旨在处理用户消息的网络钩子将 Echo Bot 部署到 Google Cloud Platform (GCP)。

Echo Bot 是一个示例应用,可将消息回显给用户。借助它,您可以在与代理的对话中体验富媒体功能,例如建议的操作富媒体卡片。您还可以使用 Echo Bot 作为开发代理的起点。

您将完成以下步骤:

  • 将 Echo Bot 示例部署到 GCP
  • 为您的 Business Messages 合作伙伴账号配置网络钩子网址
  • 提供有关代理的基本信息

完成本指南后,您的代理将可以发送和接收消息。

将 Web 应用部署到 GCP

Business Messages 会将用户发送的消息转发到您基础架构中的 网络钩子 。在本指南中,您将把 Echo Bot 示例源代码部署到预配置的网络钩子。如果您已有可用于接收消息的 Web 基础架构,则可以在该 Web 服务上创建新的网络钩子,但您需要自行配置逻辑。如需了解详情,请参阅 设置合作伙伴级网络钩子

创建 Cloud 环境

您需要 Cloud 环境才能部署 Echo Bot 示例。

如需创建 GCP 项目作为 Cloud 环境,请按照以下步骤操作:

  1. 打开 Google Cloud 控制台项目选择器

    如果您从未创建过 Google Cloud 项目,则需要接受服务条款

  2. 点击创建项目

  3. 为新项目输入名称和位置

    • 系统会自动生成项目 ID,并显示在项目名称下方。
    • 位置 字段中,点击浏览 以显示项目的潜在位置。如果您找不到 Google Workspace 组织,则说明您未登录 Google Workspace 账号。您可以在没有组织的情况下创建项目,但某些功能会受到限制。如需了解详情,请参阅组织资源的优势
  4. 点击创建

  5. 点击菜单

  6. 点击结算

  7. 点击关联结算账号

  8. 创建新的结算账号,或将现有结算账号添加到项目。如需了解付款选项,请参阅 Google Cloud 免费计划功能

部署 Echo Bot 示例

  1. 安装 gcloud CLI。您将使用它将示例代码部署到 Google Cloud。
  2. 下载并解压缩 Echo Bot 示例 (Node.jsJavaPython)。

  3. 将您在 创建服务账号中下载的 JSON 凭据文件复制到示例的“resources”文件夹中 ,并将这些凭据重命名为“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
  4. 在终端中,导航到示例的 full_sample 目录。

  5. 在终端中运行以下命令以部署示例:

    Node.js

    gcloud config set project PROJECT_ID
    gcloud app create
    gcloud app deploy

    PROJECT_ID 是您在 创建 Cloud 环境中创建的项目的项目 ID。项目 ID 列在 Google Cloud 的项目信息中心内。

    Java

    gcloud config set project PROJECT_ID
    gcloud app create
    mvn appengine:deploy

    PROJECT_ID 是您在 创建 Cloud 环境中创建的项目的项目 ID。项目 ID 列在 Google Cloud 的项目信息中心内。

    Python

    gcloud config set project PROJECT_ID
    gcloud app create
    gcloud app deploy

    PROJECT_ID 是您在 创建 Cloud 环境中创建的项目的项目 ID。项目 ID 列在 Google Cloud 的项目信息中心内。

  6. 记下最后一个命令的输出中已部署应用的网址。 这是您的网络钩子网址的基础部分:

    Deployed service [default] to [https://PROJECT_ID.appspot.com]

设置网络钩子

现在 Echo Bot 已部署完毕,您需要指定一个由您 运营的网络钩子网址,以便开始 接收消息

  1. 在 Business Communications 开发者控制台中打开 账号设置
  2. 确保选择了正确的合作伙伴账号。
  3. 对于 Business Messages 网络钩子网址 ,点击 配置
  4. 对于网络钩子端点网址,输入应用的网址 +“/callback”。

    您的端点将采用以下格式: “https://PROJECT_ID.appspot.com/callback”。

    此端点在您部署到 GCP 的示例的应用逻辑中预定义。

  5. 在开发者控制台中,点击验证

    Business Messages 验证您的网络钩子后,对话框将关闭。

如需使用 Business Communications API 配置网络钩子,请参阅 示例:更新网络钩子网址

您可以使用 Business Messages 测试框架 来测试您的网络钩子是否成功响应 Business Messages 载荷。

输入代理信息

提供一些基本信息以完成代理设置。

  1. 打开 Business Communications 开发者 控制台
  2. 在左侧导航栏中,点击代理信息
  3. 您可以随意更新这些值,也可以使用以下建议:

    字段
    欢迎辞 欢迎与 Echo Bot 对话!
    隐私权政策 https://policies.google.com/privacy
  4. 点击保存

发起对话

如需与 Echo Bot 互动,请按照以下步骤操作:

  1. 打开 Business Communications 开发者 控制台
  2. 在左侧导航栏中,点击代理信息
  3. 代理测试网址 下,点击 Android 按钮或 iOS 按钮。
  4. 使用相应的移动设备扫描二维码,或点击复制 Android 网址复制 iOS 网址 ,以复制代理的测试网址。

    您还可以点击发送 ,将网址发送到您的电子邮件地址。

  5. 在您的移动设备上打开相应网址。(iOS 设备需要安装 Google 地图应用。)

代理的欢迎辞会向您问好。此时,您可以与 Echo Bot 互动。它会将您发送的消息回显给您。此外,您还可以通过发送特定字符串(“carousel”“card”“chips”)来调用富媒体功能。

后续步骤

现在,您已经创建了第一个代理,接下来可以详细了解 Business Messages 以及您还可以在该平台上执行哪些操作。