Method: customLists.list

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

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

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

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

תחביר נתמך:

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

שדות נתמכים:

  • displayName

דוגמאות:

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

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

לקבלת מידע נוסף, אפשר לעיין במדריך שלנו בנושא בקשות לסינון LIST.
advertiserId

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

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

object (CustomList)

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

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

string

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

היקפי הרשאות

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

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

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