Method: domains.domainStats.query

Belirli bir alan ve dönem için alan istatistiklerinin listesini alır. Alan için DomainStats'e erişim izniniz yoksa PERMISSION_DENIED değerini döndürür.

HTTP isteği

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

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

Yol parametreleri

Parametreler
parent

string

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

İstek metni

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

JSON gösterimi
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Alanlar
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.

Yanıt metni

Başarılıysa yanıt metni, QueryDomainStatsResponse öğesinin bir örneğini içerir.

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.