Method: partners.list

يسرد الشركاء الذين يمكن للمستخدم الحالي الوصول إليه.

ويتم تحديد الترتيب من خلال المَعلمة orderBy.

طلب HTTP

GET https://displayvideo.googleapis.com/v1/partners

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

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

المَعلمات
pageSize

integer

حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين 1 و200. وفي حال عدم تحديد ذلك، سيتم ضبط القيمة التلقائية على 100.

pageToken

string

يشير هذا المصطلح إلى رمز مميّز يحدّد صفحة من النتائج التي يجب أن يعرضها الخادم. عادةً ما تكون هذه هي قيمة nextPageToken التي تم إرجاعها من الاستدعاء السابق إلى طريقة partners.list. إذا لم يتم تحديد ذلك، سيتم عرض الصفحة الأولى من النتائج.

orderBy

string

الحقل الذي سيتم ترتيب القائمة بناءً عليه. القيم المقبولة هي:

  • displayName

يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي لأحد الحقول، يجب إضافة اللاحقة "desc" إلى اسم الحقل. مثلاً: displayName desc

filter

string

تسمح هذه السياسة بالفلترة حسب حقول الشريك.

البنية المتوافقة:

  • تتألف تعبيرات الفلترة من قيد واحد أو أكثر.
  • يمكن دمج القيود من خلال عاملَي التشغيل المنطقي AND أو OR. تستخدم سلسلة من القيود السمة AND ضمنيًا.
  • ويكون للقيود الشكل {field} {operator} {value}.
  • يجب أن تستخدم جميع الحقول عامل التشغيل EQUALS (=).

الحقول المتاحة:

  • entityStatus

أمثلة:

  • كل الشركاء النشطين: entityStatus="ENTITY_STATUS_ACTIVE"

يجب ألا يزيد طول هذا الحقل عن 500 حرف.

يمكنك الرجوع إلى دليل طلبات LIST للفلترة للحصول على مزيد من المعلومات.

نص الطلب

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

نص الاستجابة

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

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

object (Partner)

قائمة الشركاء

لن يتم ملء هذه القائمة إذا كانت فارغة.

nextPageToken

string

رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في الاستدعاء التالي إلى طريقة partners.list لاسترداد الصفحة التالية من النتائج.

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

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/display-video

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