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.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2024-10-14 (שעון UTC).
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2024-10-14 (שעון UTC)."],[[["Lists all accounts owned by or accessible to the authenticated user, including their personal account."],["Allows filtering accounts by type and specifying the parent account for retrieval."],["Supports pagination to retrieve large lists of accounts using `pageToken`."],["The response includes an array of `Account` objects and a `nextPageToken` for further results."],["Requires the `https://www.googleapis.com/auth/business.manage` OAuth scope for authorization."]]],["This API retrieves a list of accounts for an authenticated user via a `GET` request to a specified URL. The user can filter the accounts by type, specify the page size, and use a `pageToken` for pagination. An optional `parentAccount` parameter retrieves accounts directly accessible from that account. The request body must be empty, and the successful response includes an array of account objects and, if applicable, a `nextPageToken` for further pagination. This uses OAuth 2.0 with the `business.manage` scope.\n"]]
