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" الذي يتم تقديم الطلب ضمنه. لن يعرض طلب "القائمة" سوى كيانات الطلبات المضمونة التي يمكن لكيان "مساحة العرض والفيديو 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.