listChildAccounts method

Future<ListChildAccountsResponse> listChildAccounts(String parent, { String? fullName, String? labelId, int? pageSize, String? pageToken, String? $fields, })

Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.

Request parameters:

parent - Required. The parent account. Must be a CSS group or domain. Format: accounts/{account} Value must have pattern ^accounts/\[^/\]+$.

fullName - If set, only the MC accounts with the given name (case sensitive) will be returned.

labelId - If set, only the MC accounts with the given label ID will be returned.

pageSize - Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 100; values above 100 will be coerced to 100.

pageToken - Optional. A page token, received from a previous ListChildAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListChildAccounts must match the call that provided the page token.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListChildAccountsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ListChildAccountsResponse> listChildAccounts(
  core.String parent, {
  core.String? fullName,
  core.String? labelId,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'fullName': ?fullName == null ? null : [fullName],
    'labelId': ?labelId == null ? null : [labelId],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + ':listChildAccounts';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ListChildAccountsResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}