Method: advertisers.insertionOrders.list

בתיבת הדו-שיח הזו מפורטים הזמנות קמפיין של מפרסם.

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/insertionOrders

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

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

פרמטרים
advertiserId

string (int64 format)

חובה. המזהה של המפרסם שעבורו רוצים להציג את הזמנות הקמפיין.

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

פרמטרים
pageSize

integer

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

string

אסימון שמזהה דף תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת ל-method insertionOrders.list. אם לא מציינים זאת, המערכת תחזיר את דף התוצאות הראשון.
orderBy

string

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

  • "displayName" (ברירת מחדל)
  • 'entityStatus'
  • updateTime

ברירת המחדל של סדר המיון היא בסדר עולה. כדי לציין סדר יורד בשדה, הסיומת 'תיאור' יש להוסיף לשם השדה. דוגמה: displayName desc
filter

string

מאפשר סינון לפי שדות של הזמנת קמפיין.

תחביר נתמך:

  • ביטויי הסינון מורכבים מהגבלה אחת או יותר.
  • אפשר לשלב את ההגבלות באמצעות אופרטורים לוגיים AND או OR. רצף של הגבלות משתמש באופן מרומז ב-AND.
  • הגבלה היא בצורה הבאה: {field} {operator} {value}.
  • השדה updateTime חייב להשתמש באופרטורים GREATER THAN OR EQUAL TO (>=) או LESS THAN OR EQUAL TO (<=).
  • בכל שאר השדות צריך להשתמש באופרטור EQUALS (=).

שדות נתמכים:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (קלט בפורמט ISO 8601 או YYYY-MM-DDTHH:MM:SSZ)

דוגמאות:

  • כל הזמנות הקמפיין בקמפיין: campaignId="1234"
  • כל הזמנות הקמפיין מסוג ENTITY_STATUS_ACTIVE או ENTITY_STATUS_PAUSED שמשויכות למפרסם: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • כל הזמנות הקמפיין שמועד העדכון שלהן הוא פחות מ-2020-11-04T18:54:47Z (בפורמט ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • כל הזמנות הקמפיין שמועד העדכון שלהן גדול מ-2020-11-04T18:54:47Z (בפורמט ISO 8601): updateTime>="2020-11-04T18:54:47Z"

האורך של השדה הזה לא יעלה על 500 תווים.

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

גוף הבקשה

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

גוף התשובה

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

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

object (InsertionOrder)

הרשימה של הזמנות הקמפיין.

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

string

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

היקפי ההרשאות

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

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

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