Method: customBiddingAlgorithms.list

בתיבת הדו-שיח הזו מפורטים אלגוריתמים של בידינג בהתאמה אישית שזמינים למשתמש הנוכחי, ואפשר להשתמש בהם בשיטות הבידינג.

הסדר מוגדר על ידי הפרמטר orderBy.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

גודל הדף המבוקש. חייב להיות בין 1 ל-200. אם לא צוין ערך, ברירת המחדל תהיה 100. מחזירה קוד שגיאה INVALID_ARGUMENT אם צוין ערך לא חוקי.

pageToken

string

אסימון שמזהה דף תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת ל-method customBiddingAlgorithms.list. אם לא מציינים שום אפשרות, יוחזר דף התוצאות הראשון.

orderBy

string

שדה שלפיו תמיין את הרשימה. הערכים הקבילים הם:

  • displayName (ברירת מחדל)

סדר המיון המוגדר כברירת מחדל הוא עולה. כדי לציין סדר יורד לשדה מסוים, צריך להוסיף את הסיומת 'description' לשם השדה. דוגמה: 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. חובה. זיהוי הישות ב-DV360 שבה הבקשה נשלחת. הבקשה LIST תחזיר רק ישויות מוגדרות להתאמה אישית של בידינג שניתן לגשת אליהן לישות DV360 שצוינה בaccessor. כדי לבצע בקשה LIST, צריכה להיות למשתמש הרשאה לישות accessor. הערך של accessor יכול להיות רק אחת מהאפשרויות הבאות:
partnerId

string (int64 format)

המזהה של השותף ב-DV360 שיש לו גישה לאלגוריתם של בידינג בהתאמה אישית.

advertiserId

string (int64 format)

המזהה של המפרסם ב-DV360 שיש לו גישה לאלגוריתם של בידינג בהתאמה אישית.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON
{
  "customBiddingAlgorithms": [
    {
      object (CustomBiddingAlgorithm)
    }
  ],
  "nextPageToken": string
}
שדות
customBiddingAlgorithms[]

object (CustomBiddingAlgorithm)

רשימת האלגוריתמים של הבידינג בהתאמה אישית.

אם הרשימה ריקה, היא לא תופיע.

nextPageToken

string

אסימון לאחזור של דף התוצאות הבא. יש להעביר את הערך הזה בשדה pageToken בקריאה הבאה לשיטה ListCustomBiddingAlgorithmsRequest כדי לאחזר את דף התוצאות הבא. אם השדה הזה הוא null, זה אומר שזה הדף האחרון.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.