Method: analytics.agentPerformances.list

呼び出し元がアクセスできるエージェントのパフォーマンス データを一覧表示します。

各結果は、特定の国の特定のエージェントのパフォーマンス指標を表します。特定の国についてエージェントのデータが不足している場合、そのエージェントと国のペアのパフォーマンス レコードは返されません。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
pageSize

integer

省略可。サーバーから返される結果の最大数を指定します。1 ページ内に返される結果の最大数が、サーバーによってさらに制限されることがあります。pageSize が 0 の場合、返される結果の数はサーバーが決定します。pageSize の最大値は 1,000 です。
pageToken

string

省略可。前の List リクエストから返された nextPageToken 値（存在する場合）。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

エージェントのパフォーマンスのリストを返します。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "agentPerformances": [
    {
      object (AgentPerformance)
    }
  ],
  "nextPageToken": string
}
フィールド
agentPerformances[]

object (AgentPerformance)

エージェントのパフォーマンスのリスト。
nextPageToken

string

省略可。結果の次のページを取得するためのページ設定トークン。値が "" の場合、リクエストに対してそれ以上の結果がないことを意味します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 Overview をご覧ください。

AgentPerformance

国におけるエージェントのパフォーマンス指標。

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

必須。エージェントがユーザーに表示する名前。最大 40 文字。

エージェントの確認後に変更することはできません。
countryCode

string

指定されたパフォーマンス指標の国ディメンション。ISO 3166 Alpha-2 国コードで指定します。たとえば、米国は「US」です。
agentUseCase

enum (AgentUseCase)

エージェントのユースケース
reputation

enum (Reputation)

特定の国におけるエージェントの評判。
trafficLimit

integer

特定の国におけるエージェントのトラフィックの上限（ユーザー 1 人あたり月間のメッセージ数）。エージェントがトラフィック制限の対象でない場合、値は設定されません。
metricsPeriodEndTime

string (Timestamp format)

指標が計算された期間の終了を表すタイムスタンプ。評判などの指標は、このタイムスタンプまでのデータに基づいて計算されます。このタイムスタンプは、最新の午前 0 時（太平洋時間（PT））です。

RFC 3339 を使用します。生成された出力は常に 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

登録解除の理由として [その他] を選択したユーザーの割合。