Method: customLists.list

הצגת רשימות מותאמות אישית.

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v2/customLists

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
pageSize

integer

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

string

אסימון שמזהה דף של תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת ל-method customLists.list. אם לא מציינים שום אפשרות, יוחזר דף התוצאות הראשון.
orderBy

string

שדה שלפיו ממיינים את הרשימה. הערכים הקבילים הם:

  • customListId (ברירת מחדל)
  • displayName

סדר המיון שמוגדר כברירת מחדל הוא בסדר עולה. כדי לציין סדר יורד של שדה, צריך להוסיף סיומת 'description' לשם השדה. דוגמה: displayName desc
filter

string

מאפשר סינון לפי שדות רשימה בהתאמה אישית.

תחביר נתמך:

  • ביטויי סינון לרשימות בהתאמה אישית יכולים להכיל הגבלה אחת לכל היותר.
  • המונח של הגבלה הוא {field} {operator} {value}.
  • יש להשתמש באופרטור HAS (:) בכל השדות.

שדות נתמכים:

  • displayName

דוגמאות:

  • כל הרשימות בהתאמה אישית שהשם המוצג שלהן מכיל את "Google": displayName:"Google".

האורך של השדה הזה לא יעלה על 500 תווים.

למידע נוסף, אפשר לעיין במדריך שלנו בנושא סינון בקשות LIST.
פרמטר איחוד accessor. חובה. זיהוי הישות ב-DV360 שבה הבקשה נשלחת. הבקשה LIST תחזיר רק ישויות של רשימות בהתאמה אישית שניתן לגשת אליהן לישות DV360 שצוינה ב-accessor. accessor יכול להיות רק אחד מהבאים:
advertiserId

string (int64 format)

המזהה של המפרסם ב-DV360 שיש לו גישה לרשימות המותאמות אישית שאוחזרו.

גוף הבקשה

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

גוף התשובה

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

ייצוג JSON 
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
שדות
customLists[]

object (CustomList)

הרשימה של הרשימות המותאמות אישית.

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

string

אסימון לאחזור של דף התוצאות הבא. צריך להעביר את הערך הזה בשדה pageToken בקריאה הבאה ל-method של customLists.list כדי לאחזר את דף התוצאות הבא.

היקפי הרשאות

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

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

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.