list method

Future<ListProductsResponse> list(
  1. String accountId, {
  2. String? filter,
  3. int? pageSize,
  4. String? pageToken,
  5. String? $fields,
})

List all products visible to the buyer (optionally filtered by the specified PQL query).

Request parameters:

accountId - Account ID of the buyer.

filter - An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered.

pageSize - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.

pageToken - The page token as returned from ListProductsResponse.

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

Completes with a ListProductsResponse.

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<ListProductsResponse> list(
  core.String accountId, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final _queryParams = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'v2beta1/accounts/' +
      commons.escapeVariable('$accountId') +
      '/products';

  final _response = await _requester.request(
    _url,
    'GET',
    queryParams: _queryParams,
  );
  return ListProductsResponse.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}