Method: domains.trafficStats.list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
إدراج إحصاءات الزيارات لجميع الأيام المتاحة تعرِض القيمة PERMISSION_DENIED إذا لم يكن لدى المستخدم إذن بالوصول إلى TrafficStats للنطاق.
طلب HTTP
GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المعلمات |
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 التي تم إرجاعها من طلب List سابق، إن توفّر. هذه هي قيمة 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 لتحديد سنة بمفردها أو سنة وشهر لا يُحتسَب فيها اليوم.
|
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# Method: domains.trafficStats.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListTrafficStatsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Date](#Date)\n - [JSON representation](#Date.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nList traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.\n\n### HTTP request\n\n`GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `startDate` | `object (`[Date](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#Date)`)` The earliest day of the metrics to retrieve inclusive. startDate and endDate must both be specified or both left unspecified. If only one is specified, or endDate is earlier in time than startDate, then INVALID_ARGUMENT is returned. |\n| `endDate` | `object (`[Date](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#Date)`)` The most recent day of the metrics to retrieve exclusive. startDate and endDate must both be specified or both left unspecified. If only one is specified, or endDate is earlier in time than startDate, then INVALID_ARGUMENT is returned. |\n| `pageSize` | `integer` Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default. |\n| `pageToken` | `string` The nextPageToken value returned from a previous List request, if any. This is the value of [ListTrafficStatsResponse.next_page_token](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats/list#body.ListTrafficStatsResponse.FIELDS.next_page_token) returned from the previous call to `trafficStats.list` method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for trafficStats.list.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"trafficStats\": [ { object (/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats#TrafficStats) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `trafficStats[]` | `object (`[TrafficStats](/workspace/gmail/postmaster/reference/rest/v1/domains.trafficStats#TrafficStats)`)` The list of TrafficStats. |\n| `nextPageToken` | `string` Token to retrieve the next page of results, or empty if there are no more results in the list. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/postmaster.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nDate\n----\n\nRepresents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:\n\n- A full date, with non-zero year, month, and day values.\n- A month and day, with a zero year (for example, an anniversary).\n- A year on its own, with a zero month and a zero day.\n- A year and month, with a zero day (for example, a credit card expiration date).\n\nRelated types:\n\n- `google.type.TimeOfDay`\n- `google.type.DateTime`\n- [google.protobuf.Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)\n\n| JSON representation |\n|---------------------------------------------------------------|\n| ``` { \"year\": integer, \"month\": integer, \"day\": integer } ``` |\n\n| Fields ||\n|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `year` | `integer` Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |\n| `month` | `integer` Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |\n| `day` | `integer` Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |"]]