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 (ברירת מחדל)

ברירת המחדל של סדר המיון היא בסדר עולה. כדי לציין סדר יורד בשדה, הסיומת 'תיאור' יש להוסיף לשם השדה. לדוגמה, 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.