Method: inventorySourceGroups.list

בתיבת הדו שיח הזו רשומים קבוצות מקורות של מלאי שטחי פרסום שאליהן המשתמש יכול לגשת.

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v1/inventorySourceGroups

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

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

פרמטרים
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

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

תחביר נתמך:

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

שדות נתמכים:

  • inventorySourceGroupId

האורך המקסימלי של השדה הזה הוא 500 תווים.

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

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

string (int64 format)

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

לשותף לא תהיה גישה לקבוצות מקורות של מלאי שטחי פרסום שבבעלות המפרסם.

advertiserId

string (int64 format)

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

אם קבוצת מקור של מלאי שטחי פרסום היא בבעלות שותף, רק מפרסמים שהקבוצה שותפה איתם באופן מפורש יוכלו לגשת לקבוצה.

גוף הבקשה

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

גוף התגובה

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

הודעת תגובה עבור InventorySourceGroupService.ListInventorySourceGroups.

ייצוג JSON
{
  "inventorySourceGroups": [
    {
      object (InventorySourceGroup)
    }
  ],
  "nextPageToken": string
}
שדות
inventorySourceGroups[]

object (InventorySourceGroup)

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

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

nextPageToken

string

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

היקפי הרשאות

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

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

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