Method: guaranteedOrders.list

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

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

طلب HTTP

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

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

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

المَعلمات
pageSize

integer

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

string

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

string

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

  • displayName (تلقائي)

يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي لأحد الحقول، يجب إضافة اللاحقة "تنازلي" إلى اسم الحقل. مثلاً: 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.