搜索信息中心

版本 4.0.23.6（最新）

搜索信息中心

返回符合指定搜索条件的用户定义的信息中心对象的数组。请注意，search_dashboards() 不会返回 LookML 信息中心对象。

如果指定了多个搜索参数且 filter_or 为 FALSE 或未指定，则搜索参数会在逻辑 AND 运算中合并。系统将仅返回与所有搜索参数条件匹配的行。

如果 filter_or 为 TRUE，系统会将多个搜索参数合并到一个逻辑 OR 运算中。结果将包含与任何搜索条件匹配的行。

字符串搜索参数使用不区分大小写的匹配方式。字符串搜索参数可以包含 % 和“_”，因为 SQL LIKE 模式将匹配通配符表达式。example="dan%" 将与“danger”和“Danzig”匹配，但与“David”不匹配 example="D_m%”将与“Damage”和“dump”匹配

整数搜索参数可以接受单个值，也可以接受逗号分隔值列表。系统会在逻辑 OR 运算下合并多个值，结果会至少与给定值中的一个匹配。

大多数搜索参数可以接受“IS NULL”和“NOT NULL”作为特殊表达式，以匹配或排除相应的列为 null 的行。

布尔值搜索参数仅接受“true”和“false”作为值。

可使用参数 limit 和 offset 以页面大小的分块提取结果。

使用 dashboard() 按 ID 获取单个信息中心

请求

获取 /dashboards/search

数据类型

说明

请求

HTTP 请求

查询

HTTPQuery

展开 HTTPQuery 定义...

字符串

匹配信息中心 ID。

处理后标题

字符串

匹配信息中心 Slug。

title

字符串

匹配信息中心标题。

说明

字符串

匹配信息中心说明。

content_favorite_id

字符串

按内容收藏 ID 进行过滤。

文件夹 ID

字符串

按特定空格过滤。

已删除

字符串

按信息中心删除状态进行过滤。

user_id

字符串

按特定用户创建的信息中心进行过滤。

观看次数

字符串

按 view_count 的特定值过滤

content_metadata_id

字符串

按内容收藏 ID 进行过滤。

精选

布尔值

排除仅存在于用户个人空间中的商品

上次查看日期

字符串

根据上次查看时间选择信息中心

字段

字符串

请求的字段。

page

整数

已弃用。改为使用限制和偏移量。仅返回分页结果的第 N 页

每页

整数

已弃用。改为使用限制和偏移量。每页返回 N 行数据

限制

整数

要返回的结果数。（与偏移值搭配使用，并且优先级高于 page 和 per_page）

offset

整数

在返回任何结果之前要跳过的结果数。（与限制一起使用，优先级高于 page 和 per_page）

排序

字符串

