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