Method: combinedAudiences.list

רשימה של קהלים משולבים.

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

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

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

תחביר נתמך:

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

שדות נתמכים:

  • displayName

דוגמאות:

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

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

לקבלת מידע נוסף, אפשר לעיין במדריך שלנו בנושא בקשות לסינון LIST.
פרמטר האיחוד accessor. חובה. מציינת באיזו ישות ב-DV360 הבקשה נשלחת. הבקשה LIST תחזיר רק ישויות קהלים משולבות שניתן לגשת אליהן לישות ב-DV360 שצוינה בaccessor. accessor יכול להיות רק אחת מהאפשרויות הבאות:
partnerId

string (int64 format)

המזהה של השותף שיש לו גישה לקהלים המשולבים שאוחזרו.
advertiserId

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

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

object (CombinedAudience)

רשימת הקהלים המשולבים.

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

string

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

היקפי ההרשאות

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

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

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