גודל הדף המבוקש. חייב להיות בין 1 ל-200. אם לא צוין ערך, ברירת המחדל תהיה 100. מחזירה קוד שגיאה INVALID_ARGUMENT אם צוין ערך לא חוקי.
pageToken
string
אסימון שמזהה דף תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת ל-method lineItems.list. אם לא מציינים שום אפשרות, יוחזר דף התוצאות הראשון.
orderBy
string
שדה שלפיו תמיין את הרשימה. הערכים הקבילים הם:
displayName (ברירת מחדל)
entityStatus
updateTime
סדר המיון המוגדר כברירת מחדל הוא עולה. כדי לציין סדר יורד לשדה מסוים, צריך להוסיף את הסיומת 'description' לשם השדה. דוגמה: 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
insertionOrderId
lineItemId
lineItemType
updateTime (קלט בפורמט ISO 8601 או YYYY-MM-DDTHH:MM:SSZ)
דוגמאות:
כל הפריטים בהזמנת קמפיין: 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"
כל הפריטים שזמן העדכון שלהם קצר או שווה ל-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"