Method: domains.list

فهرستی از تمام دامنه‌های ثبت‌شده توسط شما، به همراه فراداده‌های مربوط به آنها را بازیابی می‌کند. ترتیب دامنه‌ها در پاسخ نامشخص و غیرقطعی است. دامنه‌های تازه ثبت‌شده لزوماً به انتهای این فهرست اضافه نمی‌شوند.

درخواست HTTP

GET https://gmailpostmastertools.googleapis.com/v2beta/domains

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
pageSize

integer

اختیاری. اندازه صفحه درخواستی. سرور ممکن است دامنه‌های کمتری نسبت به درخواست را برگرداند. در صورت عدم تعیین، مقدار پیش‌فرض برای این فیلد ۱۰ است. حداکثر مقدار برای این فیلد ۲۰۰ است.

pageToken

string

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

درخواست بدنه

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

بدنه پاسخ

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

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "domains": [
    {
      object (Domain)
    }
  ],
  "nextPageToken": string
}
فیلدها
domains[]

object ( Domain )

دامنه‌هایی که توسط کاربر ثبت شده‌اند.

nextPageToken

string

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

دامنه‌های مجوز

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

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

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