רשימה של כל החשבונות של המשתמש המאומת. זה כולל את כל החשבונות שבבעלות המשתמש, וכן חשבונות שבהם יש למשתמש זכויות ניהול.
בקשת HTTP
GET https://mybusiness.googleapis.com/v4/accounts
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
כמה חשבונות לאחזר בכל דף. ברירת המחדל היא 20, המינימום הוא 2 וגודל הדף המקסימלי הוא 20. |
pageToken |
אם צוין, הדף הבא של החשבונות יאוחזר. הערך |
name |
שם המשאב של החשבון שעבורו יש לאחזר את רשימת החשבונות הנגישים באופן ישיר. הדבר הגיוני רק לארגונים ולקבוצות משתמשים. אם השדה יישאר ריק, הפונקציה מחזירה את הערך |
filter |
מסנן שמגביל את החזרה של החשבונות. התשובה תכלול רק ערכים שתואמים למסנן. אם השדה לדוגמה, בקשה עם המסנן |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
הודעת תגובה עבור Accounts.ListAccounts.
ייצוג JSON | |
---|---|
{
"accounts": [
{
object ( |
שדות | |
---|---|
accounts[] |
אוסף של חשבונות שאליהם למשתמש יש גישה. החשבון האישי של המשתמש שמבצע את השאילתה יהיה תמיד הפריט הראשון של התוצאה, אלא אם יתבצע סינון. |
nextPageToken |
אם מספר החשבונות חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון שיאפשר אחזור של דף החשבונות הבא בקריאה הבאה אל |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.