query method

Future<DimensionValueList> query(DimensionValueRequest request, String profileId, { int? maxResults, String? pageToken, String? $fields, })

Retrieves list of report dimension values for a list of filters.

request - The metadata request object.

Request parameters:

profileId - The Campaign Manager 360 user profile ID.

maxResults - Maximum number of results to return.

pageToken - The value of the nextToken from the previous result page.

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

Completes with a DimensionValueList.

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<DimensionValueList> query(
  DimensionValueRequest request,
  core.String profileId, {
  core.int? maxResults,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'userprofiles/' +
      commons.escapeVariable('$profileId') +
      '/dimensionvalues/query';

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