Method: analytics.agentPerformances.list

호출자가 액세스할 수 있는 상담사 실적 데이터를 나열합니다.

각 결과는 특정 국가의 특정 에이전트의 실적 측정항목을 나타냅니다. 특정 국가에 대한 에이전트의 데이터가 충분하지 않으면 해당 에이전트-국가 쌍의 실적 레코드가 반환되지 않습니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

쿼리 매개변수

파라미터
pageSize

integer

선택사항입니다. 서버에서 반환할 최대 결과 수를 지정합니다. 서버는 단일 페이지로 반환되는 결과의 최대 수를 추가로 제한할 수 있습니다. 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

특정 국가에서 상담사의 트래픽 한도 (사용자당 월별 메시지 수)입니다. 에이전트가 트래픽 제한을 받지 않는 경우 값은 설정되지 않습니다.

metricsPeriodEndTime

string (Timestamp format)

측정항목이 계산된 기간의 종료를 나타내는 타임스탬프입니다. 신뢰도를 비롯한 측정항목은 이 타임스탬프까지의 데이터를 기반으로 계산됩니다. 이 타임스탬프는 가장 최근의 자정 (태평양 표준시)입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. '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

'기타'를 수신 거부 이유로 선택한 사용자의 비율입니다.