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 و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2024-11-14 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2024-11-14 بهوقت ساعت هماهنگ جهانی."],[[["Lists domains registered by the client, with an unspecified order."],["Allows pagination using `pageSize` and `pageToken` query parameters."],["Requires `https://www.googleapis.com/auth/postmaster.readonly` authorization scope for access."],["Returns a list of domains and a token for retrieving the next page if available."],["The request body should be empty for this `GET` request to the specified endpoint."]]],["This document details how to list registered domains via an API. A `GET` request is sent to `https://gmailpostmastertools.googleapis.com/v1/domains` with an empty request body. Optional `pageSize` and `pageToken` query parameters control pagination. The response contains a list of `domains` and a `nextPageToken` for subsequent pages. The response body's JSON representation outlines its structure. Access requires the `https://www.googleapis.com/auth/postmaster.readonly` authorization scope.\n"]]
