Method: customBiddingAlgorithms.list

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

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

طلب HTTP

GET https://displayvideo.googleapis.com/v3/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

أمثلة:

  • جميع خوارزميات عروض الأسعار المخصّصة التي يحتوي اسمها المعروض على "politics": 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 Overview.