Method: firstPartyAndPartnerAudiences.list

רשימת קהלים מאינטראקציה ישירה וקהלים של שותפים.

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v4/firstPartyAndPartnerAudiences

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

זה שינוי אופציונלי. מאפשר סינון לפי שדות של קהלים מאינטראקציה ישירה (First-Party) ושל קהלים של שותפים.

תחביר נתמך:

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

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

  • displayName

דוגמאות:

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

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

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

string (int64 format)

המזהה של השותף שיש לו גישה לקהלים מאינטראקציה ישירה (First-Party) ולקהלים של השותף שאוחזרו.
advertiserId

string (int64 format)

המזהה של המפרסם שיש לו גישה לקהלים מאינטראקציה ישירה (First-Party) ולקהלים של שותפים שאוחזרו.

גוף הבקשה

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

גוף התשובה

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

ייצוג ב-JSON 
{
  "firstPartyAndPartnerAudiences": [
    {
      object (FirstPartyAndPartnerAudience)
    }
  ],
  "nextPageToken": string
}
שדות
firstPartyAndPartnerAudiences[]

object (FirstPartyAndPartnerAudience)

רשימת הקהלים מאינטראקציה ישירה ומקהלים של שותפים. מאפייני גודל הקהל לא ייכללו.

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

string

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

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.