Method: customBiddingAlgorithms.list

يسرد خوارزميات عروض الأسعار المخصّصة التي يمكن للمستخدِم الحالي الوصول إليها ويمكن استخدامها في استراتيجيات عروض الأسعار.

ويتم تحديد الترتيب من خلال المَعلمة orderBy.

طلب HTTP

GET https://displayvideo.googleapis.com/v1/customBiddingAlgorithms

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

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

المَعلمات
pageSize

integer

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

string

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

string

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

  • displayName (تلقائي)

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

string

تسمح هذه السياسة بالفلترة حسب حقول خوارزمية عروض الأسعار المخصّصة.

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

  • تتألف تعبيرات الفلترة من قيد واحد أو أكثر.
  • يمكن دمج القيود من خلال AND. تستخدم سلسلة من القيود السمة AND ضمنيًا.
  • ويكون للقيود الشكل {field} {operator} {value}.
  • يجب أن يستخدم الحقل customBiddingAlgorithmType عامل التشغيل EQUALS (=).
  • يجب أن يستخدم الحقل displayName عامل التشغيل HAS (:).

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

  • customBiddingAlgorithmType
  • displayName

أمثلة:

  • جميع خوارزميات عروض الأسعار المخصّصة التي يحتوي الاسم المعروض لها على كلمة "سياسة": displayName:"politics".
  • جميع خوارزميات عروض الأسعار المخصّصة التي يكون النوع "script_BASED" لها: customBiddingAlgorithmType=SCRIPT_BASED

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

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

string (int64 format)

رقم تعريف شريك "مساحة العرض والفيديو 360" الذي يمكنه الوصول إلى خوارزمية عروض الأسعار المخصّصة.
advertiserId

string (int64 format)

رقم تعريف المعلِن على "مساحة العرض والفيديو 360" الذي يمكنه الوصول إلى خوارزمية عروض الأسعار المخصّصة.

نص الطلب

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

نص الاستجابة

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

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

object (CustomBiddingAlgorithm)

قائمة خوارزميات عروض الأسعار المخصّصة.

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

string

رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في الاستدعاء التالي إلى طريقة ListCustomBiddingAlgorithmsRequest لاسترداد الصفحة التالية من النتائج. إذا كان هذا الحقل خاليًا، فهذا يعني أن هذه هي الصفحة الأخيرة.

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

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

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

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