Method: firstAndThirdPartyAudiences.list

רשימת קהלים מאינטראקציה ישירה (first-party) ושל צד שלישי.

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

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

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

תחביר נתמך:

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

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

  • displayName

דוגמאות:

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

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

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

string (int64 format)

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

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

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

object (FirstAndThirdPartyAudience)

רשימת הקהלים מאינטראקציה ישירה (first-party) ומצד שלישי. מאפייני גודל הקהל לא ייכללו.

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

string

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

היקפי הרשאה

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

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

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