Method: domainStats.batchQuery

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

คำขอ HTTP

POST https://gmailpostmastertools.googleapis.com/v2beta/domainStats:batchQuery

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

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

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

การแสดง JSON 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
ช่อง
requests[]

object (QueryDomainStatsRequest)

ต้องระบุ รายการคำขอค้นหาแต่ละรายการ คำขอแต่ละรายการอาจเป็นคำขอสำหรับโดเมนที่แตกต่างกันได้ คุณรวมคำขอได้สูงสุด 100 รายการในกลุ่มเดียว

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

ข้อความตอบกลับสำหรับ domainStats.batchQuery

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

การแสดง JSON 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
ช่อง
results[]

object (BatchQueryDomainStatsResult)

รายการการตอบกลับ โดยมีการตอบกลับ 1 รายการสําหรับการค้นหาแต่ละรายการใน BatchQueryDomainStatsRequest ลำดับการตอบกลับจะสอดคล้องกับลำดับคำขอ

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

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

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

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

QueryDomainStatsRequest

ข้อความคำขอสำหรับ QueryDomainStats

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

string

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

object (MetricDefinition)

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

object (TimeQuery)

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

integer

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

string

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

enum (AggregationGranularity)

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

BatchQueryDomainStatsResult

แสดงผลลัพธ์ของ QueryDomainStatsRequest รายการเดียวภายในกลุ่ม

การแสดง JSON 
{

  // Union field result can be only one of the following:
  "response": {
    object (QueryDomainStatsResponse)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
ช่อง
ฟิลด์ Union result ผลลัพธ์ของคำค้นหาแต่ละรายการ result ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
response

object (QueryDomainStatsResponse)

การตอบกลับที่สำเร็จสำหรับการค้นหาแต่ละรายการ
error

object (Status)

สถานะข้อผิดพลาดหากการค้นหาแต่ละรายการล้มเหลว

สถานะ

Status ประเภทจะกำหนดรูปแบบข้อผิดพลาดเชิงตรรกะที่เหมาะกับสภาพแวดล้อมการเขียนโปรแกรมต่างๆ รวมถึง REST API และ RPC API โดย gRPC จะใช้พอร์ตนี้ Statusแต่ละข้อความจะมีข้อมูล 3 ส่วน ได้แก่ รหัสข้อผิดพลาด ข้อความแสดงข้อผิดพลาด และรายละเอียดข้อผิดพลาด

ดูข้อมูลเพิ่มเติมเกี่ยวกับรูปแบบข้อผิดพลาดนี้และวิธีใช้งานได้ในคู่มือการออกแบบ API

การแสดง JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
ช่อง
code

integer

รหัสสถานะซึ่งควรเป็นค่า enum ของ google.rpc.Code
message

string

ข้อความแสดงข้อผิดพลาดที่ส่งถึงนักพัฒนาแอป ซึ่งควรเป็นภาษาอังกฤษ ข้อความแสดงข้อผิดพลาดที่ผู้ใช้เห็นควรได้รับการแปลและส่งในช่อง google.rpc.Status.details หรือแปลโดยไคลเอ็นต์
details[]

object

รายการข้อความที่มีรายละเอียดข้อผิดพลาด API จะใช้ชุดประเภทข้อความทั่วไป