get method

Future<CombinedAudience> get(
  1. String combinedAudienceId, {
  2. String? advertiserId,
  3. String? partnerId,
  4. String? $fields,
})

Gets a combined audience.

Request parameters:

combinedAudienceId - Required. The ID of the combined audience to fetch. Value must have pattern ^\[^/\]+$.

advertiserId - The ID of the advertiser that has access to the fetched combined audience.

partnerId - The ID of the partner that has access to the fetched combined audience.

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

Completes with a CombinedAudience.

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

  final url_ =
      'v2/combinedAudiences/' + core.Uri.encodeFull('$combinedAudienceId');

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