Method: advertisers.lineItems.list

בתיבת הדו-שיח הזו מוצגים פריטים של מפרסם.

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

בקשת HTTP

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/lineItems

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

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

פרמטרים
advertiserId

string (int64 format)

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

  • displayName (ברירת מחדל)
  • entityStatus
  • flight.dateRange.endDate
  • updateTime

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

string

מאפשר סינון לפי מאפייני פריט.

תחביר נתמך:

  • ביטויי סינון מורכבים מהגבלה אחת או יותר.
  • אפשר לשלב את ההגבלות באמצעות אופרטורים לוגיים AND או OR. רצף של הגבלות משתמש באופן לא מפורש ב-AND.
  • ההגבלה יכולה להיות {field} {operator} {value}.
  • מספר האופרטור שבו נעשה שימוש ב-flight.dateRange.endDate חייב להיות פחות מ-(<).
  • האופרטור שנעשה בו שימוש ב-updateTime חייב להיות GREATER THAN OR EQUAL TO (>=) או LESS THAN OR EQUAL TO (<=).
  • האופרטור שנעשה בו שימוש ב-warningMessages חייב להיות HAS (:).
  • האופרטורים שבהם נעשה שימוש בכל השדות האחרים חייבים להיות EQUALS (=).
  • מאפיינים נתמכים:
    • campaignId
    • displayName
    • insertionOrderId
    • entityStatus
    • lineItemId
    • lineItemType
    • flight.dateRange.endDate (קלט בפורמט YYYY-MM-DD)
    • warningMessages
    • flight.triggerId
    • updateTime (קלט בפורמט ISO 8601 או YYYY-MM-DDTHH:MM:SSZ)
    • targetedChannelId
    • targetedNegativeKeywordListId

דוגמאות:

  • כל הפריטים בהזמנת קמפיין: insertionOrderId="1234"
  • כל הפריטים מסוג ENTITY_STATUS_ACTIVE או ENTITY_STATUS_PAUSED ו-LINE_ITEM_TYPE_DISPLAY_DEFAULT של מפרסם: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • כל הפריטים שתאריכי הפרסום שלהם מסתיימים לפני 28 במרץ 2019: flight.dateRange.endDate<"2019-03-28"
  • כל הפריטים שמכילים NO_VALID_CREATIVE ב-warningMessages: warningMessages:"NO_VALID_CREATIVE"
  • כל הפריטים שזמן העדכון שלהם קצר מ-2020-11-04T18:54:47Z (format of ISO 8601) או שווה לו: updateTime<="2020-11-04T18:54:47Z"
  • כל הפריטים שמועד העדכון שלהם הוא 2020-11-04T18:54:47Z (format of ISO 8601) ומעלה: updateTime>="2020-11-04T18:54:47Z"
  • כל הפריטים שהטירגוט שלהם כולל גם ערוץ שצוין וגם רשימת מילות מפתח שליליות שצוינה: targetedNegativeKeywordListId=789 AND targetedChannelId=12345

האורך המקסימלי של השדה הזה הוא 500 תווים.

גוף הבקשה

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

גוף התגובה

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

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

object (LineItem)

רשימת הפריטים.

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

string

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

היקפי הרשאות

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

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

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