Method: organizations.list

تعرض هذه الطريقة قائمة بالمؤسسات التي يمكن للمستخدم الوصول إليها.

طلب HTTP

GET https://marketingplatformadmin.googleapis.com/v1alpha/organizations

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

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

المعلمات
pageSize

integer

اختيارية: الحد الأقصى لعدد المؤسسات المطلوب عرضه في مكالمة واحدة. قد تعرض الخدمة عددًا أقل من هذه القيمة.

إذا لم يتم تحديدها، سيتم عرض 50 مؤسسة كحد أقصى. الحد الأقصى للقيمة هو 1000، وسيتم فرض القيمة 1000 على القيم الأكبر من 1000.

pageToken

string

اختيارية: رمز مميّز للصفحة تم استلامه من طلب organizations.list سابق. يجب تقديم هذا الرمز لاسترداد الصفحة التالية.

عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى organizations.list مع الطلب الذي قدّم رمز الصفحة المميز.

نص الطلب

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

نص الاستجابة

رسالة الرد على إجراء RPC الخاص بـ organizations.list

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

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

object (Organization)

مورد المؤسسة الذي يمكن للمستخدم الوصول إليه، والذي يتضمّن معرّف المؤسسة واسم العرض

nextPageToken

string

رمز مميز يمكن إرساله كـ pageToken لاسترداد الصفحة التالية في حال حذف هذا الحقل، لن تكون هناك صفحات لاحقة.

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

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.update