גודל הדף המבוקש. חייב להיות בין 1 ל-200. אם לא צוין ערך, ברירת המחדל תהיה 100.
pageToken
string
אסימון שמזהה דף של תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת ל-method users.list. אם לא מציינים שום אפשרות, יוחזר דף התוצאות הראשון.
orderBy
string
שדה שלפיו ממיינים את הרשימה. הערכים הקבילים הם:
displayName (ברירת מחדל)
סדר המיון שמוגדר כברירת מחדל הוא בסדר עולה. כדי לציין סדר יורד של שדה, צריך להוסיף סיומת 'description' לשם השדה. לדוגמה, displayName desc.
filter
string
מאפשר סינון לפי שדות משתמש.
תחביר נתמך:
ביטויי סינון מורכבים מהגבלה אחת או יותר.
אפשר לשלב את ההגבלות באמצעות האופרטור הלוגי AND.
המונח של הגבלה הוא {field} {operator} {value}.
השדות displayName ו-email חייבים להשתמש באופרטור HAS (:).
השדה lastLoginTime חייב להשתמש באופרטור LESS THAN OR EQUAL TO (<=) או GREATER THAN OR EQUAL TO (>=).
בכל שאר השדות יש להשתמש באופרטור EQUALS (=).
שדות נתמכים:
assignedUserRole.advertiserId
assignedUserRole.entityType: זהו שדה סינתטי של AssignedUserRole שמשמש לסינון. מזהה את סוג הישות שאליה מוקצה תפקיד המשתמש. הערכים החוקיים הם Partner ו-Advertiser.
assignedUserRole.parentPartnerId: זהו שדה סינתטי של AssignedUserRole שמשמש לסינון. מזהה השותף ההורה של הישות שאליה מוקצה תפקיד המשתמש.
assignedUserRole.partnerId
assignedUserRole.userRole
displayName
email
lastLoginTime (קלט בפורמט ISO 8601, או YYYY-MM-DDTHH:MM:SSZ)
דוגמאות:
המשתמש עם displayName שמכיל את "foo": displayName:"foo"
המשתמש שהערך שלו הוא email שמכיל את "bar": email:"bar"
כל המשתמשים עם תפקידי משתמש רגילים: assignedUserRole.userRole="STANDARD"
כל המשתמשים עם תפקידי משתמש בשותף 123: assignedUserRole.partnerId="123"
כל המשתמשים עם תפקידי משתמש בחשבון המפרסם 123: assignedUserRole.advertiserId="123"
כל המשתמשים עם תפקידי משתמש ברמת השותף: entityType="PARTNER"
כל המשתמשים עם תפקידי משתמש אצל שותף 123 ומפרסמים מתחת לגיל 123: parentPartnerId="123"
כל המשתמשים שנכנסו בפעם האחרונה בשנת 2023-01-01T00:00:00Z (בפורמט ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"
אסימון לאחזור של דף התוצאות הבא. צריך להעביר את הערך הזה בשדה pageToken בקריאה הבאה ל-method של users.list כדי לאחזר את דף התוצאות הבא. אם אין עוד תוצאות להחזיר, האסימון הזה חסר.