创建嵌入网址

版本 4.0.23.4

创建嵌入网址

创建作为 Looker 用户进行此 API 调用的嵌入网址。(“嵌入为我”) 此嵌入网址随后可用于在“由 Looker 提供支持”(PBL) Web 应用中实例化 Looker 嵌入会话。

这与私有嵌入 (https://cloud.google.com/looker/docs/r/admin/embed/private-embed) 类似。用户已登录该 API,并未登录网页界面进行身份验证,因此能够进行此调用。但是,与专用嵌入(用户有权访问 Looker 界面的任何其他部分)不同,通过在浏览器中请求 EmbedUrlResponse.url 创建的嵌入网络会话只能访问 /embed 上下文下显示的内容。

嵌入网址只能使用一次,且必须在创建后的 5 分钟内使用。网址被用于向 Looker 服务器请求网页后,该网址将失效。日后使用同一网址的请求将会失败。这是为了防止“重放攻击”。

target_url 属性必须是 Looker 嵌入式界面页面(架构、主机名、以“/embed”开头的路径和查询参数)的完整网址。如需加载 ID 为 56 且过滤条件为 Date=1 years 的信息中心,Looker 嵌入网址将如下所示:https://myname.looker.com/embed/dashboards/56?Date=1%20years。 获取此 target_url 的最佳方法是在网络浏览器中导航到所需的 Looker 页面,复制浏览器地址栏中显示的网址,在主机/端口后插入“/embed”,然后将其粘贴到此 API 请求中引用的字符串值 target_url 属性。

安全性说明

按照与访问令牌或密码凭据相同的方式保护此嵌入网址:不要将其写入磁盘,不要将其传递给第三方,而只通过安全的 HTTPS 加密传输进行传递。

请求

POST /embed/token_url/me
数据类型
说明
请求
HTTP 请求
body
HTTP 正文
展开 HTTPBody 定义...
body
嵌入参数
展开 EmbedParams 定义...
target_url
字符串
要在嵌入上下文中显示的 Looker 界面页面的完整网址。例如,如需显示 ID 为 34 的信息中心,`target_url` 会类似于:https://mycompany.looker.com:9999/dashboards/34。`target_uri` 必须包含协议 (HTTPS)、域名和网址路径。如果必须从浏览器客户端访问 Looker 服务器,则必须添加端口。如果 Looker 实例位于负载均衡器或其他代理后面,则“target_uri”必须是访问 Looker 实例所需的公开域名和端口,而不是 Looker 实例的实际内部网络计算机名称。
会话时长
整数
单点登录会话启动后,单点登录嵌入会话的秒数。默认为 300 秒。接受的会话时长上限为 2592000 秒(30 天)。
force_logout_login
布尔值
如果为 true,嵌入会话将完全清除所有剩余的 Looker 登录状态(例如在浏览器 Cookie 中),然后再使用指定的嵌入用户信息创建新的登录状态。默认值为 true。

响应

200:嵌入网址

数据类型
说明
(对象)
网址
字符串
嵌入网址。对此字符串所做的任何修改都会导致网址无法使用。

400:错误请求

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

404:未找到

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

409:资源已存在

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接

422:验证错误

数据类型
说明
(对象)
消息
字符串
错误详情
展开 ValidationErrorDetail 定义...
字段
字符串
出错的字段
代码
字符串
错误代码
消息
字符串
错误信息消息
文档网址
字符串
文档链接
文档网址
字符串
文档链接

429:请求数过多

数据类型
说明
(对象)
消息
字符串
错误详情
文档网址
字符串
文档链接