Method: domains.users.list

کاربرانی را که به یک دامنه دسترسی دارند، فهرست می‌کند.

درخواست HTTP

GET https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/users

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

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

پارامترها
parent

string

الزامی. نام منبع والد که کاربران برای آن فهرست می‌شوند. قالب: domains/{domain}

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

پارامترها
pageSize

integer

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

pageToken

string

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

درخواست بدنه

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

بدنه پاسخ

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

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

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

object ( User )

کاربرانی که به دامنه دسترسی دارند.

nextPageToken

string

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

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

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

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

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