Method: accounts.listSubaccounts

הצגת רשימה של כל חשבונות המשנה של חשבון מרובה לקוחות נתון. זוהי חבילה נוחה לשיטה החזקה יותר accounts.list. השיטה הזו תניב את אותן תוצאות כמו קריאה ל-ListsAccounts עם המסנן הבא: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

בקשת HTTP

GET https://merchantapi.googleapis.com/accounts/v1beta/{provider=accounts/*}:listSubaccounts

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
provider

string

חובה. חשבון ההורה. פורמט: accounts/{account}

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

פרמטרים
pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של חשבונות להחזרה. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מצוין, יוחזרו עד 250 חשבונות. הערך המקסימלי הוא 500. ערכים מעל 500 מוגדרים כ-500.

pageToken

string

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

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

גוף הבקשה

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

גוף התשובה

הודעת התגובה של השיטה accounts.listSubaccounts.

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

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

object (Account)

החשבונות שחשבון ההורה הנתון הוא שירות אגרגטור שלהם.

nextPageToken

string

אסימון שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא. אם השדה הזה לא יצוין, לא יהיו דפים נוספים.

היקפי הרשאה

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

  • https://www.googleapis.com/auth/content

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