Method: accounts.list

רשימה של כל החשבונות של המשתמש המאומת. הדרישה הזו כוללת את כל החשבונות שבבעלות המשתמש, וכן חשבונות שעבורם יש למשתמש זכויות ניהול.

בקשת HTTP

GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts

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

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

פרמטרים
parentAccount

string

זה שינוי אופציונלי. שם המשאב של החשבון שעבורו יש לאחזר את רשימת החשבונות שניתן לגשת אליהם ישירות. הכלל הזה מתאים רק לארגונים ולקבוצות משתמשים. אם השדה ריק, הפונקציה תחזיר את הערך accounts.list עבור המשתמש המאומת. accounts/{account_id}.
pageSize

integer

זה שינוי אופציונלי. כמה חשבונות לאחזר בכל דף. ערך ברירת המחדל והערך המקסימלי הוא 20.
pageToken

string

זה שינוי אופציונלי. אם צוין, דף החשבונות הבא יאוחזר. הערך pageToken מוחזר כאשר קריאה אל accounts.list מחזירה תוצאות רבות יותר ממה שיכולות להתאים לגודל הדף המבוקש.
filter

string

זה שינוי אופציונלי. מסנן שמגביל את החשבונות להחזרה. התשובה כוללת רק רשומות שתואמות למסנן. אם השדה filter ריק, לא יחולו אילוצים וכל החשבונות (החלוקה לדפים) מאוחזרים לחשבון המבוקש.

לדוגמה, בקשה עם המסנן type=USER_GROUP תחזיר רק קבוצות משתמשים.

השדה type הוא המסנן היחיד שנתמך.

גוף הבקשה

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

גוף התשובה

הודעת תשובה לגבי Accounts.ListAccounts.

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

ייצוג JSON 
{
  "accounts": [
    {
      object (Account)
    }
  ],
  "nextPageToken": string
}
שדות
accounts[]

object (Account)

אוסף של חשבונות למשתמש יש גישה אליהם. החשבון האישי של המשתמש שמבצע את השאילתה יהיה תמיד הפריט הראשון של התוצאה, אלא אם הוא לא יסוונן.
nextPageToken

string

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

היקפי ההרשאות

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

  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.