Method: users.list

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

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

string

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

string

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

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

סדר המיון המוגדר כברירת מחדל הוא עולה. כדי לציין סדר יורד לשדה מסוים, צריך להוסיף את הסיומת 'description' לשם השדה. לדוגמה, displayName desc.
filter

string

מאפשר סינון לפי מאפייני משתמש.

תחביר נתמך:

  • ביטויי סינון מורכבים מהגבלה אחת או יותר.
  • אפשר לשלב את ההגבלות באמצעות האופרטור הלוגי AND.
  • ההגבלה יכולה להיות {field} {operator} {value}.
  • האופרטור חייב להיות CONTAINS (:) או EQUALS (=).
  • האופרטור צריך להיות CONTAINS (:) בשדות הבאים:
    • displayName
    • email
  • האופרטור צריך להיות EQUALS (=) בשדות הבאים:
    • assignedUserRole.userRole
    • assignedUserRole.partnerId
    • assignedUserRole.advertiserId
    • assignedUserRole.entityType: שדה סינתטי של AssignedUserRole המשמש לסינון. מציין את סוג הישות שאליה מוקצה תפקיד המשתמש. הערכים החוקיים הם Partner ו-Advertiser.
    • assignedUserRole.parentPartnerId: שדה סינתטי של AssignedUserRole המשמש לסינון. הנתון הזה מציין את שותף ההורה של הישות שאליה מוקצה תפקיד המשתמש.

דוגמאות:

  • המשתמש עם displayName שמכיל את foo: displayName:"foo"
  • המשתמש שכתובת האימייל שלו כוללת את bar: email:"bar"
  • כל המשתמשים עם תפקידי משתמש רגילים: assignedUserRole.userRole="STANDARD"
  • כל המשתמשים עם תפקידי משתמשים בשותף 123: assignedUserRole.partnerId="123"
  • כל המשתמשים שהוגדרו להם תפקידי משתמש בחשבון המפרסם 123: assignedUserRole.advertiserId="123"
  • כל המשתמשים עם תפקידי משתמש ברמת השותף: entityType="PARTNER"
  • כל המשתמשים שהוגדרו להם תפקידי משתמשים אצל שותף 123 ומפרסמים מתחת לשותף 123: parentPartnerId="123"

האורך המקסימלי של השדה הזה הוא 500 תווים.

גוף הבקשה

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

גוף התגובה

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

ייצוג 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.