Method: customBiddingAlgorithms.list

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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. חובה. מזהה את הישות ב-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 Overview.