Method: firstPartyAndPartnerAudiences.list

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

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

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

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

תחביר נתמך:

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

שדות נתמכים:

  • displayName

דוגמאות:

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

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

מידע נוסף זמין במדריך בנושא בקשות לסינון LIST.

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

string (int64 format)

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

advertiserId

string (int64 format)

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

סוף השדות הבלעדיים.

גוף הבקשה

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

גוף התשובה

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

ייצוג ב-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.