Method: accounts.list

يسرد جميع حسابات المستخدم الذي تمت مصادقته. ويشمل ذلك جميع الحسابات التي يملكها المستخدم، بالإضافة إلى أي حسابات يملك المستخدم حقوق إدارتها.

طلب HTTP

GET https://mybusiness.googleapis.com/v4/accounts

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

معلمات طلب البحث

المَعلمات
pageSize

integer

عدد الحسابات المطلوب جلبها لكل صفحة. الإعداد التلقائي هو 20 والحد الأدنى هو 2 والحد الأقصى لحجم الصفحة هو 20.
pageToken

string

وفي حال تحديد ذلك، يتم استرداد الصفحة التالية من الحسابات. يتم عرض pageToken عندما تؤدي استدعاء accounts.list إلى عرض نتائج أكثر مما يمكن أن يلائم حجم الصفحة المطلوب.
name

string

اسم مورد الحساب الذي سيتم استرداد قائمة الحسابات التي يمكن الوصول إليها مباشرةً من خلاله. وهذا مفيد فقط للمؤسسات ومجموعات المستخدمين. في حال ترك هذا الحقل فارغًا، سيتم عرض accounts.list للمستخدم الذي تمت مصادقته.
filter

string

فلتر يقيد الحسابات للعودة. لا يتضمن الرد سوى الإدخالات التي تتطابق مع الفلتر. إذا كانت قيمة الحقل "filter" فارغة، لن يتم تطبيق أي قيود وسيتم استرداد جميع الحسابات (المقسّمة على صفحات) للحساب المطلوب.

على سبيل المثال، سيؤدي الطلب الذي يتضمّن الفلتر type=USER_GROUP إلى عرض مجموعات المستخدِمين فقط.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

رسالة الرد لـ accounts.ListAccounts.

تمثيل JSON 
{
  "accounts": [
    {
      object (Account)
    }
  ],
  "nextPageToken": string
}
الحقول
accounts[]

object (Account)

مجموعة من الحسابات التي يمكن للمستخدم الوصول إليها. سيكون الحساب الشخصي للمستخدم الذي يجري الاستعلام دائمًا هو العنصر الأول من النتيجة، ما لم تتم تصفيته.
nextPageToken

string

إذا تجاوز عدد الحسابات حجم الصفحة المطلوب، ستتم تعبئة هذا الحقل برمز مميّز لجلب الصفحة التالية من الحسابات عند إجراء مكالمة لاحقة إلى accounts.list. إذا لم يكن هناك المزيد من الحسابات، لن يظهر هذا الحقل في الردّ.

نطاقات الأذونات

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.