- HTTP isteği
- İstek metni
- Yanıt metni
- Yetkilendirme kapsamları
- QueryDomainStatsRequest
- BatchQueryDomainStatsResult
- Durum
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 ( |
| Alanlar | |
|---|---|
requests[] |
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 ( |
| Alanlar | |
|---|---|
results[] |
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/postmasterhttps://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 ( |
| Alanlar | |
|---|---|
parent |
Zorunlu. İstatistiklerin sorgulandığı üst kaynağın adı. Biçim: domains/{domain} |
metricDefinitions[] |
Zorunlu. Sorgulanacak metrikler. Her metrik için yanıtta kullanılacak özel bir ad tanımlayabilirsiniz. |
timeQuery |
Zorunlu. Metriklerin alınacağı zaman aralığı veya belirli tarihler. |
pageSize |
İ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 |
İ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 |
İ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 |
| Alanlar | |
|---|---|
result birleşik alanı. Ayrı sorgunun sonucu. result aşağıdakilerden yalnızca biri olabilir: |
|
response |
Tekil sorgu için başarılı yanıt. |
error |
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 |
Durum kodu, |
message |
Geliştiriciye yönelik hata mesajı (İngilizce olmalıdır). Kullanıcıya gösterilen tüm hata mesajları yerelleştirilmiş olup |
details[] |
Hata ayrıntılarını içeren mesajların listesi. API'lerin kullanabileceği ortak bir mesaj türleri kümesi vardır. |