Method: customLists.list

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

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

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

סדר המיון שמוגדר כברירת מחדל הוא סדר עולה. כדי לציין סדר יורד בשדה, צריך להוסיף את הסיומת 'desc' לשם השדה. דוגמה: 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 בקריאה הבאה לשיטה customLists.list כדי לאחזר את דף התוצאות הבא.

היקפי הרשאה

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

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

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