Method: customLists.list

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

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

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

מאפשר סינון לפי שדות של רשימת לקוחות.

תחביר נתמך:

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

השדות הנתמכים:

  • displayName

דוגמאות:

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

האורך של השדה הזה לא יכול להיות יותר מ-500 תווים.

מידע נוסף זמין במדריך בנושא סינון בקשות LIST.
חובה. מזהה את הישות ב-DV360 שבה הבקשה מתבצעת. בקשת ה-LIST תחזיר רק ישויות של רשימות בהתאמה אישית שיש לישות של DV360 גישה אליהן, שמזוהות בתוך 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 Overview.