创建提醒

版本 4.0.23.2

创建新提醒并返回新创建的对象的详细信息

必填字段：field、destinations、comparison_type、threshold、cron

示例请求：每天早上 5 点对信息中心元素“103”运行提醒。如果洛杉矶的广告资源（使用信息中心过滤条件 Warehouse Name）低于 1000，请发送电子邮件至“test@test.com”

{
  "cron": "0 5 * * *",
  "custom_title": "Alert when LA inventory is low",
  "dashboard_element_id": 103,
  "applied_dashboard_filters": [
    {
      "filter_title": "Warehouse Name",
      "field_name": "distribution_centers.name",
      "filter_value": "Los Angeles CA",
      "filter_description": "is Los Angeles CA"
    }
  ],
  "comparison_type": "LESS_THAN",
  "destinations": [
    {
      "destination_type": "EMAIL",
      "email_address": "test@test.com"
    }
  ],
  "field": {
    "title": "Number on Hand",
    "name": "inventory_items.number_on_hand"
  },
  "is_disabled": false,
  "is_public": true,
  "threshold": 1000
}

请求

POST /alerts
数据类型
说明
请求
HTTP 请求
body
HTTP 正文
展开 HTTPBody 定义...
body
提醒
展开提醒定义...
已应用的信息中心过滤条件
比较类型
字符串
此属性可告知我们要执行哪种比较。只有特定类型条件适用于时序提醒。。
cron
字符串
何时运行 Vixie-style crontab 规范。必须至少间隔 15 分钟
custom_url_base
字符串
提醒创建者从管理员定义的网域许可名单中选择的自定义网址的网域
custom_url_params
字符串
提醒创建者定义的自定义网址的参数和路径
自定义网址标签
字符串
提醒创建者定义的自定义网址的标签
show_custom_url
布尔值
用于确定是否应该使用自定义网址的布尔值
自定义商品名
字符串
用户定义的提醒标题（可选）
信息中心_元素 ID
字符串
与提醒关联的信息中心元素的 ID。请参阅 [dashboard_element()](#!/信息中心/信息中心元素)
说明
字符串
提醒的可选说明。这是对标题的补充
目标页面
字段
在确定何时发送通知时，用于比较提醒阈值的字段
已关注
布尔值
用户是否遵循此提醒。
可关注
布尔值
是否可发出提醒
id
字符串
提醒的 ID
已停用
布尔值
提醒是否已停用
已停用的原因
字符串
停用提醒的原因
公开
布尔值
警报是否处于公开状态
investigative_content_type
字符串
调查内容的类型：“有效值”为“信息中心”。
investigative_content_id
字符串
调查内容的 ID。对于信息中心，这将是信息中心 ID
investigative_content_title
字符串
调查内容的标题。
Lookml_dashboard_id
字符串
与提醒关联的 LookML 信息中心的 ID
findml_link_id
字符串
与提醒关联的 LookML 信息中心元素的 ID
所有者 ID
字符串
提醒所有者的用户 ID
所有者_显示名
字符串
提醒所有者的显示名称
threshold
数值
提醒阈值的值
time_Series_condition_state
（只写）（可选）仅在首次创建时序提醒时使用。它用于选择要重新评估提醒的开始时间参考。如果没有该值，系统将针对所有时序数据运行提醒。如需了解详情，请参阅 [文档](https://cloud.google.com/looker/docs/sharing-and-publishing/creating-alerts)。示例 `{latest_time_Series_id: '2020-09-17', previous_time_Series_id: '2020-09-16' }`。

响应

200：提醒已保存。

数据类型
说明
（对象）
已应用的信息中心过滤条件
展开 AlertApplied DashboardFilter 定义...
过滤条件名称
字符串
字段标题。请参阅 [ DashboardFilter](#!/types/DashboardFilter) 中的“ DashboardFilter.title”。`Name` 示例
field_name
字符串
字段名称。请参阅 [ DashboardFilter](#!/types/DashboardFilter) 中的“ DashboardFilter.dimension”。示例：distribution_centers.name
过滤条件值
字符串
字段值。[过滤表达式](https://cloud.google.com/looker/docs/reference/filter-expressions)。示例：“加利福尼亚州洛杉矶”
过滤条件说明
字符串
直观易懂的过滤器说明。此字段可能为 null 或自动生成。示例：“是洛杉矶”
比较类型
字符串
此属性可告知我们要执行哪种比较。只有特定类型条件适用于时序提醒。。
cron
字符串
何时运行 Vixie-style crontab 规范。必须至少间隔 15 分钟
custom_url_base
字符串
提醒创建者从管理员定义的网域许可名单中选择的自定义网址的网域
custom_url_params
字符串
提醒创建者定义的自定义网址的参数和路径
自定义网址标签
字符串
提醒创建者定义的自定义网址的标签
show_custom_url
布尔值
用于确定是否应该使用自定义网址的布尔值
自定义商品名
字符串
用户定义的提醒标题（可选）
信息中心_元素 ID
字符串
与提醒关联的信息中心元素的 ID。请参阅 [dashboard_element()](#!/信息中心/信息中心元素)
说明
字符串
提醒的可选说明。这是对标题的补充
目标页面
展开 AlertDestination 定义...
目标类型
字符串
将收到提醒的目的地类型包括：“EMAIL”、“ACTION_HUB”。
电子邮件地址
字符串
“email”类型的电子邮件地址
action_hub_integration_id
字符串
“action_hub”类型的 Action Hub 集成 ID。[集成](#!/types/Integration)
action_hub_form_params_json
字符串
Action hub 表单 json 类型“action_hub”类型 [IntegrationParam](#!/types/IntegrationParam)
字段
在确定何时发送通知时，用于比较提醒阈值的字段
展开 AlertField 定义...
title
字符串
字段的标题。通常自动生成，以反映字段名称及其过滤器
name
字符串
字段的名称。格式为 `.` 请参阅 [文档](https://cloud.google.com/looker/docs/sharing-and-publishing/creating-alerts)了解更多详情
过滤器
展开 AlertFieldFilter 定义...
field_name
字符串
字段名称。格式为 `.`
字段值
任意类型
字段值。取决于字段类型 - 数字或字符串。对于 [location](https://cloud.google.com/looker/docs/reference/field-reference/dimension-type-reference#location) 类型，它是浮点值列表。示例 `[1.0, 56.0]`
过滤条件值
字符串
过滤条件值。通常为 null，[位置](https://cloud.google.com/looker/docs/reference/field-reference/dimension-type-reference#location)类型除外。是一个由纬度和经度组成的字符串，即“1.0,56.0”
已关注
布尔值
用户是否遵循此提醒。
可关注
布尔值
是否可发出提醒
id
字符串
提醒的 ID
已停用
布尔值
提醒是否已停用
已停用的原因
字符串
停用提醒的原因
公开
布尔值
警报是否处于公开状态
investigative_content_type
字符串
调查内容的类型：“有效值”为“信息中心”。
investigative_content_id
字符串
调查内容的 ID。对于信息中心，这将是信息中心 ID
investigative_content_title
字符串
调查内容的标题。
Lookml_dashboard_id
字符串
与提醒关联的 LookML 信息中心的 ID
findml_link_id
字符串
与提醒关联的 LookML 信息中心元素的 ID
所有者 ID
字符串
提醒所有者的用户 ID
所有者_显示名
字符串
提醒所有者的显示名称
threshold
数值
提醒阈值的值
time_Series_condition_state
（只写）（可选）仅在首次创建时序提醒时使用。它用于选择要重新评估提醒的开始时间参考。如果没有该值，系统将针对所有时序数据运行提醒。如需了解详情，请参阅 [文档](https://cloud.google.com/looker/docs/sharing-and-publishing/creating-alerts)。示例 `{latest_time_Series_id: '2020-09-17', previous_time_Series_id: '2020-09-16' }`。
展开 AlertConditionState 定义...
previous_time_Series_id
字符串
（只写）仅次于提醒消息出现的时间字符串。
最新时序 ID
字符串
（只写）提醒发出时间的最新时间字符串。

400：错误请求

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

404：未找到

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

405：无法修改资源

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

409：资源已存在

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

422：验证错误

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

429：请求数过多

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