Method: customBiddingAlgorithms.scripts.list

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

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

طلب HTTP

GET https://displayvideo.googleapis.com/v5/customBiddingAlgorithms/{customBiddingAlgorithmId}/scripts

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

مَعلمات المسار

المعلمات
customBiddingAlgorithmId

string (int64 format)

الحقل مطلوب. رقم تعريف خوارزمية عروض الأسعار المخصّصة التي تملك النص البرمجي

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

المعلمات
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • createTime desc (تلقائي)

نظام الترتيب التلقائي هو الترتيب التنازلي. لتحديد ترتيب تصاعدي لحقل معيّن، يجب إزالة اللاحقة "desc". مثال: createTime

الحقل مطلوب. تحدّد هذه السمة جهة "مساحة العرض والفيديو 360" التي تملك خوارزمية عروض الأسعار المخصّصة الرئيسية. ويمكن أن يكون شريكًا أو معلِنًا. في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
partnerId

string (int64 format)

رقم تعريف الشريك الذي يملك خوارزمية عروض الأسعار المخصّصة الرئيسية

سيتمكّن هذا الشريك فقط من الوصول إلى نص عرض الأسعار المخصّص هذا لإجراء تعديلات عليه.

advertiserId

string (int64 format)

رقم تعريف المعلِن الذي يملك خوارزمية عروض الأسعار المخصّصة الرئيسية

نهاية الحقول التي يستبعد كلّ منها الآخر

نص الطلب

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

نص الاستجابة

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

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

object (CustomBiddingScript)

قائمة النصوص البرمجية لعروض الأسعار المخصّصة

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

nextPageToken

string

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

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.