AdsApp.​ExcludedContentLabelIterator

  • This page documents an iterator used to access excluded content labels, typically obtained via an ExcludedContentLabelSelector.

  • The iterator provides methods like hasNext(), next(), and totalNumEntities() to navigate and access the labels.

  • hasNext() checks if more labels are available, next() retrieves the next label, and totalNumEntities() returns the total count of matched labels.

  • While totalNumEntities() provides the total matched count, the iterator might not contain all due to entity read limits.

 An iterator of excluded content labels.

Typical usage: 

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

Methods:

MemberTypeDescription
hasNext() boolean Returns true if the iterator has more elements.
next() AdsApp.ExcludedContentLabel Returns the next ExcludedContentLabel in the iterator.
totalNumEntities() int Returns the total number of entities matched by the selector which generated this iterator.

hasNext()

Returns true if the iterator has more elements.

Return values:

TypeDescription
boolean true if the iterator has more elements.

next()

Returns the next ExcludedContentLabel in the iterator.

Return values:

TypeDescription
AdsApp.ExcludedContentLabel The next ExcludedContentLabel in the iterator.

totalNumEntities()

Returns the total number of entities matched by the selector which generated this iterator.

Note that the returned number disregards limits, and that the iterator is not guaranteed to have this many elements — hasNext will start to return false and next will start to throw exceptions as soon as the limit for entity reads has been reached, even if the selector matched more entities.

Return values:

TypeDescription
int The number of entities matched by the selector which generated this iterator.