Method: users.list

הצגת רשימה של משתמשים שלמשתמש הנוכחי יש גישה אליהם. אם לשני משתמשים יש תפקידים באותו שותף או מפרסם, הם יכולים לגשת זה לזה.

לשיטה הזו יש דרישות אימות ייחודיות. לפני שמשתמשים בשיטה הזו, צריך לקרוא את הדרישות המוקדמות במדריך לניהול משתמשים.

התכונה "התנסות בשיטה הזו" לא פועלת בשיטה הזו.

בקשת HTTP

GET https://displayvideo.googleapis.com/v5/users

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
pageSize

integer

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

string

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

string

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

  • ‫displayName (ברירת מחדל)

סדר המיון המוגדר כברירת מחדל הוא סדר עולה. כדי לציין סדר יורד לשדה, צריך להוסיף את הסיומת "desc" לשם השדה. לדוגמה, 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"
  • כל המשתמשים עם תפקידי משתמש ברמת Partner: entityType="PARTNER"
  • כל המשתמשים עם תפקידי משתמשים בשותף 123 ובמפרסמים שמשויכים לשותף 123: parentPartnerId="123"
  • כל המשתמשים שהתחברו לאחרונה בתאריך 2023-01-01T00:00:00Z או אחריו (פורמט ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

האורך של השדה הזה לא יכול להיות יותר מ-500 תווים.

מידע נוסף זמין במדריך בנושא סינון בקשות LIST.

גוף הבקשה

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

גוף התשובה

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

ייצוג ב-JSON 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
שדות
users[]

object (User)

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

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

string

אסימון לאחזור של דף התוצאות הבא. צריך להעביר את הערך הזה בשדה pageToken בקריאה הבאה ל-method‏ users.list כדי לאחזר את דף התוצאות הבא. האסימון הזה לא יופיע אם אין עוד תוצאות להחזיר.

היקפי הרשאות

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

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.