Method: combinedAudiences.list

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

הסדר מוגדר באמצעות הפרמטר orderBy.

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

string

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