Method: accounts.list

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

בקשת HTTP

GET https://mybusiness.googleapis.com/v4/accounts

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

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

פרמטרים
pageSize

integer

כמה חשבונות לאחזר בכל דף. ברירת המחדל היא 20, המינימום הוא 2 וגודל הדף המקסימלי הוא 20.
pageToken

string

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

string

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

string

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

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

גוף הבקשה

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

גוף התגובה

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

הודעת תגובה עבור Accounts.ListAccounts.

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

object (Account)

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

string

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

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:

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

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