Method: analytics.agentPerformances.list

แสดงข้อมูลประสิทธิภาพของตัวแทนที่ผู้โทรเข้าถึงได้

ผลลัพธ์แต่ละรายการแสดงเมตริกประสิทธิภาพของตัวแทนที่เฉพาะเจาะจงในประเทศที่เฉพาะเจาะจง หาก Agent มีข้อมูลไม่เพียงพอสำหรับประเทศหนึ่งๆ ระบบจะไม่แสดงบันทึกประสิทธิภาพสำหรับคู่ Agent-ประเทศนั้น

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
pageSize

integer

ไม่บังคับ ระบุจำนวนผลลัพธ์สูงสุดที่เซิร์ฟเวอร์จะแสดง เซิร์ฟเวอร์อาจจำกัดจำนวนผลลัพธ์สูงสุดที่แสดงในหน้าเดียวเพิ่มเติม หาก pageSize เป็น 0 เซิร์ฟเวอร์จะเป็นผู้กำหนดจำนวนผลลัพธ์ที่จะแสดง pageSize สูงสุดคือ 1,000
pageToken

string

ไม่บังคับ ค่า nextPageToken ที่แสดงผลจากคำขอ List ก่อนหน้า (หากมี)

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

แสดงรายการประสิทธิภาพของตัวแทน

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง 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)

การประทับเวลาที่แสดงถึงจุดสิ้นสุดของระยะเวลาที่คำนวณเมตริก ระบบจะคำนวณเมตริก รวมถึงชื่อเสียง โดยอิงตามข้อมูลจนถึงการประทับเวลานี้ การประทับเวลานี้คือเวลาเที่ยงคืนล่าสุดตามเวลาเขตแปซิฟิก (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)

เมตริกเหตุผลที่ Agent ยกเลิกการสมัครรับอีเมลในช่วง 28 วัน

ชื่อเสียง

ชื่อเสียงของตัวแทนในประเทศที่ระบุ

Enum
REPUTATION_UNSPECIFIED ชื่อเสียงที่ไม่ได้ระบุ
LOW มีชื่อเสียงไม่ดี ซึ่งเป็นชื่อเสียงเริ่มต้น
MEDIUM ความน่าเชื่อถือปานกลาง
HIGH มีชื่อเสียงสูง

TrendDirection

แสดงการเปลี่ยนแปลงของเมตริกในช่วงระยะเวลาหนึ่งๆ

Enum
TREND_DIRECTION_UNSPECIFIED ทิศทางเทรนด์ที่ไม่ได้ระบุ
DOWN เทรนด์กำลังได้รับความนิยมลดลง
NEUTRAL เทรนด์ไม่ได้เปลี่ยนแปลง
UP เทรนด์กำลังมา

AgentUnsubscribeReasonMetrics

เมตริกเหตุผลในการยกเลิกการสมัครรับข้อมูลของ Agent ในช่วงระยะเวลาหนึ่งๆ

การแสดง JSON 
{
  "notSignedUpPercentage": integer,
  "tooManyMessagesPercentage": integer,
  "noLongerInterestedPercentage": integer,
  "spamPercentage": integer,
  "otherPercentage": integer
}
ช่อง
notSignedUpPercentage

integer

เปอร์เซ็นต์ของผู้ใช้ที่เลือก "ไม่ได้ลงชื่อสมัครใช้" เป็นเหตุผลในการยกเลิกการติดตาม
tooManyMessagesPercentage

integer

เปอร์เซ็นต์ของผู้ใช้ที่เลือก "มีข้อความมากเกินไป" เป็นเหตุผลในการยกเลิกการสมัครรับอีเมล
noLongerInterestedPercentage

integer

เปอร์เซ็นต์ของผู้ใช้ที่เลือก "ไม่สนใจอีกต่อไป" เป็นเหตุผลในการยกเลิกการติดตาม
spamPercentage

integer

เปอร์เซ็นต์ของผู้ใช้ที่เลือก "สแปม" เป็นเหตุผลในการยกเลิกการติดตาม
otherPercentage

integer

เปอร์เซ็นต์ของผู้ใช้ที่เลือก "อื่นๆ" เป็นเหตุผลในการยกเลิกการติดตาม