בתיבת הדו-שיח הזו מפורטים המשתמשים שיכולים לגשת למשתמש הנוכחי. אם לשני משתמשים יש תפקידי משתמש באותו שותף או מפרסם, הם יכולים לגשת זה לזה.
לשיטה הזו יש דרישות אימות ייחודיות. קרא את הדרישות המוקדמות במדריך לניהול משתמשים לפני השימוש בשיטה זו.
התכונה 'אני רוצה לנסות את השיטה הזו' לא פועלת בשיטה הזו.
בקשת HTTP
GET https://displayvideo.googleapis.com/v3/users
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
גודל הדף המבוקש. חייב להיות בין |
pageToken |
אסימון שמזהה דף של תוצאות שהשרת צריך להחזיר. בדרך כלל, זהו הערך של |
orderBy |
שדה שלפיו ממיינים את הרשימה. הערכים הקבילים הם:
סדר המיון שמוגדר כברירת מחדל הוא בסדר עולה. כדי לציין סדר יורד של שדה, צריך להוסיף סיומת 'description' לשם השדה. לדוגמה, |
filter |
מאפשר סינון לפי שדות משתמש. תחביר נתמך:
שדות נתמכים:
דוגמאות:
האורך של השדה הזה לא יעלה על 500 תווים. למידע נוסף, אפשר לעיין במדריך שלנו בנושא סינון בקשות |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"users": [
{
object ( |
שדות | |
---|---|
users[] |
רשימת המשתמשים. אם הרשימה ריקה, היא לא תופיע. |
nextPageToken |
אסימון לאחזור של דף התוצאות הבא. צריך להעביר את הערך הזה בשדה |
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/display-video-user-management
למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.