Method: users.list

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

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

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

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

string

אסימון שמזהה דף תוצאות שהשרת אמור להציג. בדרך כלל, זהו הערך של nextPageToken שהוחזר מהקריאה הקודמת לשיטה 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"
  • כל המשתמשים עם תפקידי משתמשים ברמת השותף: 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 בקריאה הבאה לשיטה users.list. האסימון הזה לא יופיע אם אין יותר תוצאות להציג.

היקפי הרשאה

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

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

מידע נוסף זמין בOAuth 2.0 Overview.