גודל הדף המבוקש. חייב להיות בין 1 ל-200. אם לא צוין ערך, ברירת המחדל תהיה 100.
pageToken
string
אסימון שמזהה דף תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת ל-method users.list. אם לא מציינים שום אפשרות, יוחזר דף התוצאות הראשון.
orderBy
string
שדה שלפיו תמיין את הרשימה. הערכים הקבילים הם:
displayName (ברירת מחדל)
סדר המיון המוגדר כברירת מחדל הוא עולה. כדי לציין סדר יורד לשדה מסוים, צריך להוסיף את הסיומת 'description' לשם השדה. לדוגמה, displayName desc.
filter
string
מאפשר סינון לפי שדות משתמש.
תחביר נתמך:
ביטויי סינון מורכבים מהגבלה אחת או יותר.
אפשר לשלב את ההגבלות באמצעות האופרטור הלוגי AND.
ההגבלה יכולה להיות {field} {operator} {value}.
השדה budget.budget_segments.date_range.end_date חייב לכלול את האופרטור LESS THAN (<).
האופרטור displayName andemailfield must use theHAS (:)`.
בכל שאר השדות יש להשתמש באופרטור EQUALS (=).
שדות נתמכים:
assignedUserRole.advertiserId
assignedUserRole.entityType
זהו שדה סינתטי של AssignedUserRole שמשמש לסינון. מציין את סוג הישות שאליה מוקצה תפקיד המשתמש. הערכים החוקיים הם Partner ו-Advertiser.
assignedUserRole.parentPartnerId
זהו שדה סינתטי של AssignedUserRole שמשמש לסינון. המזהה של שותף ההורה של הישות שאליה מוקצה תפקיד המשתמש.
assignedUserRole.partnerId
assignedUserRole.userRole
displayName
email
דוגמאות:
המשתמש שהפונקציה 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"
אסימון לאחזור של דף התוצאות הבא. יש להעביר את הערך הזה בשדה pageToken בקריאה הבאה לשיטה users.list כדי לאחזר את דף התוצאות הבא. אם לא יהיו עוד תוצאות להחזיר, האסימון הזה יהיה חסר.