Method: guaranteedOrders.list

يسرد الطلبات المضمونة التي يمكن للمستخدم الحالي الوصول إليها.

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

طلب HTTP

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

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

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

المعلمات
pageSize

integer

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

string

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

string

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

  • displayName (تلقائي)

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

string

يسمح بالتصفية حسب حقول الطلبات المضمونة.

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

الحقول المسموح بها: * guaranteedOrderId * exchange * displayName * status.entityStatus

أمثلة:

  • جميع الطلبات النشطة المضمونة: 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 
{
  "guaranteedOrders": [
    {
      object (GuaranteedOrder)
    }
  ],
  "nextPageToken": string
}
الحقول
guaranteedOrders[]

object (GuaranteedOrder)

قائمة الطلبات المضمونة

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

string

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

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

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

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

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