Method: firstAndThirdPartyAudiences.list

הצגת רשימה של קהלים של צד ראשון ושל צד שלישי.

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v2/firstAndThirdPartyAudiences

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

סדר המיון שמוגדר כברירת מחדל הוא בסדר עולה. כדי לציין סדר יורד של שדה, צריך להוסיף סיומת 'description' לשם השדה. דוגמה: 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 
{
  "firstAndThirdPartyAudiences": [
    {
      object (FirstAndThirdPartyAudience)
    }
  ],
  "nextPageToken": string
}
שדות
firstAndThirdPartyAudiences[]

object (FirstAndThirdPartyAudience)

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

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

string

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

היקפי הרשאות

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

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

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