Method: analytics.agentPerformances.list

Liệt kê dữ liệu hiệu suất của nhân viên hỗ trợ mà người gọi có thể truy cập.

Mỗi kết quả đại diện cho các chỉ số hiệu suất của một nhân viên hỗ trợ cụ thể ở một quốc gia cụ thể. Nếu một nhân viên hỗ trợ có không đủ dữ liệu cho một quốc gia nhất định, thì sẽ không có bản ghi hiệu suất nào cho cặp nhân viên hỗ trợ – quốc gia đó được trả về.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Thông số
pageSize

integer

Không bắt buộc. Chỉ định số lượng kết quả tối đa mà máy chủ sẽ trả về. Máy chủ có thể hạn chế thêm số lượng kết quả tối đa được trả về trong một trang. Nếu pageSize là 0, máy chủ sẽ quyết định số lượng kết quả cần trả về. pageSize tối đa là 1.000.
pageToken

string

Không bắt buộc. Giá trị nextPageToken được trả về từ một yêu cầu List trước đó (nếu có).

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Trả về danh sách hiệu suất của nhân viên hỗ trợ.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "agentPerformances": [
    {
      object (AgentPerformance)
    }
  ],
  "nextPageToken": string
}
Trường
agentPerformances[]

object (AgentPerformance)

Danh sách hiệu suất của nhân viên hỗ trợ.
nextPageToken

string

Không bắt buộc. Mã thông báo phân trang để truy xuất trang kết quả tiếp theo. Nếu giá trị là "", tức là không có kết quả nào khác cho yêu cầu.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.

AgentPerformance

Các chỉ số hiệu suất của một nhân viên hỗ trợ ở một quốc gia.

Biểu diễn dưới dạng 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)
  }
}
Trường
name

string

Giá trị nhận dạng duy nhất của nhân viên hỗ trợ.

Do nền tảng xác định.
displayName

string

Bắt buộc. Tên mà nhân viên hỗ trợ hiển thị cho người dùng. Tối đa 40 ký tự.

Không thể sửa đổi sau khi xác minh nhân viên hỗ trợ.
countryCode

string

Thứ nguyên quốc gia cho các chỉ số hiệu suất đã cho. Được cung cấp dưới dạng mã quốc gia ISO 3166 Alpha-2. Ví dụ: "US" cho Hoa Kỳ.
agentUseCase

enum (AgentUseCase)

Trường hợp sử dụng của nhân viên hỗ trợ
reputation

enum (Reputation)

Danh tiếng của nhân viên hỗ trợ ở quốc gia đã cho.
trafficLimit

integer

Giới hạn lưu lượng truy cập của nhân viên hỗ trợ (số tin nhắn trên mỗi người dùng mỗi tháng) ở quốc gia đã cho. Nếu nhân viên hỗ trợ không chịu giới hạn lưu lượng truy cập, thì giá trị sẽ không được đặt.
metricsPeriodEndTime

string (Timestamp format)

Dấu thời gian đại diện cho thời điểm kết thúc khoảng thời gian mà các chỉ số được tính toán. Các chỉ số (bao gồm cả danh tiếng) được tính dựa trên dữ liệu cho đến dấu thời gian này. Dấu thời gian này là nửa đêm gần đây nhất theo giờ Thái Bình Dương (PT).

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
spamTrendDays7

enum (TrendDirection)

Xu hướng về tin nhắn rác trong khoảng thời gian 7 ngày.
spamTrendDays28

enum (TrendDirection)

Xu hướng về tin nhắn rác trong khoảng thời gian 28 ngày.
agentUnsubscribeReasonMetricsDays7

object (AgentUnsubscribeReasonMetrics)

Các chỉ số về lý do huỷ đăng ký của nhân viên hỗ trợ trong khoảng thời gian 7 ngày.
agentUnsubscribeReasonMetricsDays28

object (AgentUnsubscribeReasonMetrics)

Các chỉ số về lý do huỷ đăng ký của nhân viên hỗ trợ trong khoảng thời gian 28 ngày.

Danh tiếng

Danh tiếng của nhân viên hỗ trợ ở quốc gia đã cho.

Enum
REPUTATION_UNSPECIFIED Danh tiếng không xác định.
LOW Danh tiếng thấp. Đây là danh tiếng mặc định.
MEDIUM Danh tiếng trung bình.
HIGH Danh tiếng cao.

TrendDirection

Cho biết sự thay đổi của một chỉ số trong một khoảng thời gian nhất định.

Enum
TREND_DIRECTION_UNSPECIFIED Hướng xu hướng không xác định.
DOWN Xu hướng giảm.
NEUTRAL Xu hướng không thay đổi.
UP Xu hướng tăng.

AgentUnsubscribeReasonMetrics

Các chỉ số về lý do huỷ đăng ký của nhân viên hỗ trợ trong một khoảng thời gian nhất định.

Biểu diễn dưới dạng JSON 
{
  "notSignedUpPercentage": integer,
  "tooManyMessagesPercentage": integer,
  "noLongerInterestedPercentage": integer,
  "spamPercentage": integer,
  "otherPercentage": integer
}
Trường
notSignedUpPercentage

integer

Tỷ lệ phần trăm người dùng chọn lý do huỷ đăng ký là "Chưa đăng ký".
tooManyMessagesPercentage

integer

Tỷ lệ phần trăm người dùng chọn lý do huỷ đăng ký là "Quá nhiều tin nhắn".
noLongerInterestedPercentage

integer

Tỷ lệ phần trăm người dùng chọn lý do huỷ đăng ký là "Không còn quan tâm".
spamPercentage

integer

Tỷ lệ phần trăm người dùng chọn lý do huỷ đăng ký là "Tin nhắn rác".
otherPercentage

integer

Tỷ lệ phần trăm người dùng chọn lý do huỷ đăng ký là "Khác".