本页介绍了如何使用搜索微件向网站添加搜索功能。
准备工作
在向网页添加搜索微件之前,请务必先配置搜索微件,具体方法请参阅为搜索微件配置结果。请注意,您无法调整网页中搜索微件的样式。
过程
向网页添加搜索微件的步骤因您选择的授权类型而异:
授权令牌:该微件使用代码库提供的 JWT 或 OAuth 令牌。您必须拥有自己的服务器,才能使用该服务器生成令牌。该身份验证令牌用于代表用户或服务账号进行 API 调用。生成身份验证令牌时,请使用 OAuth 范围
https://www.googleapis.com/auth/cloud-platform
。对于与服务账号的服务器到服务器互动:请参阅授权文档中的为服务器到服务器应用使用 OAuth 2.0。
对于 JavaScript Web 应用:请参阅授权文档中的适用于客户端 Web 应用的 OAuth 2.0。
公开访问:该 widget 不会限制哪些人可以从搜索查询中获得结果。
添加使用授权令牌的 widget
在 Google Cloud 控制台中,前往 Agent Builder 页面。
点击要修改的应用的名称。
点击集成。
点击 Widget(微件)标签页。
选择基于 JWT 或 OAuth 作为 widget 授权类型。
指定微件页面的域名:
输入将显示该微件的网页的域名。
例如,如果您要将该微件复制到网页
example.com/ai.html
和cymbal.example.com/search.html
,请输入example.com
作为网域。如果您只希望该微件在子网域中的某个网页上运行,请输入cymbal.example.com
。如果您想在本地主机上测试该 widget,请输入
localhost
。点击添加。
针对要显示该微件的每个网域重复第 6 步。
点击保存。
复制将以下代码复制到您的 Web 应用部分中提供的代码段。
在您的代码库中,生成授权令牌。
如需将授权令牌传递给微件,请使用将以下代码复制到您的 Web 应用部分中提供的第二个代码段“
// Set authorization token
”,并将文本<JWT or OAuth token provided by you backend>
替换为授权令牌。在当前令牌过期之前,通过重复上一步来定期设置新的令牌。
添加具有公开访问权限的 widget
在 Google Cloud 控制台中,前往 Agent Builder 页面。
点击要修改的应用的名称。
对于公开访问权限,请确保搜索应用未与任何受访问权限控制的数据存储区相关联。
点击集成。
点击 Widget(微件)标签页。
选择公开访问作为 widget 授权类型。
指定微件页面的域名:
输入将显示该微件的网页的域名。
例如,如果您要将该微件复制到网页
example.com/ai.html
和cymbal.example.com/search.html
,请输入example.com
作为网域。如果您只希望该微件在子网域中的网页上运行,请输入cymbal.example.com
。如果您想在本地主机上测试该 widget,请输入
localhost
。点击添加。
针对要显示该微件的每个网域重复第 6 步。
点击保存。
复制将以下代码复制到您的 Web 应用部分中提供的代码段,然后将该代码段粘贴到您的网页中。