将搜索微件添加到网页

本页介绍了如何使用搜索微件向网站添加搜索功能。

准备工作

在将搜索微件添加到网页之前，请务必配置您的 搜索微件，首先是配置搜索的结果 微件。请注意，您无法调整 网页中搜索微件的样式。

过程

向网页添加搜索微件的步骤因您选择的授权类型而异：

• 授权令牌：微件使用由 代码库您必须拥有自己的服务器，才能生成令牌。该身份验证令牌用于代表用户或服务账号进行 API 调用。生成身份验证令牌时，请使用 OAuth 范围 https://www.googleapis.com/auth/cloud-platform。

  • 对于与服务账号的服务器到服务器互动：请参阅授权文档中的为服务器到服务器应用使用 OAuth 2.0。

  • 对于 JavaScript Web 应用：请参阅授权文档中的适用于客户端 Web 应用的 OAuth 2.0。

  注意：如果您选择了员工身份池来控制对应用数据的访问权限，请为员工身份联合获取短期令牌。

• 公开访问：该 widget 不会限制哪些人可以从搜索查询中获得结果。

添加使用授权令牌的 widget

1. 在 Google Cloud 控制台中，前往 Agent Builder 页面。

   Agent Builder

2. 点击要修改的应用的名称。

3. 点击 Integration（集成）。

4. 点击微件标签页。

5. 选择基于 JWT 或 OAuth 作为 widget 授权类型。

6. 为微件页面指定域名：

   1. 输入将显示该微件的页面的域名。

      例如，如果您要将微件复制到 example.com/ai.html和cymbal.example.com/search.html，请输入 example.com 用作网域。如果您只希望该微件在子网域中的某个网页上运行，请输入 cymbal.example.com。

      如果您想在本地主机上测试该 widget，请输入 localhost。

   2. 点击添加。

7. 针对要显示该微件的每个网域重复第 6 步。

8. 点击保存。

9. 复制将以下代码复制到您的 Web 应用部分中提供的代码段。

10. 在您的代码库中，生成授权令牌。

    注意：如果您选择了员工身份池来控制对应用数据的访问权限，请为员工身份联合获取短期令牌。

11. 要将授权令牌传递给微件，请使用第二个代码段， "// Set authorization token提供的 复制以下代码 添加到您的 Web 应用部分，然后将文本 <JWT or OAuth token provided by you backend> 替换为您的授权令牌。

12. 定期设置新令牌，方法是在 当前令牌过期。

添加具有公共访问权限的微件

1. 在 Google Cloud 控制台中，前往 Agent Builder 页面。

   Agent Builder

2. 点击要修改的应用的名称。

3. 点击 Integration（集成）。

4. 点击 Widget（微件）标签页。

5. 选择公开访问作为 widget 授权类型。

6. 指定微件页面的域名：

   1. 输入将显示该微件的页面的域名。

      例如，如果您要将该微件复制到网页 example.com/ai.html 和 cymbal.example.com/search.html，请输入 example.com 作为网域。如果您只希望该微件在子网域中的网页上运行，请输入 cymbal.example.com。

      如果要在本地主机上测试 widget，请输入 localhost。

   2. 点击添加。

7. 针对要显示该微件的每个网域重复第 6 步。

8. 点击保存。

9. 复制将以下代码复制到您的 Web 应用部分，然后将代码段粘贴到您的网页中。