Method: accounts.list

همه اکانت ها را برای کاربر احراز هویت شده فهرست می کند. این شامل تمام حساب‌هایی است که کاربر مالک آن است، و همچنین هر حسابی که کاربر برای آن حقوق مدیریت دارد.

درخواست HTTP

GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
parentAccount

string

اختیاری. نام منبع حسابی که قرار است فهرست حساب‌های قابل دسترسی مستقیم برای آن بازیابی شود. این فقط برای سازمان ها و گروه های کاربری منطقی است. اگر خالی باشد، accounts.list را برای کاربر احراز هویت شده برمی گرداند. accounts/{account_id} .

pageSize

integer

اختیاری. چند حساب برای واکشی در هر صفحه. پیش فرض و حداکثر 20 است.

pageToken

string

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

filter

string

اختیاری. فیلتری که حساب ها را برای بازگشت محدود می کند. پاسخ فقط شامل ورودی هایی می شود که با فیلتر مطابقت دارند. اگر filter خالی باشد، هیچ محدودیتی اعمال نمی شود و همه حساب ها (صفحه بندی شده) برای حساب درخواستی بازیابی می شوند.

برای مثال، درخواستی با type=USER_GROUP فقط گروه های کاربری را برمی گرداند.

فیلد type تنها فیلتر پشتیبانی شده است.

درخواست بدن

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

بدن پاسخگو

پیام پاسخ برای Accounts.ListAccounts.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "accounts": [
    {
      object (Account)
    }
  ],
  "nextPageToken": string
}
فیلدها
accounts[]

object ( Account )

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

nextPageToken

string

اگر تعداد حساب‌ها از اندازه صفحه درخواستی بیشتر شود، این فیلد با رمزی برای واکشی صفحه بعدی حساب‌ها در تماس بعدی با accounts.list پر می‌شود. اگر حساب دیگری وجود نداشته باشد، این قسمت در پاسخ وجود ندارد.

محدوده مجوز

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

  • https://www.googleapis.com/auth/business.manage

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