Method: guaranteedOrders.list

הצגת רשימה של הזמנות מובטחות שהמשתמש הנוכחי יכול לגשת אליהן.

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

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

string

אסימון שמזהה את דף התוצאות שהשרת צריך להחזיר. בדרך כלל, זה הערך של nextPageToken שמוחזר מהקריאה הקודמת ל-method‏ 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_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

האורך של השדה הזה לא יכול להיות יותר מ-500 תווים.

מידע נוסף זמין במדריך בנושא סינון בקשות LIST.

חובה.

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

string (int64 format)

המזהה של השותף שיש לו גישה להזמנה המובטחת.
advertiserId

string (int64 format)

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

גוף הבקשה

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

גוף התשובה

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

ייצוג ב-JSON 
{
  "guaranteedOrders": [
    {
      object (GuaranteedOrder)
    }
  ],
  "nextPageToken": string
}
שדות
guaranteedOrders[]

object (GuaranteedOrder)

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

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

string

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

היקפי הרשאות

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

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.