Method: domains.domainStats.query

เรียกข้อมูลรายการสถิติโดเมนสำหรับโดเมนและระยะเวลาที่ระบุ แสดงผล PERMISSION_DENIED หากคุณไม่มีสิทธิ์เข้าถึง DomainStats สำหรับโดเมน

คำขอ HTTP

POST https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/domainStats:query

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

พารามิเตอร์เส้นทาง

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

string

ต้องระบุ ชื่อทรัพยากรหลักที่ใช้ค้นหาสถิติ รูปแบบ: domains/{domain}

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

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

การแสดง JSON 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
ช่อง
metricDefinitions[]

object (MetricDefinition)

ต้องระบุ เมตริกที่เฉพาะเจาะจงที่จะค้นหา คุณกำหนดชื่อที่กำหนดเองสำหรับเมตริกแต่ละรายการได้ ซึ่งจะใช้ในการตอบกลับ
timeQuery

object (TimeQuery)

ต้องระบุ ช่วงเวลาหรือวันที่ที่เฉพาะเจาะจงที่จะดึงข้อมูลเมตริก
pageSize

integer

ไม่บังคับ จำนวนสูงสุดของทรัพยากร DomainStats ที่จะแสดงในคำตอบ เซิร์ฟเวอร์อาจแสดงผลน้อยกว่าค่านี้ หากไม่ได้ระบุ ระบบจะใช้ค่าเริ่มต้นเป็น 10 ค่าสูงสุดคือ 200
pageToken

string

ไม่บังคับ ค่า nextPageToken ที่แสดงผลจากคำขอ List ก่อนหน้า (หากมี) หากระดับการรวบรวมเป็นรายวัน โทเค็นหน้าจะเป็นวันที่ที่เข้ารหัส + "/" + ชื่อเมตริก หากระดับการรวบรวมคือ OVERALL โทเค็นหน้าจะเป็นชื่อเมตริกที่เข้ารหัส
aggregationGranularity

enum (AggregationGranularity)

ไม่บังคับ ระดับรายละเอียดที่จะรวบรวมสถิติ หากไม่ได้ระบุ ระบบจะใช้ค่าเริ่มต้นเป็น DAILY

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ QueryDomainStatsResponse

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.traffic.readonly

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์