AdsApp.​ExcludedDisplayKeywordIterator

  • ExcludedDisplayKeywordIterator is an iterator for excluded display keywords.

  • It provides methods to check if there are more elements, get the next element, and find the total number of entities.

  • The hasNext() method returns true if there are more elements in the iterator.

  • The next() method returns the next ExcludedDisplayKeyword object.

  • The totalNumEntities() method returns the total count of entities matched by the selector that created the iterator, regardless of limits.

 An iterator of excluded display keywords.

Typical usage: 

while (excludedDisplayKeywordIterator.hasNext()) {
  var excludedDisplayKeyword = excludedDisplayKeywordIterator.next();
}
 Related:

Methods:

MemberTypeDescription
hasNext() boolean Returns true if the iterator has more elements.
next() AdsApp.ExcludedDisplayKeyword Returns the next ExcludedDisplayKeyword 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 ExcludedDisplayKeyword in the iterator.

Return values:

TypeDescription
AdsApp.ExcludedDisplayKeyword The next ExcludedDisplayKeyword 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.