הצגת רשימות בהתאמה אישית.
הסדר מוגדר על ידי הפרמטר orderBy
.
בקשת HTTP
GET https://displayvideo.googleapis.com/v3/customLists
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
גודל הדף המבוקש. חייב להיות בין |
pageToken |
אסימון שמזהה דף תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של |
orderBy |
שדה שלפיו תמיין את הרשימה. הערכים הקבילים הם:
סדר המיון המוגדר כברירת מחדל הוא עולה. כדי לציין סדר יורד לשדה מסוים, צריך להוסיף את הסיומת 'description' לשם השדה. דוגמה: |
filter |
מאפשר סינון לפי שדות רשימה בהתאמה אישית. תחביר נתמך:
שדות נתמכים:
דוגמאות:
האורך המקסימלי של השדה הזה הוא 500 תווים. מידע נוסף זמין במדריך שלנו בנושא סינון בקשות |
פרמטר איחוד accessor . חובה. זיהוי הישות ב-DV360 שבה הבקשה נשלחת. הבקשה LIST תחזיר רק ישויות של רשימה בהתאמה אישית שניתן לגשת אליהן לישות ב-DV360 שצוינה ב-accessor . הערך של accessor יכול להיות רק אחת מהאפשרויות הבאות: |
|
advertiserId |
המזהה של המפרסם ב-DV360 שיש לו גישה לרשימות בהתאמה אישית שאוחזרו. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"customLists": [
{
object ( |
שדות | |
---|---|
customLists[] |
רשימת הרשימות בהתאמה אישית. אם הרשימה ריקה, היא לא תופיע. |
nextPageToken |
אסימון לאחזור של דף התוצאות הבא. יש להעביר את הערך הזה בשדה |
היקפי הרשאות
נדרש היקף OAuth הבא:
https://www.googleapis.com/auth/display-video
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.