Method: advertisers.insertionOrders.list

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

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

בקשת HTTP

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

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

סדר המיון שמוגדר כברירת מחדל הוא עולה. כדי לציין סדר יורד בשדה, צריך להוסיף את הסיומת 'desc' לשם השדה. דוגמה: 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 Overview.