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

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