Method: firstPartyAndPartnerAudiences.list

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

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

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

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

תחביר נתמך:

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

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

  • displayName

דוגמאות:

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

האורך של השדה הזה לא יכול להיות יותר מ-500 תווים.

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

string (int64 format)

המזהה של השותף שיש לו גישה לקהלים שאוחזרו מאינטראקציה ישירה ומקהלים של שותפים.
advertiserId

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

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

object (FirstPartyAndPartnerAudience)

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

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

string

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

היקפי הרשאות

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

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.