getIdMappingFile method

Future<Object> getIdMappingFile(String agencyId, String advertiserId, { String? $fields, DownloadOptions downloadOptions = commons.DownloadOptions.metadata, })

Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360.

The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360.

Request parameters:

agencyId - Legacy SA360 agency ID.

advertiserId - Legacy SA360 advertiser ID.

$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

• IdMappingFile 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> getIdMappingFile(
  core.String agencyId,
  core.String advertiserId, {
  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/agency/' +
      commons.escapeVariable('$agencyId') +
      '/advertiser/' +
      commons.escapeVariable('$advertiserId') +
      '/idmapping';

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