按一个或多个字段排序。可排序字段：[:title, :user_id, :id, :created_at, :space_id, :folder_id, :description, :view_count, :favorite_count, :slug, :content_favorite_id, :content_metadata_id, :deleted, :deleted_at, :last_viewed_at, :last_viewed_ated

过滤条件或

布尔值

以布尔值 OR 表达式合并指定的搜索条件

响应

200：信息中心

数据类型

说明

（数组）

信息中心[]

可以

对象

当前用户可以对此对象执行的操作

content_favorite_id

字符串

内容收藏 ID

content_metadata_id

字符串

内容元数据的 ID

说明

字符串

说明

隐藏

布尔值

已隐藏

字符串

唯一 ID

模型

LookModel

模型

展开 LookModel 定义...

字符串

模型 ID

标签

字符串

模型标签

query_timezone

字符串

信息中心默认运行的时区。

只读

布尔值

只读

刷新间隔时间

字符串

刷新间隔时间，格式为“2 小时 30 分钟”。不含时间单位的数字将被解读为整秒。

refresh_interval_to_i

整数

刷新间隔（以毫秒为单位）

文件夹

展开 FolderBase 定义...

name

字符串

唯一名称

parent_id

字符串

父级的 ID。如果父 ID 为 null，这是一个根级条目

字符串

唯一 ID

content_metadata_id

字符串

内容元数据的 ID

创建时间

字符串

文件夹的创建时间

creator_id [创作者 ID]

字符串

创建者的用户 ID

儿童人数

整数

儿童数量

external_id

字符串

如果此文件夹通过单点登录外部登录中的“external_group_id”自动生成为嵌入共享文件夹，则嵌入者的 ID

is_embed

布尔值

文件夹是嵌入文件夹

is_embed_shared_root

布尔值

文件夹是根嵌入的共享文件夹

is_embed_users_root

布尔值

文件夹是根嵌入用户文件夹

是个人

布尔值

文件夹是用户的个人文件夹

is_personal_descendant

布尔值

文件夹是用户个人文件夹的后代

is_shared_root

布尔值

文件夹是根共享文件夹

is_users_root

布尔值

Folder 是根用户文件夹

可以

对象

当前用户可以对此对象执行的操作

title

字符串

信息中心标题

user_id

字符串

用户 ID

处理后标题

字符串

内容元数据 Slug

首选的观看者

字符串

查看此信息中心的首选路线（即信息中心或信息中心-下一步）

alert_sync_with_dashboard_filter_enabled

布尔值

让提醒与信息中心过滤条件的更改保持同步

背景色

字符串

背景颜色

创建时间

字符串

信息中心的创建时间。

crossfilter_enabled

布尔值

在信息中心内启用交叉过滤 - 仅在信息中心内提供（下一步）

信息中心元素

信息中心元素[]

展开 DashboardElement 定义...

可以

对象

当前用户可以对此对象执行的操作

正文

字符串

文本图块正文

正文文本

字符串

文本图块，采用 HTML 格式的文本

信息中心 ID

字符串

信息中心 ID

修改_ URI

字符串

用于修改信息中心元素的 LookML 文件的 URI 相对路径（仅限 LookML 信息中心）。

字符串

唯一 ID

相似，

LookWithQuery

Look

展开 LookWithQuery 定义...

可以

对象

当前用户可以对此对象执行的操作

content_metadata_id

字符串

内容元数据的 ID

字符串

唯一 ID

title

字符串

外观标题

user_id

字符串

用户 ID

content_favorite_id

字符串

内容收藏 ID

创建时间

字符串

Look 的创建时间。

已删除

布尔值

外观是否“软”删除。

已删除

字符串

Look 删除的时间。

deleter_id

字符串

删除样式的用户的 ID。

说明

字符串

说明

嵌入网址

字符串

嵌入网址

excel_file_url

字符串

Excel 文件网址

收藏次数

整数

被收藏的次数

google_spreadsheet_formula

字符串

Google 电子表格公式

image_embed_url

字符串

图片嵌入网址

is_run_on_load

布尔值

在查看 Look 时自动运行查询

上次访问日期：

字符串

任何用户上次访问 Look 的时间

last_updater_id（上次更新 ID）

字符串

上次更新外观的用户的 ID。

上次查看日期

字符串

Looker 网页界面中的上次查看时间

模型

LookModel

模型

public

布尔值

是公开的

public_slug

字符串

公麋鹿

公开网址

字符串

公开网址

查询 ID

字符串

查询 ID

短网址

字符串

短网址

文件夹

此外观的文件夹

文件夹 ID

字符串

文件夹 ID

更新时间

字符串

Look 更新的时间。

观看次数

整数

在 Looker 网页界面中查看次数

查询

网址

字符串

网址

Look_id

字符串

外观 ID

findml_link_id

字符串

LookML 关联 ID

merge_result_id

字符串

合并结果的 ID

note_display

字符串

记事显示

记事状态

字符串

备注状态

记事文本

字符串

备注文本

note_text_as_html

字符串

备注文本为 html

查询

展开查询定义...

可以

对象

当前用户可以对此对象执行的操作

字符串

唯一 ID

模型

字符串

模型

视图

字符串

探索名称

字段

字符串 []

数据透视

字符串 []

fill_fields

字符串 []

filters

对象

过滤器

过滤条件表达式

字符串

过滤条件表达式

排序

字符串 []

限制

字符串

限制

列限制

字符串

列数上限

总计

布尔值

总计

总行数

字符串

原始总计

小计

字符串 []

vis_config

对象

可视化配置属性。这些属性通常不透明，因所用的可视化类型而异。没有已指定的一组允许的键。这些值可以是 JSON 支持的任何类型。通常具有存在字符串值的“类型”键，供 Looker 用来确定显示哪个可视化图表。可视化图表会忽略未知 vis_config 属性。

过滤条件配置

对象

filter_config 表示给定查询的探索页面上的过滤条件界面的状态。通过 Looker 界面运行查询时，此参数的优先级高于“过滤器”。创建查询或修改现有查询时，应将“filter_config”设置为 null。将其设置为任何其他值都可能会导致意外的过滤行为。该格式应视为不透明。

visible_ui_sections

字符串

可见界面部分

处理后标题

字符串

Slug

动态字段

字符串

动态字段

client_id

字符串

客户端 ID：用于生成缩短的探索网址。如果由客户端设置，则必须是唯一的 22 位字母数字字符串。否则，系统会生成一个。

分享网址

字符串

分享网址

展开网址共享网址

字符串

展开后的共享网址

网址

字符串

展开后的网址

query_timezone

字符串

查询时区

has_table_calculations

布尔值

包含表计算

查询 ID

字符串

查询 ID

刷新间隔时间

字符串

刷新间隔时间

refresh_interval_to_i

整数

刷新间隔（整数）

result_maker

ResultMakerWithIdVisConfigAndDynamicFields

结果生成器的相关数据。

展开 ResultMakerWithIdVisConfigAndDynamicFields 定义...

字符串

唯一 ID。

动态字段

字符串

动态字段信息的 JSON 字符串。

可过滤

ResultMakerFilterable[]

排序

字符串 []

merge_result_id

字符串

如果是 merge_result，则为合并结果的 ID。

总计

布尔值

组成部分的“查看”、“查询”或“合并查询”总数

查询 ID

字符串

如果是查询，则为查询的 ID。

sql_query_id

字符串

SQL 查询的 ID（如果是 SQL Runner 查询）

查询

vis_config

对象

组成查询或合并查询的 Vis 配置。

result_maker_id

字符串

ResultMakerLookup 条目的 ID。

副标题

字符串

文本图块字幕文本

title

字符串

信息中心元素的标题

title_hidden

布尔值

标题是否处于隐藏状态

标题文字

字符串

文本图块标题

类型

字符串

类型

提醒数

整数

与信息中心元素相关联的提醒数量

富媒体内容 JSON

字符串

JSON，其中包含富媒体编辑器和按钮元素所需的所有属性

title_text_as_html

字符串

文本图块标题文本（采用 HTML 格式）

subtitle_text_as_html

字符串

文本图块的副标题文本（HTML 格式）

extension_id

字符串

扩展程序 ID

信息中心过滤条件

信息中心过滤条件[]

展开 DashboardFilter 定义...

可以

对象

当前用户可以对此对象执行的操作

字符串

唯一 ID

信息中心 ID

字符串

信息中心 ID

name

字符串

过滤条件的名称

title

字符串

过滤条件的标题

类型

字符串

过滤器类型：日期、数字、字符串或字段之一

default_value

字符串

过滤器的默认值

模型

字符串

过滤器模型（如果类型为“字段”，则必须提供）

探索

字符串

探索过滤条件（如果类型 = 字段，则为必需参数）

维度

字符串

过滤器的维度（如果类型为“字段”，则必须提供）

字段

对象

字段信息

行

整数

此过滤条件相对于其他过滤条件的顺序显示

监听过滤器

字符串 []

allow_multi_values

布尔值

过滤条件是否允许使用多个过滤条件值（在最新版本的信息中心内已弃用）

必填

布尔值

过滤条件是否需要值才能运行信息中心

界面配置

对象

此过滤器的视觉配置。用于设置此过滤器的界面显示方式。

信息中心布局

信息中心布局[]

展开 DashboardLayout 定义...

可以

对象

当前用户可以对此对象执行的操作

字符串

唯一 ID

信息中心 ID

字符串

信息中心 ID

类型

字符串

类型

活跃

布尔值

处于活动状态

列宽

整数

列宽

宽度

整数

宽度

已删除

布尔值

信息中心布局是否已删除。

信息中心标题

字符串

从此布局所代表的信息中心中提取的标题。

Dashboard_layout_components

DashboardLayoutComponent[]

展开 DashboardLayoutComponent 定义...

可以

对象

当前用户可以对此对象执行的操作

字符串

唯一 ID

Dashboard_layout_id

字符串

信息中心布局 ID

信息中心_元素 ID

字符串

信息中心元素的 ID

行

整数

行

列

整数

柱形图

宽度

整数

宽度

高度

整数

高度

已删除

布尔值

信息中心布局组件是否被删除

元素标题

字符串

信息中心元素标题，从信息中心元素中提取。

元素标题隐藏

布尔值

是否显示信息中心元素标题。

vis_type

字符串

可视化类型，从查询的 vis_config 中提取

已删除

布尔值

信息中心是否处于“软”状态。

已删除

字符串

信息中心“软”删除的时间。

deleter_id

字符串

信息中心删除的用户“软”的 ID。

修改_ URI

字符串

用于修改信息中心的 LookML 文件的 URI 相对路径（仅限 LookML 信息中心）。

启用全屏

布尔值

允许在全屏模式下查看可视化图表

收藏次数

整数

被收藏的次数

过滤条件栏

布尔值

将过滤条件栏的默认状态设置为收起或打开

filters_location_top

布尔值

将过滤器位置的默认状态设置为 top(true) 或 right(false)

上次访问日期：

字符串

上次访问信息中心的时间

上次查看日期

字符串

Looker 网页界面中的上次查看时间

更新时间

字符串

数字面板的最近更新时间。

last_updater_id（上次更新 ID）

字符串

最近更新信息中心的用户 ID。

姓氏更新名称

字符串

最近一次更新信息中心的用户名称。

用户名

字符串

创建信息中心的用户名称。

加载配置

字符串

配置选项，用于控制信息中心加载的方式。

findml_link_id

字符串

将此信息中心与特定 LookML 信息中心相关联，以便在对该 LookML 信息中心调用 **sync** 操作时，此信息中心将更新为匹配。

显示过滤器

布尔值

显示过滤器栏。**安全注意事项**：此属性只会影响信息中心的 *外观* 外观，不会影响用户的数据访问功能。隐藏过滤条件栏 **不会** 阻止用户以其他方式更改过滤条件。如需了解如何设置安全的数据访问权限控制政策，请参阅 [控制用户对数据的访问权限](https://cloud.google.com/looker/docs/r/api/control-access)

节目名称

布尔值

显示标题

文件夹 ID

字符串

文件夹 ID

文字图块_颜色

字符串

文本图块上的文本颜色

卡片背景颜色

字符串

图块背景颜色

卡片文字文本

字符串

卡片文本颜色

title_color [商品名颜色]

字符串

标题颜色

观看次数

整数

在 Looker 网页界面中查看次数

外观

信息中心外观

信息中心视觉设置仅适用于 Dashboard-next（Beta 版）

展开 DashboardAppearance 定义...

page_side_边距

整数

页面边距（侧边）宽度

page_background_color

字符串

信息中心的背景颜色

tile_title_alignment

字符串

信息中心图块上的标题对齐方式

tile_space_between

整数

图块之间的间距

卡片背景颜色

字符串

卡片的背景颜色

图块阴影

布尔值

开启/关闭图块阴影

关键颜色

字符串

按键颜色

网址

字符串

信息中心的相对网址

400：错误请求

数据类型

说明

（对象）

错误

消息

字符串

错误详情

文档网址

字符串

文档链接

404：未找到

数据类型

说明

（对象）

错误

消息

字符串

错误详情

文档网址

字符串

文档链接

示例

搜索信息中心