Method: sellers.adUnits.list

בתיבת הדו-שיח הזו.

  • לדוגמה: GET /v1/sellers/seller111/adUnits
  • מחזירה רשימה של יחידות מודעות ואסימון כדי לאחזר את הדף הבא, אם הפעולה בוצעה בהצלחה.
  • הפונקציה מחזירה את קוד השגיאה PERMISSION_DENIED אם למשתמש אין גישה לאתר המכירה או שמזהה המפיץ לא קיים.
  • הפונקציה מחזירה את קוד השגיאה INVALID_ARGUMENT אם המוכרים מספקים גודל דף לא תקין או אסימון דף לא תקין.

בקשת HTTP

GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*}/adUnits

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

פרמטרים של נתיב

פרמטרים
parent

string

חובה. המפיץ שהוא הבעלים של אוסף יחידות המודעות הזה. פורמט: sellers/{seller}

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

פרמטרים
pageSize

integer

המספר המקסימלי של פריטים שצריך להחזיר. ייתכן שהשירות יחזיר פחות מהערך הזה. המספר המקסימלי של יחידות מודעות הוא 1,000. ערכים מעל 1,000 ישתנו ל-1,000. אם לא צויין ערך, יוחזרו 1,000 יחידות מודעות לכל היותר.
pageToken

string

הערך NextPageToken שהוחזר מבקשת רשימה קודמת, אם קיימת.
filter

string

מסנן הרשימה. נכון לעכשיו, יש תמיכה בסינון של מזהים חיצוניים ומצבים, עם התחביר: "externalId = [EXTERNAL_ID]" ו-"state = [STATE]". אפשר להשתמש באופרטורים הלוגיים AND ו-OR כדי ליצור מסנני שרשרת. לא ניתן להשתמש ב-AD_UNIT_STATE_DELETED כדי להציג יחידות מודעות שנמחקו. במקום זאת, יש להשתמש ב-show deleted.
orderBy

string

הסדר לפי מחרוזת שמשמש לציון סדר המיון של התוצאות. כרגע יש תמיכה בהזמנה עד updateTime, צריך לציין 'updateTime' כדי לקבל תוצאות ממוינות לפי updateTime בסדר עולה או לפי updateTime desc לסדר יורד.
showDeleted

boolean

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

גוף הבקשה

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

גוף התשובה

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

הודעת תגובה עבור InventoryService.ListAdUnits.

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

object (AdUnit)

הרשימה של יחידות המודעות.
nextPageToken

string

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/doubleclickbidmanager

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