Method: guaranteedOrders.list

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

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

طلب HTTP

GET https://displayvideo.googleapis.com/v4/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 الفلترة.

الحقل مطلوب.

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