retrievePlannableLocations method

Future<RetrievePlannableLocationsResponse> retrievePlannableLocations(
  1. String advertiserId, {
  2. String? $fields,
})

Retrieves the list of countries where reach forecasting is supported.

API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users.

Request parameters:

advertiserId - Required. The ID of the advertiser to list plannable locations for. Value must have pattern ^\[^/\]+$.

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

Completes with a RetrievePlannableLocationsResponse.

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<RetrievePlannableLocationsResponse> retrievePlannableLocations(
  core.String advertiserId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'v4/advertisers/' +
      core.Uri.encodeFull('$advertiserId') +
      '/reachForecast:retrievePlannableLocations';

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