集成 Google 日历
部署 Google 日历集成功能,通过任何设备或内联网安排日历活动并列出用户的活动和办公时间。此集成提供了以下四个使用案例:
注意:
我们提供了两个 Google 日历集成模板供您使用。基于 Java 的模板提供了更多用例,包括通知。这属于目录中的 “ 集成 ” 类别。设置说明紧跟在下面。我们还在目录中的 Citrix Labs 类别下有一个新的基于 HTTP 的模板。这种集成更加灵活,并为配置缓存的数据结构提供了更多功能。有关更多信息,请参阅 Citrix Labs Google 日历集成。
有关适用于 Google 日历的开箱即用微应用的全面详细信息,请参阅 使用 Google 日历微应用。
注意:
我们希望得到你的反馈!请在使用 此预览集成模板时提供反馈 。对于任何问题,我们的团队还将每天监控我们的 专门论坛 。
查看必备项
这些先决条件假定您管理组织的 Google 日历实例以设置集成。
- 此集成需要一个专用的 Google 帐户,该帐户用于将日历数据与 Workspace 同步。此账户必须具有管理员 API 权限 User/Read 或包含此权限的标准管理员角色。
- 如果托管 Workspace 的内部服务器位于防火墙后面,则必须允许使用端口 443 访问主机名 www.google.com,以便 Workspace 可以连接。
- 获取新的 oauth2 client_id 和 client_secret 并定义客户端应用程序的范围。
- 将 Citrix Gateway 配置为支持 Google 日历的单点登录,这样一旦用户登录,他们将自动重新登录,而无需再次输入凭据。按照 Google CalendarSingle Sign-On 配置中的说明进行操作。有关配置 SSO 的更多信息,请参阅 Citrix Gateway 服务。
要在 Citrix Workspace 微应用中添加 Google 日历集成,您必须具备以下详细信息:
- OAUTH 私钥 JSON
- 模拟管理员用户帐户
对于 Google 日历的用户同意 (3LO) 身份验证:
- 客户端 ID
- 客户端密钥
注意:
我们建议您始终使用 OAuth 2.0 作为可用的服务身份验证方法。OAuth 2.0 可确保您的集成符合配置的微应用的最高安全性合规性。
将 Citrix Gateway 配置为支持 Google Meet 的单点登录,这样一旦用户登录,他们将自动重新登录,而无需再次输入凭据。有关配置 SSO 的更多信息,请参阅 Citrix Gateway 服务 https://docs.citrix.com/en-us/citrix-gateway-service/。
集成需要定期访问您的 Google 日历实例,因此我们建议您创建一个专用的用户帐号。此账户必须具有以下权限:
-
服务帐户所需的权限:完全管理员权限
-
服务帐号所需的范围:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/admin.directory.user
可以对特定资源发出的 API 请求数量有限,因此我们建议您执行以下操作:
- 谷歌 API 限制表单链接: https://developers.google.com/calendar/pricing
- 推荐计划:企业增强版
创建一个新的服务帐号
在这里登录: https://workspace.google.com/intl/en/pricing.html
如何启用 API
默认情况下,Google 日历 API 可以通过网络服务访问付费帐户。
配置 OAuth
- 使用服务帐号登录以: https://console.cloud.google.com
- 在左侧菜单中选择 API 和服务 。
- 从导航菜单的项目列表中选择相应的项目。
- 选择 启用 API 和服务,然后从 Google Workspace 启用所有必需的 API。推荐的 API:Google 日历 API 和管理 SDK。
- 返回 API 和服务 页面,然后在左侧 屏幕上选择 OAuth 同意 屏幕。
- 根据您的要求选择 用户类型 (我们建议: 内部),然后选择 创建。
-
填写必填字段,包括 服务帐户所需的范围,然后保存详细信息。这些是必需的范围:
配置回调 URL 服务器
将 OAuth 服务器配置为通过 Google 日历集成读取数据。
- 使用服务帐号登录以: https://console.cloud.google.com
- 在左侧菜单中选择 API 和服务 。
- 从导航菜单的项目列表中选择相应的项目。
- 在左侧屏幕上选择 凭据 。
- 选择 创建凭据,然后从列表中选择 OAuth 客户端 ID 。
- 从 应用程序类型列表中选择 Web应用程序,然后输入名称。
- 在 授权的重定向URI 下选择添加 URI。
-
在 UR I 字段中输入此集成的以下授权重定向 URL:
https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
- 选择 Create(创建)。
- 复制并保存屏幕上显示的 clientId 和 S ecret 。配置集成时,可以将这些详细信息用于 服务身份验证 。
配置回调 URL 客户端
配置 OAuth 客户端以通过 Google 日历集成写回数据。
- 使用服务帐号登录以: https://console.cloud.google.com
- 在左侧菜单中选择 API 和服务 。
- 从导航菜单的项目列表中选择相应的项目。
- 在左侧屏幕上选择 凭据 。
- 选择 创建凭据,然后从列表中选择 OAuth 客户端 ID 。
- 从 应用程序类型列表中选择 Web应用程序,然后输入名称。
- 在 授权的重定向URI 下选择添加 URI。
-
在 UR I 字段中输入此集成的以下授权重定向 URL:
https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback
- 选择 Create(创建)。
- 复制并保存屏幕上显示的 clientId 和 S ecret 。配置集成时,可以将这些详细信息用于 服务操作身份验证 。
添加 Google 日历集成
请按照以下步骤设置 Google 日历集成:
-
在概述页面中,选择 入门。
此时将打开 “管理集成” 页面。
- 选择 添加新集成,然后 从 Citrix 提供的模板中添加新集成。
- 从目录的集成类别中选择 Google 日历磁贴。
-
输入集成的名称。
- 输入在前面的过程中收集的 服务身份验证 参数。
- 复制并粘贴整个 OAUTH 私钥 JSON。复制整个密钥,包括 {} 括号。
- 输入 模拟管理员用户。
- 选择用 户身份验证 方法。
- 管理
- 用户
- 用户同意 (3LO) 资源所有者允许访问。
- 对于用户同意 (3LO),输入您在先决条件过程中收集的客户 端 ID和客户端密钥 。
- 输入 连接器参数。
- 要加载的即将发生的事件的天数 -定义缓存即将到来的日历事件以发送通知的时间长度。
- 要加载的过去事件的天数 -定义缓存过去事件的时间长度。
- 如有必要,选择 “ 加载用户日历事件 ” 单选按钮。
- 线程计数 -输入一个值。
- 选择添加。
现在,您已准备好设置和运行第一次数据同步。由于可以将大量数据从集成应用程序提取到微应用平台,因此我们建议您使用 “ 表 ” 页面筛选实体以进行首次数据同步,以加快同步速度。有关更多信息,请参阅验证所需实体。有关同步规则、不符合其计划的同步和否决规则的完整信息,请参阅同步数据。
有关 API 端点和表实体的更多详细信息,请参阅 Google 日历连接器规范。
使用 Google 日历微应用
我们的 Google 日历集成带有以下预配置的开箱即用微应用。
日历事件: 创建和预览事件。
通知或页面 | 用例工作流 |
---|---|
活动提醒通知 | 活动即将到来时,所有订阅者都会收到提醒通知。 |
“所有活动” 页 | 提供即将举行的活动的个性化列表。 |
“创建活动” 页 | 提供用于添加包含详细信息的新事件的表单。 |
活动详情页 | 提供活动的详细视图,包括来宾列表。 |
Citrix Labs Google 日历集成
部署 Google 日历集成功能,通过任何设备或内联网安排日历活动并列出用户的活动和办公时间。
注意:
添加新集成时,此集成模板处于 预览 模板中,在产品中显示的可用模板列表中标记为 “预览”。在预览版中,没有提供支持的承诺,开发人员会尽最大努力提供支持。预览集成模板是为了测试和验证而共享的。我们不建议在生产环境中部署它们。有关更多信息,请参阅 微应用集成模板的维护声明。
此集成提供了以下四个使用案例:
- 使用 Create Event 微应用,用户可以主持一次性或定期会议、添加被邀请者以及选择不同的时区。微应用还会向所有受邀者发送一封电子邮件,其中包含相应的事件对象,以便轻松集成日历。
- 使用 “我的日历(本月)” 微应用程序,用户可以查看当月所有即将发生的事件。
- 使用 “我的办公时间” 微应用,用户可以设置虚拟办公时间或列出用户当月的所有办公时间。
查看必备项
这些先决条件假定管理员是组织的 Google 日历集成设置的一部分。此 Google 日历管理员帐号必须具有完全读取用户信息的权限。在与 Google 日历设置此集成后,您需要以下工件才能在 Citrix Workspace 微应用中添加集成:
- 基本 URL:
https://www.googleapis.com/
- 令牌 URL:
https://oauth2.googleapis.com/token
- 授权 URL:
https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&prompt=consent
- CLIENT ID:客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。
- SECRET:客户端密钥是设置目标应用程序集成时发出的唯一字符串。
注意:
我们建议您始终使用 OAuth 2.0 作为可用的服务身份验证方法。OAuth 2.0 可确保您的集成符合配置的微应用的最高安全性合规性。
将 Citrix Gateway 配置为支持 Google Meet 的单点登录,这样一旦用户登录,他们将自动重新登录,而无需再次输入凭据。有关配置 SSO 的更多信息,请参阅 Citrix Gateway 服务 https://docs.citrix.com/en-us/citrix-gateway-service/。
集成需要定期访问您的 Google 日历实例,因此我们建议您创建一个专用的用户帐号。此账户必须具有以下权限:
-
服务帐户所需的权限:完全管理员权限
-
服务帐号所需的范围:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/admin.directory.user
可以对特定资源发出的 API 请求数量有限,因此我们建议您执行以下操作:
- 谷歌 API 限制表单链接: https://developers.google.com/calendar/pricing
- 推荐计划:企业增强版
创建一个新的服务帐号
在这里登录: https://workspace.google.com/intl/en/pricing.html
启用 API
默认情况下,Google 日历 API 可以通过网络服务访问付费帐户。
配置 OAuth
- 使用服务帐号登录以: https://console.cloud.google.com
- 在左侧菜单中选择 API 和服务 。
- 从导航菜单的项目列表中选择相应的项目。
- 选择 启用 API 和服务,然后从 Google Workspace 启用所有必需的 API。推荐的 API:Google 日历 API 和管理 SDK。
- 返回 API 和服务 页面,然后在左侧 屏幕上选择 OAuth 同意 屏幕。
- 根据您的要求选择 用户类型 (我们建议: 内部),然后选择 创建。
-
填写必填字段,包括 服务帐户所需的范围,然后保存详细信息。这些是必需的范围:
配置回调 URL 服务器
将 OAuth 服务器配置为通过 Google 日历集成读取数据。
- 使用服务帐号登录以: https://console.cloud.google.com
- 在左侧菜单中选择 API 和服务 。
- 从导航菜单的项目列表中选择相应的项目。
- 在左侧屏幕上选择 凭据 。
- 选择 创建凭据,然后从列表中选择 OAuth 客户端 ID 。
- 从 应用程序类型列表中选择 Web应用程序,然后输入名称。
- 在 授权的重定向URI 下选择添加 URI。
-
在 UR I 字段中输入此集成的以下授权重定向 URL:
https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
- 选择 Create(创建)。
- 复制并保存屏幕上显示的 clientId 和 S ecret 。配置集成时,可以将这些详细信息用于 服务身份验证 。
配置回调 URL 客户端
配置 OAuth 客户端以通过 Google 日历集成写回数据。
- 使用服务帐号登录以: https://console.cloud.google.com
- 在左侧菜单中选择 API 和服务 。
- 从导航菜单的项目列表中选择相应的项目。
- 在左侧屏幕上选择凭据。
- 选择 创建凭据,然后从列表中选择 OAuth 客户端 ID 。
- 从 应用程序类型列表中选择 Web应用程序,然后输入名称。
- 在 授权的重定向URI 下选择添加 URI。
-
在 UR I 字段中输入此集成的以下授权重定向 URL:
https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback
- 选择 Create(创建)。
- 复制并保存屏幕上显示的 clientId 和 S ecret 。配置集成时,可以将这些详细信息用于 服务操作身份验证 。
将 Citrix Labs 集成添加到 Citrix Workspace 微应用
将 “预览 Google 日历” 集成添加到 Citrix Workspace 微应用程序以连接到您的应用程序。这样可以提供带有预配置通知和操作的开箱即用的微应用程序,这些通知和操作可在工作区中使用
请按照以下步骤进行操作:
- 在 微应用集成 页面中,选择 添加新集成,然后 从 Citrix 提供的模板中添加新集成。
- 从目录的 “ 预览 ” 类别中选择 Google 日历磁贴。
- 输入集成的名称。
- 输入实例 基本 URL:
https://www.googleapis.com/
。 - 从 图标 库中选择用于集成的图标,或将其保留为默认图标。
- 输入实例 基本 URL:
-
在 服务身份验证下,从身份验证 方法 菜单中选择 OAuth 2.0 ,然后填写身份验证详细信息。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。使用 OAuth 2.0 安全协议为委派访问生成请求/授权令牌。建议您始终使用 OAuth 2.0 作为可用的服务身份验证方法。OAuth 2.0 可确保您的集成符合配置的微应用的最大安全合规性。
- 从授权类型菜单中选择授权码。这会授予客户端用来交换访问令牌的临时代码。该代码从授权服务器获取,您可以在其中查看客户端请求的信息。只有这种授权类型才能启用安全的用户模拟。这将显示您在注册应用程序时使用的 回调 URL。
- 从令牌授权菜单中选择请求正文。
-
授权 URL 是预先填写的:
https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&prompt=consent
-
令牌 URL 已预先填充:
https://oauth2.googleapis.com/token
- 确保为 Scope 输入以下内容:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/admin.directory.user
- 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您在配置 OAuth 服务器时收集此密钥和密钥。您需要添加在集成配置页面上看到的 回调 URL 。
- 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。
-
在服务操作身份验证下,启用在操作使用单独的用户身份验证开关。服务操作身份验证在服务操作级别进行身份验证。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。
- 从身份验证方法菜单中选择 OAuth 2.0,然后填写身份验证详细信息。
- 从授权类型菜单中选择授权码。这会授予客户端用来交换访问令牌的临时代码。该代码从授权服务器获取,您可以在其中查看客户端请求的信息。只有这种授权类型才能启用安全的用户模拟。这将显示您在注册应用程序时使用的 回调 URL。
- 从令牌授权菜单中选择请求正文。
-
授权 URL 是预先填写的:
https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&prompt=consent
-
令牌 URL 已预先填充:
https://oauth2.googleapis.com/token
- 确保为 Scope 输入以下内容:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
- 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您在配置 OAuth 客户端时收集此密钥和密钥。您需要添加在集成配置页面上看到的 回调 URL 。
- 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。
- 启用 启用请求速率限制 开关。在 请求数 中输入 100 ,在 时间间隔 中输入 1 分钟。
-
(可选)启用 日志记录 切换以保留 24 小时的日志记录以用于支持目的。
- 选择 保存 以继续。
- 在 OAuth 授权下,选择 授权 以使用您的服务帐户登录。出现一个带有 Google 登录屏幕的弹出窗口。
- 输入您的服务帐户用户名和密码,然后选择 登录。
- 选择 接受。
微应用集成 页面随即打开,其中包含您添加的集成及其微应用。在这里,您可以添加另一个集成,继续设置开箱即用的微应用,或为此集成创建新的微应用。
现在,您已准备好设置和运行第一次数据同步。由于可以将大量数据从集成应用程序提取到微应用平台,因此我们建议您使用 “ 表 ” 页面筛选实体以进行首次数据同步,以加快同步速度。有关更多信息,请参阅验证所需实体。有关同步规则、不符合其计划的同步和否决规则的完整信息,请参阅同步数据。
注意:
建议将 “完全同步” 时间间隔设置为 “ 每周 ”,以便从微应用平台以及随后从用户日历中删除已取消或删除的事件。
有关 API 端点和表实体的更多详细信息,请参阅 预览 Google 日历连接器规范。
使用 Labs Google 日历微应用
现有的应用程序集成随现成的微应用程序一起提供。从这些微应用开始,然后根据您的需求自定义它们。
注意:
由于当前可用的时区是在 “ 创建事件”、“ 我的办公时 间” 和 “ 我的日历(当月) ” 微应用中硬编码的,因此添加任何其他时区都需要管理员手动添加它们。
创建活动: 根据用户偏好安排活动。
通知或页面 | 用例工作流 |
---|---|
“创建活动” 页 | 提供一个表单来安排具有以下详细信息的活动:活动标题、Google Meet Video 链接、开始和结束时间、时区、重复(一次、每日、每周、每月)、说明、地点和活动出席者。 |
我的日历(本月): 查看即将到来的本月的一次性和重复性日历事件的列表以及编辑事件的功能。
通知或页面 | 用例工作流 |
---|---|
事件通知详细信息页 | 显示活动的所有适当详细信息的详细信息页面和 立即加入 按钮以开始会议。用户还可以通过选择 “ 打开我的日历” 来重定向到 Google 日历。 |
加载事件页面 | 通过刷新列表按钮 刷新 列表,为用户提供可用的一次性和重复性日历事件的列表。用户可以通过单击列表中可用的事件来查看事件详细信息。 |
列出活动页面 | 提供可供用户使用的一次性和周期性日历事件的最新列表。用户可以通过单击列表中可用的事件来查看事件详细信息。 |
“活动详情” 页 | 详情页面,其中显示了活动的所有适当详细信息。用户可以通过选择加入 活动来开始/加入 会议,用户可以通过选择 打开我的日历重定向到 Google 日历。 |
全天活动详情页 | 详情页面显示全天活动的所有适当详情。用户可以通过选择加入 活动来启动(加入 )会议,用户可以通过选择 打开我的日历重定向到 Google 日历。 |
编辑 OneTime 事件页 | 用于编辑一次性事件的表单页面。 |
“编辑定期事件” 页 | 用于编辑现有重复事件的表单页面。 |
我的办公时间: 创建、编辑和查看办公时间。
注意:
刷新按钮用于将缓存与最新数据同步,而不是完全同步或增量同步。
通知或页面 | 用例工作流 |
---|---|
“创建办公时间” 页 | 提供使用以下详细信息创建办公时间的表单:开始时间和结束时间、时区、周期(一次、每日、每周、每月)。 |
“我的办公时间列表” 页 | 提供可用的用户办公时间列表,并带有 刷新列表/加载我的工作时间 按钮来更新/刷新列表。用户可以通过选择添加办公时间来 添加办公时间。 |
“编辑我的办公时间” 页 | 用于编辑用户办公时间的表单页面。 |