retrievePlannableUserInterests method

Future<RetrievePlannableUserInterestsResponse> retrievePlannableUserInterests(
  1. String advertiserId, {
  2. String? productCategory,
  3. String? $fields,
})

Retrieves Google Audiences (User Interests) available for forecasting.

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 user interests for. Value must have pattern ^\[^/\]+$.

productCategory - Required. The product category to retrieve plannable user interests for. Possible string values are:

  • "PLANNABLE_PRODUCT_CATEGORY_UNSPECIFIED" : Not specified.
  • "YOUTUBE" : YouTube.
  • "OPEN_AUCTION" : Open Auction.

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

Completes with a RetrievePlannableUserInterestsResponse.

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

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

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