Method: domains.list
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
دامنه های ثبت شده توسط مشتری را لیست می کند. ترتیب دامنه ها در پاسخ نامشخص و غیر قطعی است. دامنه های تازه ایجاد شده لزوماً به انتهای این لیست اضافه نمی شوند.
درخواست HTTP
GET https://gmailpostmastertools.googleapis.com/v1/domains
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
پارامترها |
---|
pageSize | integer اندازه صفحه درخواستی سرور ممکن است دامنه های کمتری نسبت به درخواست خود برگرداند. اگر مشخص نباشد، سرور یک پیش فرض مناسب را انتخاب می کند. |
pageToken | string مقدار nextPageToken از یک درخواست لیست قبلی، در صورت وجود، برگردانده شده است. این مقدار ListDomainsResponse.next_page_token است که از فراخوانی قبلی به روش domains.list بازگردانده شده است. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پیام پاسخ برای domains.list.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"domains": [
{
object (Domain )
}
],
"nextPageToken": string
} |
فیلدها |
---|
domains[] | object ( Domain ) لیست دامنه ها |
nextPageToken | string نشانه برای بازیابی صفحه بعدی نتایج، یا خالی کردن اگر نتایج دیگری در لیست وجود ندارد. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/postmaster.readonly
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: domains.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListDomainsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.\n\n### HTTP request\n\n`GET https://gmailpostmastertools.googleapis.com/v1/domains`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. Server may return fewer domains 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 [ListDomainsResponse.next_page_token](/workspace/gmail/postmaster/reference/rest/v1/domains/list#body.ListDomainsResponse.FIELDS.next_page_token) returned from the previous call to `domains.list` method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for domains.list.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"domains\": [ { object (/workspace/gmail/postmaster/reference/rest/v1/domains#Domain) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------|\n| `domains[]` | `object (`[Domain](/workspace/gmail/postmaster/reference/rest/v1/domains#Domain)`)` The list of domains. |\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)."]]