KeywordIterator.md

title	description	author	ms.author	ms.service	ms.topic
KeywordIterator object	Contains the methods for iterating through a list of keywords.	jonmeyers	jonmeyers	bing-ads-scripts	article

KeywordIterator

Contains the methods for iterating through a list of keywords. For information about iterators, see Iterators.

Example usage:

    // Gets the iterator that iterates all keywords
    // in the account.
    var iterator = AdsApp.keywords().get();

    // Loops through all keywords in the account.
    while (iterator.hasNext()) {
        var keyword = iterator.next();
    }

Methods

Method Name	Return Type	Description
hasNext	Boolean	Gets a Boolean value that indicates whether this iterator has more elements.
next	Keyword	Advances the iterator and returns the next keyword.
totalNumEntities	int	Gets the number of keywords that matched the selector's selection criteria.

hasNext

Gets a Boolean value that indicates whether this iterator has more elements.

Returns

Type	Description
Boolean	Is true if this iterator has more elements; otherwise, false.

next

Advances the iterator and returns the next keyword.

Returns

Type	Description
Keyword	The next keyword in the iterator.

totalNumEntities

Gets the number of keywords that matched the selector's selection criteria.

Returns

Type	Description
int	The number of keywords that matched the selector's selection criteria.

See also

• KeywordSelector.get()
• Keyword