Method: accounts.listSubaccounts

Wymień wszystkie subkonta danego multikonta klientów. Jest to wygodny kod zapewniający bardziej wydajną metodę accounts.list. Ta metoda zapewni takie same wyniki jak wywołanie metody ListsAccounts z tym filtrem: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
provider

string

Wymagane. Konto nadrzędne. Format: accounts/{account}

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Maksymalna liczba kont do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie określono inaczej, zwrócony zostanie maksymalnie 250 kont. Maksymalna wartość to 500. Wartości powyżej 500 zostaną zmienione na 500.

pageToken

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania funkcji accounts.list. Podaj go, aby pobrać kolejną stronę.

Podczas dzielenia na strony wszystkie pozostałe parametry podane w narzędziu accounts.list muszą być zgodne z wywołaniem, które dostarczyło token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat odpowiedzi dla metody accounts.listSubaccounts.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "accounts": [
    {
      object (Account)
    }
  ],
  "nextPageToken": string
}
Pola
accounts[]

object (Account)

Konta, w przypadku których dane konto nadrzędne jest pośrednikiem.

nextPageToken

string

Token, który może zostać wysłany jako pageToken w celu pobrania następnej strony. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.