Method: analytics.agentPerformances.list

列出调用方可访问的代理性能数据。

每个结果都表示特定代理在特定国家/地区的广告效果指标。如果某个代理在指定国家/地区的数据不足，系统不会返回该代理-国家/地区组合的效果记录。

HTTP 请求

GET https://businesscommunications.googleapis.com/v1/analytics/agentPerformances

网址采用 gRPC 转码语法。

查询参数

参数

参数
`pageSize`	`integer` 可选。指定服务器返回的结果数上限。服务器可以进一步限制单个页面中返回的最大结果数。如果 pageSize 为 0，则服务器将决定要返回的结果数。pageSize 的最大值为 1000。
`pageToken`	`string` 可选。从上一个 List 请求返回的 nextPageToken 值（如果有）。

pageSize

integer

可选。指定服务器返回的结果数上限。服务器可以进一步限制单个页面中返回的最大结果数。如果 pageSize 为 0，则服务器将决定要返回的结果数。pageSize 的最大值为 1000。

pageToken

string

可选。从上一个 List 请求返回的 nextPageToken 值（如果有）。

请求正文

请求正文必须为空。

响应正文

返回代理表现列表。

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

JSON 表示法
{ "agentPerformances": [ { object (`AgentPerformance`) } ], "nextPageToken": string }

字段

字段
`agentPerformances[]`	`object (AgentPerformance)` 代理效果列表。
`nextPageToken`	`string` 可选。用于检索下一页结果的分页令牌。如果值为 ""，则表示请求没有进一步的结果。

agentPerformances[]

object (AgentPerformance)

代理效果列表。

nextPageToken

string

可选。用于检索下一页结果的分页令牌。如果值为 ""，则表示请求没有进一步的结果。

授权范围

需要以下 OAuth 范围：

https://www.googleapis.com/auth/businesscommunications

如需了解详情，请参阅 OAuth 2.0 Overview。

AgentPerformance

某个国家/地区中代理的性能指标。

JSON 表示法

JSON 表示法
{ "name": string, "displayName": string, "countryCode": string, "agentUseCase": enum (`AgentUseCase`), "reputation": enum (`Reputation`), "trafficLimit": integer, "metricsPeriodEndTime": string, "spamTrendDays7": enum (`TrendDirection`), "spamTrendDays28": enum (`TrendDirection`), "agentUnsubscribeReasonMetricsDays7": { object (`AgentUnsubscribeReasonMetrics`) }, "agentUnsubscribeReasonMetricsDays28": { object (`AgentUnsubscribeReasonMetrics`) } }

{
  "name": string,
  "displayName": string,
  "countryCode": string,
  "agentUseCase": enum (AgentUseCase),
  "reputation": enum (Reputation),
  "trafficLimit": integer,
  "metricsPeriodEndTime": string,
  "spamTrendDays7": enum (TrendDirection),
  "spamTrendDays28": enum (TrendDirection),
  "agentUnsubscribeReasonMetricsDays7": {
    object (AgentUnsubscribeReasonMetrics)
  },
  "agentUnsubscribeReasonMetricsDays28": {
    object (AgentUnsubscribeReasonMetrics)
  }
}

字段
`name`	`string` 代理的唯一标识符。由平台定义。
`displayName`	`string` 必需。代理向用户显示的名称。不得超过 40 个字符。代理验证后无法修改。
`countryCode`	`string` 指定效果指标对应的国家/地区维度。以 ISO 3166 Alpha-2 国家/地区代码的形式提供。例如，“US”表示美国。
`agentUseCase`	`enum (AgentUseCase)` 代理的使用场景
`reputation`	`enum (Reputation)` 相应国家/地区中代理的声誉。
`trafficLimit`	`integer` 相应国家/地区内代理的流量限制（每位用户每月可发送的消息数）。如果代理不受流量限制，则不会设置该值。
`metricsPeriodEndTime`	`string (Timestamp format)` 表示计算指标所涵盖时间段的结束时间的时间戳。指标（包括声誉）是根据截至此时间戳的数据计算得出的。此时间戳为太平洋时间 (PT) 的最近一个午夜。注意：由于系统会在太平洋时间午夜后进行每日处理，因此指标可能要到太平洋时间午夜后几个小时才会更新。采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例：`"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"` 或 `"2014-10-02T15:01:23+05:30"`。
`spamTrendDays7`	`enum (TrendDirection)` 7 天内的垃圾信息趋势。
`spamTrendDays28`	`enum (TrendDirection)` 28 天内的垃圾信息趋势。
`agentUnsubscribeReasonMetricsDays7`	`object (AgentUnsubscribeReasonMetrics)` 7 天内的代理取消订阅原因指标。
`agentUnsubscribeReasonMetricsDays28`	`object (AgentUnsubscribeReasonMetrics)` 28 天内的代理取消订阅原因指标。

声誉

代理在指定国家/地区的声誉。

枚举
`REPUTATION_UNSPECIFIED`	未指定声誉。
`LOW`	声誉较差。
`MEDIUM`	中等声誉。这是默认声誉。
`HIGH`	声誉良好。

TrendDirection

显示了指标在指定时间段内的变化情况。

枚举
`TREND_DIRECTION_UNSPECIFIED`	未指定趋势方向。
`DOWN`	呈下降趋势。
`NEUTRAL`	趋势未发生变化。
`UP`	呈上升趋势。

AgentUnsubscribeReasonMetrics

指定时间段内的代理退订原因指标。

JSON 表示法
{ "notSignedUpPercentage": integer, "tooManyMessagesPercentage": integer, "noLongerInterestedPercentage": integer, "spamPercentage": integer, "otherPercentage": integer }

字段
`notSignedUpPercentage`	`integer` 选择“未订阅”作为退订原因的用户所占的百分比。
`tooManyMessagesPercentage`	`integer` 选择“邮件太多”作为退订原因的用户所占的百分比。
`noLongerInterestedPercentage`	`integer` 选择“不再感兴趣”作为退订原因的用户所占的百分比。
`spamPercentage`	`integer` 选择“垃圾内容”作为退订原因的用户所占的百分比。
`otherPercentage`	`integer` 选择“其他”作为取消订阅原因的用户所占的百分比。