Method: users.list

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

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

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

ברירת המחדל של סדר המיון היא בסדר עולה. כדי לציין סדר יורד בשדה, הסיומת 'תיאור' יש להוסיף לשם השדה. לדוגמה, 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.