イテレータ

イテレータは、オブジェクトのリストをトラバースするときに使用される一般的なプログラミング パターンです。

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

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

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

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 を取得するには、まず Selector を構築する必要があります。