Method: inventorySourceGroups.list

تعرض هذه السمة مجموعات مصادر المستودع الإعلاني التي يمكن للمستخدم الحالي الوصول إليها.

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

طلب HTTP

GET https://displayvideo.googleapis.com/v3/inventorySourceGroups

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

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

المعلمات
pageSize

integer

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

pageToken

string

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

orderBy

string

الحقل الذي سيتم ترتيب القائمة حسبه القيم المقبولة هي:

  • displayName (تلقائي)
  • inventorySourceGroupId

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

filter

string

تسمح هذه السمة بالفلترة حسب حقول مجموعة مصادر المساحات الإعلانية.

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

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

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

  • inventorySourceGroupId

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

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

مَعلمة الاتحاد accessor. مطلوب. تحدّد هذه السمة عنصر "مساحة العرض والفيديو 360" الذي يتمّ تقديم الطلب فيه. لن يعرض طلب LIST سوى عناصر مجموعة مصادر المستودع الإعلاني التي يمكن الوصول إليها من خلال عنصر "مساحة العرض والفيديو 360" المحدّد في accessor. يمكن أن تكون accessor إحدى القيم التالية فقط:
partnerId

string (int64 format)

رقم تعريف الشريك الذي يمكنه الوصول إلى مجموعة مصادر المساحات الإعلانية.

لا يمكن لأحد الشركاء الوصول إلى مجموعات مصادر المساحات الإعلانية التي يملكها المعلِن.

advertiserId

string (int64 format)

رقم تعريف المعلِن الذي يمكنه الوصول إلى مجموعة مصادر المساحات الإعلانية.

إذا كانت مجموعة مصادر المستودع الإعلاني مملوكة لشريك، لا يمكن للمعلِنين الوصول إلى المجموعة إلا إذا تمت مشاركتها معهم بشكل صريح.

نص الطلب

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

نص الاستجابة

رسالة الردّ على InventorySourceGroupService.ListInventorySourceGroups

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

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

object (InventorySourceGroup)

قائمة بمجموعات مصادر المساحات الإعلانية

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

nextPageToken

string

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

نطاقات التفويض

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.