getFile method

Future<Media?> getFile(
  1. String reportId,
  2. int reportFragment, {
  3. String? $fields,
  4. DownloadOptions downloadOptions = commons.DownloadOptions.metadata,
})

Downloads a report file encoded in UTF-8.

Request parameters:

reportId - ID of the report.

reportFragment - The index of the report fragment to download.

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

downloadOptions - Options for downloading. A download can be either a Metadata (default) or Media download. Partial Media downloads are possible as well.

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<commons.Media?> getFile(
  core.String reportId,
  core.int reportFragment, {
  core.String? $fields,
  commons.DownloadOptions downloadOptions = commons.DownloadOptions.metadata,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'doubleclicksearch/v2/reports/' +
      commons.escapeVariable('$reportId') +
      '/files/' +
      commons.escapeVariable('$reportFragment');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
    downloadOptions: downloadOptions,
  );
  if (downloadOptions.isMetadataDownload) {
    return null;
  } else {
    return response_ as commons.Media;
  }
}