Method: domainStats.batchQuery

Birden fazla alan için bir grup QueryDomainStats isteğini yürütür. İstenen alanlardan herhangi birinin DomainStats'ine erişme izniniz yoksa PERMISSION_DENIED değerini döndürür.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
Alanlar
requests[]

object (QueryDomainStatsRequest)

Zorunlu. Ayrı sorgu isteklerinin listesi. Her istek farklı bir alan için olabilir. Tek bir toplu işe en fazla 100 istek eklenebilir.

Yanıt metni

domainStats.batchQuery için yanıt mesajı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
Alanlar
results[]

object (BatchQueryDomainStatsResult)

BatchQueryDomainStatsRequest'teki her sorgu için bir yanıt içeren yanıt listesi. Yanıtların sırası, isteklerin sırasına karşılık gelir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.

QueryDomainStatsRequest

QueryDomainStats için istek mesajı.

JSON gösterimi
{
  "parent": string,
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Alanlar
parent

string

Zorunlu. İstatistiklerin sorgulandığı üst kaynağın adı. Biçim: domains/{domain}

metricDefinitions[]

object (MetricDefinition)

Zorunlu. Sorgulanacak metrikler. Her metrik için yanıtta kullanılacak özel bir ad tanımlayabilirsiniz.

timeQuery

object (TimeQuery)

Zorunlu. Metriklerin alınacağı zaman aralığı veya belirli tarihler.

pageSize

integer

İsteğe bağlıdır. Yanıt olarak döndürülecek maksimum DomainStats kaynağı sayısı. Sunucu bu değerden daha az sonuç döndürebilir. Belirtilmezse varsayılan olarak 10 değeri kullanılır. Maksimum değer 200'dür.

pageToken

string

İsteğe bağlıdır. Önceki bir List isteğinden döndürülen nextPageToken değeri (varsa). Toplama ayrıntı düzeyi GÜNLÜK ise sayfa jetonu, kodlanmış tarih + "/" + metrik adı olur. Toplama ayrıntı düzeyi OVERALL ise sayfa jetonu, kodlanmış metrik adı olur.

aggregationGranularity

enum (AggregationGranularity)

İsteğe bağlıdır. İstatistiklerin toplanacağı ayrıntı düzeyi. Belirtilmemişse varsayılan olarak DAILY (GÜNLÜK) olur.

BatchQueryDomainStatsResult

Bir toplu işlemdeki tek bir QueryDomainStatsRequest'in sonucunu temsil eder.

JSON gösterimi
{

  // 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.
}
Alanlar
result birleşik alanı. Ayrı sorgunun sonucu. result aşağıdakilerden yalnızca biri olabilir:
response

object (QueryDomainStatsResponse)

Tekil sorgu için başarılı yanıt.

error

object (Status)

Ayrı sorgu başarısız olursa hata durumu.

Durum

Status türü, REST API'ler ve RPC API'ler dahil olmak üzere farklı programlama ortamlarına uygun mantıksal bir hata modeli tanımlar. gRPC tarafından kullanılır. Her Status mesajı; hata kodu, hata mesajı ve hata ayrıntıları olmak üzere üç veri içerir.

Bu hata modeli ve nasıl kullanılacağı hakkında daha fazla bilgiyi API Tasarım Kılavuzu'nda bulabilirsiniz.

JSON gösterimi
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Alanlar
code

integer

Durum kodu, google.rpc.Code enum değeri olmalıdır.

message

string

Geliştiriciye yönelik hata mesajı (İngilizce olmalıdır). Kullanıcıya gösterilen tüm hata mesajları yerelleştirilmiş olup google.rpc.Status.details alanında gönderilmeli veya istemci tarafından yerelleştirilmelidir.

details[]

object

Hata ayrıntılarını içeren mesajların listesi. API'lerin kullanabileceği ortak bir mesaj türleri kümesi vardır.