get method

Future<Object> get(
  1. String profileId,
  2. String reportId,
  3. String fileId, {
  4. String? $fields,
  5. DownloadOptions downloadOptions = commons.DownloadOptions.metadata,
})

Retrieves a report file by its report ID and file ID.

This method supports media download.

Request parameters:

profileId - The Campaign Manager 360 user profile ID.

reportId - The ID of the report.

fileId - The ID of the report file.

$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

  • File for Metadata downloads (see downloadOptions).

  • commons.Media for Media downloads (see downloadOptions).

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<core.Object> get(
  core.String profileId,
  core.String reportId,
  core.String fileId, {
  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_ = 'userprofiles/' +
      commons.escapeVariable('$profileId') +
      '/reports/' +
      commons.escapeVariable('$reportId') +
      '/files/' +
      commons.escapeVariable('$fileId');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
    downloadOptions: downloadOptions,
  );
  if (downloadOptions.isMetadataDownload) {
    return File.fromJson(response_ as core.Map<core.String, core.dynamic>);
  } else {
    return response_ as commons.Media;
  }
}