חובה. המזהה של השותף שכל המפרסמים שאוחזרו צריכים להשתייך אליו. המערכת תומכת רק במפרסמים של כרטיסי מוצר עבור שותף אחד בכל פעם.
pageSize
integer
גודל הדף המבוקש. חייב להיות בין 1 ל-200. אם לא צוין ערך, ברירת המחדל תהיה 100.
pageToken
string
אסימון שמזהה דף של תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת ל-method advertisers.list. אם לא מציינים שום אפשרות, יוחזר דף התוצאות הראשון.
orderBy
string
שדה שלפיו ממיינים את הרשימה. הערכים הקבילים הם:
displayName (ברירת מחדל)
entityStatus
updateTime
סדר המיון שמוגדר כברירת מחדל הוא בסדר עולה. כדי לציין סדר יורד של שדה, צריך להוסיף סיומת 'description' לשם השדה. לדוגמה, displayName desc.
filter
string
מאפשר סינון לפי שדות מפרסם.
תחביר נתמך:
ביטויי סינון מורכבים מהגבלה אחת או יותר.
אפשר לשלב את ההגבלות באמצעות אופרטורים לוגיים AND או OR.
המונח של הגבלה הוא {field} {operator} {value}.
השדה updateTime חייב להשתמש באופרטורים GREATER THAN OR EQUAL TO (>=) או LESS THAN OR EQUAL TO (<=).
בכל שאר השדות יש להשתמש באופרטור EQUALS (=).
שדות נתמכים:
advertiserId
displayName
entityStatus
updateTime (קלט בפורמט ISO 8601, או YYYY-MM-DDTHH:MM:SSZ)
דוגמאות:
כל המפרסמים הפעילים אצל שותף: entityStatus="ENTITY_STATUS_ACTIVE"
כל המפרסמים שזמן העדכון שלהם קצר או שווה ל-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"