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.