Method: guaranteedOrders.list

רשימה של הזמנות מובטחות שזמינות למשתמש הנוכחי.

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

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