创建您的第一个代理

前提条件

创建代理

本指南将向您介绍如何使用示例应用创建代理。通过示例,您可以快速探索代理的功能,并以此为基础开发代理。如果您想要修改现有应用以添加代理,该示例为应用逻辑提供了一个良好的模型。

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

  • 注册为合作伙伴
  • 创建品牌和代理
  • (可选)在与 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 API 和 Business Communications API。

创建服务帐号

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

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

创建品牌和代理

代理是品牌的对话代表,即用户与的对话实体。您可以创建一个品牌来代表该商家,并创建代理,以便消费者可以与之对话。

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

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

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

借助 Business Messages 小助手机器人,您可以快速发起与代理的对话,以便体验平台提供的内容。启用小助手机器人是可选的,但我们强烈建议您在创建首个代理时启用。

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

  • 探索丰富的功能
  • 了解如何实现功能
  • 查找用于设置代理的资源

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

与小助手机器人对话

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

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

  1. 访问该代理的测试网址。您可以通过以下几种方式执行此操作:

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

停用小助手机器人

在自定义代理并为发布做好准备之前,您需要先停用 Business Messages 小助手机器人。

如需停用小助手机器人,请按以下步骤操作:

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

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

设置代理以进行消息处理

在本指南中,您将使用一个用于处理用户消息的网络钩子将 Echo 聊天机器人部署到 Google Cloud Platform (GCP)。

Echo Bot 是一个示例应用,用于将消息回显给用户。通过它,您可以在与代理的对话中尝试丰富的功能,例如建议的操作复合搜索卡。您还可以将 Echo Bot 用作开发代理的起点。

您需要完成以下步骤:

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

在本指南结束时,您的代理将可以收发消息。

将 Web 应用部署到 GCP

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

创建 Cloud 环境

您需要使用云端环境来部署 Echo Bot 示例。

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

  1. 打开 Google Cloud Console 项目选择器

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

  2. 点击创建项目

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

    • 系统会自动生成您的项目 ID,该 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 凭据文件复制到示例的资源文件夹中,然后将凭据重命名为“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 聊天机器人已部署,您需要指定您操纵的网络钩子网址,以开始接收消息

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

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

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

  5. 在 Play 管理中心内,点击验证

    Business Messages 验证您的 webhook 后,对话框将关闭。

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

您可以使用 Business Messages 测试框架来测试 webhook 是否成功响应 Business Messages 载荷。

输入代理信息

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

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

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

发起对话

如需与 Echo 聊天机器人互动,请按以下步骤操作:

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

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

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

代理的欢迎辞向您致以诚挚的问候。此时,您可以与 Echo 聊天机器人进行交互。它会回显您发回的消息。此外,您还可以通过发送特定字符串(“轮播”、“卡片”、“条状标签”)调用丰富的功能。

后续步骤

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