batchRunPivotReports method

Future<BatchRunPivotReportsResponse> batchRunPivotReports(
  1. BatchRunPivotReportsRequest request,
  2. String property, {
  3. String? $fields,
})

Returns multiple pivot reports in a batch.

All reports must be for the same GA4 Property.

request - The metadata request object.

Request parameters:

property - A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see where to find your Property ID. This property must be specified for the batch. The property within RunPivotReportRequest may either be unspecified or consistent with this property. Example: properties/1234 Value must have pattern ^properties/\[^/\]+$.

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

Completes with a BatchRunPivotReportsResponse.

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<BatchRunPivotReportsResponse> batchRunPivotReports(
  BatchRunPivotReportsRequest request,
  core.String property, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1beta/' + core.Uri.encodeFull('$property') + ':batchRunPivotReports';

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