listAssignedTargetingOptions method

Future<BulkListCampaignAssignedTargetingOptionsResponse> listAssignedTargetingOptions(String advertiserId, String campaignId, { String? filter, String? orderBy, int? pageSize, String? pageToken, String? $fields, })

Lists assigned targeting options of a campaign across targeting types.

Request parameters:

advertiserId - Required. The ID of the advertiser the campaign belongs to. Value must have pattern ^\[^/\]+$.

campaignId - Required. The ID of the campaign to list assigned targeting options for. Value must have pattern ^\[^/\]+$.

filter - Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the OR logical operator. * A restriction has the form of {field} {operator} {value}. * All fields must use the EQUALS (=) operator. Supported fields: * targetingType * inheritance Examples: * AssignedTargetingOption resources of targeting type TARGETING_TYPE_LANGUAGE or TARGETING_TYPE_GENDER: targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER" * AssignedTargetingOption resources with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER: inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER" The length of this field should be no more than 500 characters. Reference our [filter LIST requests](/display-video/api/guides/how-tos/filters) guide for more information.

orderBy - Field by which to sort the list. Acceptable values are: * targetingType (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: targetingType desc.

pageSize - Requested page size. The size must be an integer between 1 and 5000. If unspecified, the default is 5000. Returns error code INVALID_ARGUMENT if an invalid value is specified.

pageToken - A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to BulkListCampaignAssignedTargetingOptions method. If not specified, the first page of results will be returned.

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

Completes with a BulkListCampaignAssignedTargetingOptionsResponse.

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<BulkListCampaignAssignedTargetingOptionsResponse>
    listAssignedTargetingOptions(
  core.String advertiserId,
  core.String campaignId, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v3/advertisers/' +
      core.Uri.encodeFull('$advertiserId') +
      '/campaigns/' +
      core.Uri.encodeFull('$campaignId') +
      ':listAssignedTargetingOptions';

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