イテレータ

イテレータは、次のような場合にオブジェクトのリストを走査するために使用される一般的なプログラミング パターンです。

• 処理開始時にリストのサイズがわからない可能性がある。
• リスト全体を一度にメモリに読み込むと、リソースの使用量が過剰になる可能性があります。

イテレータは、boolean hasNext() と Object next() の 2 つのメソッドを公開します。Google 広告スクリプトでは、Google 広告エンティティの取得にイテレータ パターンが使用されます。

イテレータは機能的には通常の配列とあまり変わらず、コードを簡潔にできます。次の例は、配列を順次処理するコードです。

for (var i = 0; i < myArray.length; i++) {
  let myObject = myArray[i];
}

イテレータを走査するコードに置き換えます。

while (myIterator.hasNext()) {
  let myObject = myIterator.next();
}

次のコードは、アカウント内のすべてのキャンペーンに対してイテレータを使用する方法を示しています。

var campaignIterator = AdsApp.campaigns().get();

while (campaignIterator.hasNext()) {
  let campaign = campaignIterator.next();
  console.log(`${campaign.getName()}; active? ${campaign.isEnabled()}; ` +
      `budget=${campaign.getBudget().getAmount()}`);
}

組み込みの JavaScript 反復処理を使用することもできます。

for (const campaign of AdsApp.campaigns()) {
  console.log(`${campaign.getName()}; active? ${campaign.isEnabled()}; ` +
      `budget=${campaign.getBudget().getAmount()}`);
}

セレクタに withLimit() を適用しても、totalNumEntities() の値は変更されません。次のスニペットの x と y は同じ値になります。

var x = AdsApp.keywords().get().totalNumEntities();
var y = AdsApp.keywords().withLimit(5).get().totalNumEntities();

Google 広告エンティティの Iterator を取得するには、まず セレクタを作成する必要があります。