Method: customBiddingAlgorithms.list

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

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

בקשת HTTP

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

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

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

פרמטרים
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

דוגמאות:

  • כל האלגוריתמים המותאמים אישית לבידינג שבהם השם המוצג מכיל את המילה politics: 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.