Method: domains.trafficStats.list

فهرست آمار ترافیک برای همه روزهای موجود. اگر کاربر مجوز دسترسی به TrafficStats برای دامنه را نداشته باشد، PERMISSION_DENIED را برمی‌گرداند.

درخواست HTTP

GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
parent

string

نام منبع دامنه ای که می خواهیم آمار ترافیک آن را فهرست کنیم. باید فرم domains/{domain_name} را داشته باشد که در آن domain_name نام دامنه کاملا واجد شرایط است.

پارامترهای پرس و جو

پارامترها
startDate

object ( Date )

اولین روز از سنجه ها برای بازیابی فراگیر. startDate و endDate باید هر دو مشخص شوند یا هر دو نامشخص باقی بمانند. اگر فقط یکی مشخص شده باشد یا پایان تاریخ زودتر از تاریخ شروع باشد، INVALID_ARGUMENT برگردانده می شود.

endDate

object ( Date )

آخرین روز از معیارهای بازیابی انحصاری. startDate و endDate باید هر دو مشخص شوند یا هر دو نامشخص باقی بمانند. اگر فقط یکی مشخص شده باشد یا پایان تاریخ زودتر از تاریخ شروع باشد، INVALID_ARGUMENT برگردانده می شود.

pageSize

integer

اندازه صفحه درخواستی سرور ممکن است TrafficStats کمتری از درخواستی را برگرداند. اگر مشخص نباشد، سرور یک پیش فرض مناسب را انتخاب می کند.

pageToken

string

مقدار nextPageToken از یک درخواست لیست قبلی، در صورت وجود، برگردانده شده است. این مقدار ListTrafficStatsResponse.next_page_token است که از تماس قبلی با متد trafficStats.list برگردانده شده است.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پیام پاسخ برای trafficStats.list.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "trafficStats": [
    {
      object (TrafficStats)
    }
  ],
  "nextPageToken": string
}
فیلدها
trafficStats[]

object ( TrafficStats )

لیست TrafficStats.

nextPageToken

string

نشانه برای بازیابی صفحه بعدی نتایج، یا خالی کردن اگر نتایج دیگری در لیست وجود ندارد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

تاریخ

نمایانگر یک تاریخ تقویم کامل یا جزئی، مانند روز تولد است. زمان روز و منطقه زمانی یا در جای دیگری مشخص شده است یا ناچیز است. تاریخ مربوط به تقویم میلادی است. این می تواند نشان دهنده یکی از موارد زیر باشد:

  • تاریخ کامل، با مقادیر سال، ماه و روز غیر صفر.
  • یک ماه و روز، با یک سال صفر (مثلاً یک سالگرد).
  • یک سال به تنهایی، با یک ماه صفر و یک روز صفر.
  • یک سال و یک ماه، با روز صفر (مثلاً تاریخ انقضای کارت اعتباری).

انواع مرتبط:

نمایندگی JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
فیلدها
year

integer

سال تاریخ. برای تعیین تاریخ بدون سال باید از 1 تا 9999 یا 0 باشد.

month

integer

ماه از یک سال. باید از 1 تا 12 یا 0 باشد تا یک سال بدون ماه و روز مشخص شود.

day

integer

روز یک ماه. باید از 1 تا 31 باشد و برای سال و ماه معتبر باشد، یا 0 برای مشخص کردن یک سال به تنهایی یا یک سال و ماهی که در آن روز مهم نیست، معتبر باشد.

،

فهرست آمار ترافیک برای همه روزهای موجود. اگر کاربر مجوز دسترسی به TrafficStats برای دامنه را نداشته باشد، PERMISSION_DENIED را برمی‌گرداند.

درخواست HTTP

GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
parent

string

نام منبع دامنه ای که می خواهیم آمار ترافیک آن را فهرست کنیم. باید فرم domains/{domain_name} را داشته باشد که در آن domain_name نام دامنه کاملا واجد شرایط است.

پارامترهای پرس و جو

پارامترها
startDate

object ( Date )

اولین روز از سنجه ها برای بازیابی فراگیر. startDate و endDate باید هر دو مشخص شوند یا هر دو نامشخص باقی بمانند. اگر فقط یکی مشخص شده باشد یا پایان تاریخ زودتر از تاریخ شروع باشد، INVALID_ARGUMENT برگردانده می شود.

endDate

object ( Date )

آخرین روز از معیارهای بازیابی انحصاری. startDate و endDate باید هر دو مشخص شوند یا هر دو نامشخص باقی بمانند. اگر فقط یکی مشخص شده باشد یا پایان تاریخ زودتر از تاریخ شروع باشد، INVALID_ARGUMENT برگردانده می شود.

pageSize

integer

اندازه صفحه درخواستی سرور ممکن است TrafficStats کمتری از درخواستی را برگرداند. اگر مشخص نباشد، سرور یک پیش فرض مناسب را انتخاب می کند.

pageToken

string

مقدار nextPageToken از یک درخواست لیست قبلی، در صورت وجود، برگردانده شده است. این مقدار ListTrafficStatsResponse.next_page_token است که از تماس قبلی با متد trafficStats.list برگردانده شده است.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پیام پاسخ برای trafficStats.list.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "trafficStats": [
    {
      object (TrafficStats)
    }
  ],
  "nextPageToken": string
}
فیلدها
trafficStats[]

object ( TrafficStats )

لیست TrafficStats.

nextPageToken

string

نشانه برای بازیابی صفحه بعدی نتایج، یا خالی کردن اگر نتایج دیگری در لیست وجود ندارد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

تاریخ

نمایانگر یک تاریخ تقویم کامل یا جزئی، مانند روز تولد است. زمان روز و منطقه زمانی یا در جای دیگری مشخص شده است یا ناچیز است. تاریخ مربوط به تقویم میلادی است. این می تواند نشان دهنده یکی از موارد زیر باشد:

  • تاریخ کامل، با مقادیر سال، ماه و روز غیر صفر.
  • یک ماه و روز، با یک سال صفر (مثلاً یک سالگرد).
  • یک سال به تنهایی، با یک ماه صفر و یک روز صفر.
  • یک سال و یک ماه، با روز صفر (مثلاً تاریخ انقضای کارت اعتباری).

انواع مرتبط:

نمایندگی JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
فیلدها
year

integer

سال تاریخ. برای تعیین تاریخ بدون سال باید از 1 تا 9999 یا 0 باشد.

month

integer

ماه از یک سال. باید از 1 تا 12 یا 0 باشد تا یک سال بدون ماه و روز مشخص شود.

day

integer

روز یک ماه. باید از 1 تا 31 باشد و برای سال و ماه معتبر باشد، یا 0 برای مشخص کردن یک سال به تنهایی یا یک سال و ماهی که در آن روز مهم نیست، معتبر باشد.