Method: alerts.list

列出提醒。

HTTP 请求

GET https://alertcenter.googleapis.com/v1beta1/alerts

网址采用 gRPC 转码语法。

查询参数

参数
customerId

string

可选。与提醒关联的客户的 Google Workspace 账号的唯一标识符。customerId 必须去除首字母“C”（例如 046psxkn）。如果未提供，系统会从调用方身份推断出此值。查找您的客户 ID。
pageSize

integer

可选。请求的页面大小。服务器返回的项可能要比请求的少。如果未指定，服务器会选择相应的默认值。
pageToken

string

可选。标识服务器应返回的结果页面的令牌。 如果为空，则会启动新的迭代。如需继续迭代，请传入上一个 ListAlertsResponse 的 nextPageToken 字段中的值。
filter

string

可选。用于过滤提醒结果的查询字符串。如需了解详情，请参阅查询过滤条件和支持的查询过滤条件字段。
orderBy

string

可选。列表结果的排序顺序。如果未指定，系统可能会以任意顺序返回结果。您可以使用 orderBy="createTime desc" 按创建时间戳对结果进行降序排序。目前支持的排序方式包括 createTime asc、createTime desc、updateTime desc

请求正文

请求正文必须为空。

响应正文

用于列出提醒的请求的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "alerts": [
    {
      object (Alert)
    }
  ],
  "nextPageToken": string
}
字段
alerts[]

object (Alert)

提醒列表。
nextPageToken

string

下一页的令牌。如果不为空，则表示可能有更多与商品详情请求匹配的提醒；此值可在后续的 ListAlertsRequest 中使用，以获取从当前列表调用的上一个结果继续显示的提醒。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/apps.alerts

如需了解详情，请参阅授权指南。