Method: customBiddingAlgorithms.list

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

הסדר מוגדר באמצעות הפרמטר orderBy.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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.