בתיבת הדו שיח הזו רשומים הזמנות הזמינות.
- לדוגמה: GET /v1/sellers/321/availabilityOrders
- מחזירה רשימה של הזמנות זמינות ואסימון כדי לאחזר את הדף הבא אם הפעולה בוצעה בהצלחה.
- הפונקציה מחזירה את קוד השגיאה
PERMISSION_DENIEDאם למשתמש אין גישה לאתר המכירה או שמזהה המפיץ לא קיים. - הפונקציה מחזירה את קוד השגיאה
INVALID_ARGUMENTאם המוכרים מספקים גודל דף לא תקין או אסימון דף לא תקין.
בקשת HTTP
GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*}/availabilityOrders
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
| פרמטרים | |
|---|---|
parent |
חובה. ההורה שהוא הבעלים של האוסף הזה של הזמנות זמינות. פורמט: sellers/{seller} |
פרמטרים של שאילתה
| פרמטרים | |
|---|---|
pageSize |
המספר המקסימלי של פריטים שצריך להחזיר. ייתכן שהשירות יחזיר פחות מהערך הזה. המספר המקסימלי המותר של הזמנות זמינות הוא 1,000. אם לא צויין ערך, יוחזרו לכל היותר 1,000 הזמנות זמינות. |
pageToken |
הערך NextPageToken שהוחזר מבקשת רשימה קודמת, אם קיימת. |
filter |
מסנן הרשימה. כרגע יש תמיכה בסינון לפי מצב, עם התחביר: "state = [STATE]". אפשר להשתמש באופרטורים הלוגיים AND ו-OR כדי ליצור מסנני שרשרת. |
orderBy |
הסדר לפי מחרוזת שמשמש לציון סדר המיון של התוצאות. כרגע יש תמיכה בהזמנה עד |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
| ייצוג JSON |
|---|
{
"availabilityOrders": [
{
object ( |
| שדות | |
|---|---|
availabilityOrders[] |
רשימת ההזמנות הזמינות. |
nextPageToken |
אסימון לאחזור של דף התוצאות הבא. צריך להעביר את הערך הזה בשדה |
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/doubleclickbidmanager
למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.