get method

Future<Report> get(
  1. String jobId,
  2. String reportId, {
  3. String? onBehalfOfContentOwner,
  4. String? $fields,
})

Gets the metadata of a specific report.

Request parameters:

jobId - The ID of the job.

reportId - The ID of the report to retrieve.

onBehalfOfContentOwner - The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).

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

Completes with a Report.

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<Report> get(
  core.String jobId,
  core.String reportId, {
  core.String? onBehalfOfContentOwner,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (onBehalfOfContentOwner != null)
      'onBehalfOfContentOwner': [onBehalfOfContentOwner],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/jobs/' +
      commons.escapeVariable('$jobId') +
      '/reports/' +
      commons.escapeVariable('$reportId');

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