Method: accounts.listSubaccounts

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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.