AdsApp.​CampaignSnippetIterator

  • The CampaignSnippetIterator allows you to iterate through campaign-level snippets.

  • It provides methods like hasNext() to check for more elements, next() to retrieve the next CampaignSnippet, and totalNumEntities() to get the total count of matched entities.

  • Use a while loop with hasNext() and next() to process each CampaignSnippet in the iterator.

  • This iterator is created using CampaignSnippetSelector.get().

 An iterator of campaign-level snippets.

Typical usage: 

while (campaignSnippetIterator.hasNext()) {
  var campaignSnippet = campaignSnippetIterator.next();
}
 Related:

Methods:

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

Return values:

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