Method: inventorySources.list

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

يتم تحديد الترتيب من خلال المَعلمة orderBy. في حال عدم تحديد filter حسب entityStatus، لن يتم تضمين مصادر المستودع التي تحمل حالة العنصر ENTITY_STATUS_ARCHIVED في النتائج.

طلب HTTP

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

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

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

المعلمات
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • displayName (تلقائي)

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

filter

string

السماح بالفلترة حسب حقول مصدر المستودع

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

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

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

  • status.entityStatus
  • commitment
  • deliveryMethod
  • rateDetails.rateType
  • exchange

أمثلة:

  • جميع مصادر المستودع النشطة: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • مصادر المستودع التي تنتمي إلى "مدير إعلانات Google" أو تبادلات Rubicon: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

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

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

string (int64 format)

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

advertiserId

string (int64 format)

رقم تعريف المعلِن الذي لديه إذن الوصول إلى مصدر المستودع

نص الطلب

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

نص الاستجابة

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

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

object (InventorySource)

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

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

nextPageToken

string

رمز مميز لاسترداد الصفحة التالية من النتائج. نقْل هذه القيمة في حقل pageToken في الطلب اللاحق لطريقة inventorySources.list لاسترداد الصفحة التالية من النتائج.

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

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

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

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