Method: guaranteedOrders.list

בתיבת הדו-שיח הזו מפורטים הזמנות מובטחות שזמינות למשתמש הנוכחי.

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v2/guaranteedOrders

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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

string

מאפשר סינון לפי שדות של הזמנה מובטחת.

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

שדות נתמכים: * guaranteedOrderId * exchange * displayName * status.entityStatus

דוגמאות:

  • כל ההזמנות הפעילות עם התחייבות למחיר הנמוך ביותר: 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 
{
  "guaranteedOrders": [
    {
      object (GuaranteedOrder)
    }
  ],
  "nextPageToken": string
}
שדות
guaranteedOrders[]

object (GuaranteedOrder)

רשימת ההזמנות עם ההתחייבות.

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

string

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

היקפי ההרשאות

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

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

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