Method: sellers.orders.list

מציגה הזמנות.

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

בקשת HTTP

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

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

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

פרמטרים
parent

string

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

string

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

גוף הבקשה

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

גוף התשובה

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

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

object (Order)

רשימת ההזמנות.
nextPageToken

string

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

היקפי הרשאות

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

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

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