AdsApp.​ExcludedContentLabelSelector

  • Fetches excluded content labels for campaigns, allowing for filtering and sorting based on criteria like impressions or clicks.

  • Provides methods to filter by excluded content label IDs or Google Ads API resource names, and to limit the number of results.

  • Supports applying multiple conditions for refined filtering, such as combining ID-based and other conditions.

  • Returns an iterator (ExcludedContentLabelIterator) to access the selected excluded content labels.

  • Offers flexibility in retrieving specific excluded content labels or working with a subset for analysis or management.

 Fetches excluded content labels. Supports filtering and sorting.

Typical usage: 

var excludedContentLabelSelector = campaign.targeting()
    .excludedContentLabels()
    .withCondition("metrics.impressions > 100")
    .orderBy("metrics.clicks DESC");

var excludedContentLabelIterator = excludedContentLabelSelector.get();
while (excludedContentLabelIterator.hasNext()) {
  var excludedContentLabel = excludedContentLabelIterator.next();
}
 Related:

Methods:

MemberTypeDescription
get() AdsApp.ExcludedContentLabelIterator Fetches the requested excluded content labels and returns an iterator.
withIds(ids) AdsApp.ExcludedContentLabelSelector Restricts this selector to return only excluded content labels with the given excluded content label IDs.
withLimit(limit) AdsApp.ExcludedContentLabelSelector Specifies limit for the selector to use.
withResourceNames(resourceNames) AdsApp.ExcludedContentLabelSelector Restricts this selector to return only excluded content labels with the given Google Ads API resource names.

get()

Fetches the requested excluded content labels and returns an iterator.

Return values:

TypeDescription
AdsApp.ExcludedContentLabelIterator Iterator of the requested excluded content labels.

withIds(ids)

Restricts this selector to return only excluded content labels with the given excluded content label IDs.

All excluded content labels are uniquely identified by the combination of their ad group ID and excluded content label ID. The IDs for this selector are thus represented as two-element arrays, with the first element being the ad group ID and the second being the excluded content label ID: 

var excludedContentLabelIds = [
  ['12345', '987987'],
  ['23456', '876876'],
  ['34567', '765765'],
];
selector = selector.withIds(excludedContentLabelIds);

The resulting selector can be further refined by applying additional conditions to it. The ID-based condition will then be AND-ed together with all the other conditions, including any other ID-based conditions. So, for instance, the following selector: 

var ids1 = [
  ['12345', '987987'],
  ['23456', '876876'],
  ['34567', '765765'],
];
var ids2 = [
  ['34567', '765765'],
  ['45678', '654654'],
  ['56789', '543543'],
];
AdsApp.targeting().excludedContentLabels()
   .withIds(ids1)
   .withIds(ids2);
 will only get the excluded content label with ID ['34567', '765765'], since it would be the only excluded content label that satisfies both ID conditions.

Arguments:

NameTypeDescription
ids Object[][] Array of excluded content label IDs.

Return values:

TypeDescription
AdsApp.ExcludedContentLabelSelector The selector restricted to the given IDs.

withLimit(limit)

Specifies limit for the selector to use. For instance, withLimit(50) returns only the first 50 entities.

Arguments:

NameTypeDescription
limit int How many entities to return.

Return values:

TypeDescription
AdsApp.ExcludedContentLabelSelector The selector with limit applied.

withResourceNames(resourceNames)

Restricts this selector to return only excluded content labels with the given Google Ads API resource names. 
const excludedContentLabelResourceNames = [
  'customers/1234567890/campaignCriteria/111~222',
  'customers/1234567890/campaignCriteria/111~333',
  'customers/1234567890/campaignCriteria/444~555',
];
selector = selector.withResourceNames(excludedContentLabelResourceNames);

The resulting selector can be further refined by applying additional conditions to it. The resource name condition will then be AND-ed together with all the other conditions.

The selector can only support up to 10,000 resource names. If more than 10,000 resource names are specified, the corresponding get() call will fail with a runtime error.

Arguments:

NameTypeDescription
resourceNames String[] Array of excluded content label resource names.

Return values:

TypeDescription
AdsApp.ExcludedContentLabelSelector The selector restricted to the given resource names.