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 (ברירת מחדל)

ברירת המחדל של סדר המיון היא בסדר עולה. כדי לציין סדר יורד בשדה, הסיומת 'תיאור' יש להוסיף לשם השדה. דוגמה: 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.