Method: guaranteedOrders.list

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

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

בקשת HTTP

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

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

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

פרמטרים
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 exchanges: ‏ 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 בקריאה הבאה לשיטה guaranteedOrders.list כדי לאחזר את דף התוצאות הבא.

היקפי הרשאות

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

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

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