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

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