bulkListAdGroupAssignedTargetingOptions method

Future<BulkListAdGroupAssignedTargetingOptionsResponse> bulkListAdGroupAssignedTargetingOptions(String advertiserId, { List<String>? adGroupIds, String? filter, String? orderBy, int? pageSize, String? pageToken, String? $fields, })

Lists assigned targeting options for multiple ad groups across targeting types.

Inherited assigned targeting options are not included.

Request parameters:

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

adGroupIds - Required. The IDs of the ad groups to list assigned targeting options for.

filter - Optional. 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 logical operator OR.

• A restriction has the form of {field} {operator} {value}. * All fields must use the EQUALS (=) operator. Supported fields: * targetingType Examples: * AssignedTargetingOption resources of targeting type TARGETING_TYPE_YOUTUBE_VIDEO or TARGETING_TYPE_YOUTUBE_CHANNEL: targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL" 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 - Optional. Field by which to sort the list. Acceptable values are: * adGroupId (default) * assignedTargetingOption.targetingType 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 - Optional. 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 - Optional. 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 the BulkListAdGroupAssignedTargetingOptions 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 BulkListAdGroupAssignedTargetingOptionsResponse.

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<BulkListAdGroupAssignedTargetingOptionsResponse>
bulkListAdGroupAssignedTargetingOptions(
  core.String advertiserId, {
  core.List<core.String>? adGroupIds,
  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 (adGroupIds != null) 'adGroupIds': adGroupIds,
    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') +
      '/adGroups:bulkListAdGroupAssignedTargetingOptions';

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