Method: customBiddingAlgorithms.list

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

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

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
pageSize

integer

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

string

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

string (int64 format)

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

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

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

object (CustomBiddingAlgorithm)

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

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

string

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

היקפי הרשאות

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

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.