list method

Future<TvCampaignSummariesListResponse> list(
  1. String profileId, {
  2. String? accountId,
  3. String? name,
  4. String? $fields,
})

Retrieves a list of TV campaign summaries.

Request parameters:

profileId - Required. User profile ID associated with this request. Value must have pattern ^\[^/\]+$.

accountId - Required. Account ID associated with this request.

name - Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field.

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

Completes with a TvCampaignSummariesListResponse.

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<TvCampaignSummariesListResponse> list(
  core.String profileId, {
  core.String? accountId,
  core.String? name,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (accountId != null) 'accountId': [accountId],
    if (name != null) 'name': [name],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'userprofiles/' +
      core.Uri.encodeFull('$profileId') +
      '/tvCampaignSummaries';

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