AdsApp.​ExcludedContentLabelSelector

AI-generated Key Takeaways

outlined_flag

• ExcludedContentLabelSelector fetches excluded content labels and supports filtering and sorting.

• The get() method fetches the requested excluded content labels and returns an iterator.

• The withIds(ids) method restricts the selector to return only excluded content labels with the given IDs.

• The withLimit(limit) method specifies the maximum number of entities to return.

• The withResourceNames(resourceNames) method restricts the selector to return only excluded content labels with the given Google Ads API resource names.

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();
}

• ExcludedContentLabelIterator
• ExcludedContentLabel

Methods:

get()

Return values:

withIds(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);

Arguments:

Return values:

withLimit(limit)

Arguments:

Return values:

withResourceNames(resourceNames)

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:

Return values: