Method: users.list

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

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

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

בקשת HTTP

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

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

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

פרמטרים
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.