Method: inventorySources.list

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

הסדר מוגדר על ידי הפרמטר orderBy. אם לא יצוין filter על ידי entityStatus, מקורות של מלאי שטחי פרסום עם סטטוס הישות ENTITY_STATUS_ARCHIVED לא ייכללו בתוצאות.

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

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

תחביר נתמך:

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

שדות נתמכים:

  • status.entityStatus
  • commitment
  • deliveryMethod
  • rateDetails.rateType
  • exchange

דוגמאות:

  • כל המקורות הפעילים של מלאי שטחי הפרסום: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • מקורות של מלאי שטחי פרסום ששייכים לבורסות של Google Ad Manager או Rubicon: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

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

string (int64 format)

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

string (int64 format)

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

גוף הבקשה

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

גוף התגובה

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

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

object (InventorySource)

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

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

string

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

היקפי הרשאות

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

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

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