ベスト プラクティス

このページでは、Google 広告スクリプトを使った開発に関するおすすめの方法を紹介します。

セレクタ

セレクタでフィルタをかける

可能な限り、フィルタを使って必要なエンティティだけをリクエストしてください。フィルタを適切に適用することには、次のようなメリットがあります。

  • よりシンプルで理解しやすいコードになります。
  • スクリプトの実行時間が大幅に短縮されます。

以下のコード スニペットを比較してください。

コーディングのアプローチ コード スニペット
セレクタを使用してフィルタする（推奨） 
var keywords = AdsApp.keywords()
    .withCondition('Clicks > 10')
    .forDateRange('LAST_MONTH')
    .get();
while (keywords.hasNext()) {
  var keyword = keywords.next();
  // Do work here.
}
コードでフィルタする（非推奨） 
var keywords = AdsApp.keywords().get();

while (keywords.hasNext()) {
  var keyword = keywords.next();
  var stats = keyword.getStatsFor(
      'LAST_MONTH');
  if (stats.getClicks() > 10) {
    // Do work here.
  }
}

後者のアプローチは、リストにフィルタを適用するためにのみアカウント内のすべてのキーワードのリストを取得しようとするため、おすすめしません。

キャンペーンの階層構造の順次処理を避ける

特定のレベルのエンティティを取得するには、キャンペーン階層全体を移動するのではなく、そのレベルで収集メソッドを使用します。この方法は、シンプルであるだけでなくパフォーマンスも大幅に向上します。システムがすべてのキャンペーンと広告グループを不必要に読み取る必要がなくなります。

アカウントのすべての広告を取得する次のコード スニペットを比較してください。

コーディングのアプローチ コード スニペット
適切な収集方法を使用する（推奨） 

var ads = AdsApp.ads();
階層を走査（非推奨） 
var campaigns = AdsApp.campaigns().get();
while (campaigns.hasNext()) {
  var adGroups = campaigns.next().
      adGroups().get();
  while (adGroups.hasNext()) {
    var ads = adGroups.next().ads().get();
    // Do your work here.
  }
}

2 番目の方法では、広告のみが必要なのに対し、オブジェクト（キャンペーン、広告グループ）の階層全体を取得しようとすることはおすすめしません。

特定の親アクセサ メソッドを使う

取得済みオブジェクトの親エンティティを取得する必要がある場合は、この場合は、階層全体を取得するのではなく、指定されたアクセサ メソッドを使用する必要があります。

前月のクリック数が 50 回を超えているテキスト広告を含む広告グループを取得する、次のコード スニペットを比較してください。

コーディングのアプローチ コード スニペット
適切な親アクセサ メソッドを使用する（推奨） 
var ads = AdsApp.ads()
    .withCondition('Clicks > 50')
    .forDateRange('LAST_MONTH')
    .get();

while (ads.hasNext()) {
  var ad = ads.next();
  var adGroup = ad.getAdGroup();
  var campaign = ad.getCampaign();
  // Store (campaign, adGroup) to an array.
}
階層を走査（非推奨） 
var campaigns = AdsApp.campaigns().get();
while (campaigns.hasNext()) {
  var adGroups = campaigns.next()
      .adGroups()
      .get();
  while (adGroups.hasNext()) {
    var ads = adGroups.ads()
       .withCondition('Clicks > 50')
       .forDateRange('LAST_MONTH')
       .get();
    if (ads.totalNumEntities() > 0) {
      // Store (campaign, adGroup) to an array.
    }
  }
}

2 番目の方法では、アカウント内のキャンペーンと広告グループの階層全体を取得しますが、広告に関連付けられたキャンペーンと広告グループのサブセットのみを取得するため、この方法はおすすめしません。最初の方法は、関連性の高い広告コレクションのみを取得するように制限し、適切なメソッドを使用して親オブジェクトにアクセスします。

特定の親フィルタを使う

特定のキャンペーンまたは広告グループ内のエンティティにアクセスするには、取得してから階層間を移動するのではなく、セレクタで特定のフィルタを使用します。

次の 2 つのコード スニペットを比較して、前月に 50 回以上クリックされた、指定したキャンペーンや広告グループ内のテキスト広告のリストを取得します。

コーディングのアプローチ コード スニペット
親レベルの適切なフィルタを使用する（推奨） 
var ads = AdsApp.ads()
    .withCondition('CampaignName = "Campaign 1"')
    .withCondition('AdGroupName = "AdGroup 1"')
    .withCondition('Clicks > 50')
    .forDateRange('LAST_MONTH')
    .get();

while (ads.hasNext()) {
  var ad = ads.next();
  var adGroup = ad.getAdGroup();
  var campaign = ad.getCampaign();
  // Store (campaign, adGroup, ad) to
  // an array.
}
階層を走査（非推奨） 
var campaigns = AdsApp.campaigns()
    .withCondition('Name = "Campaign 1"')
    .get();

while (campaigns.hasNext()) {
  var adGroups = campaigns.next()
      .adGroups()
      .withCondition('Name = "AdGroup 1"')
      .get();
  while (adGroups.hasNext()) {
    var ads = adGroups.ads()
       .withCondition('Clicks > 50')
       .forDateRange('LAST_MONTH')
       .get();
    while (ads.hasNext()) {
      var ad = ads.next();
      // Store (campaign, adGroup, ad) to
      // an array.
    }
  }
}

2 番目の方法では、アカウント内のキャンペーンと広告グループの階層を反復処理しますが、広告のセットとその親のキャンペーンと広告グループのみが必要になるため、おすすめしません。最初の方法では、セレクタで親エンティティに特定のフィルタを適用して、反復処理を広告のリストに制限します。

可能な場合はフィルタに ID を使う

エンティティをフィルタする場合は、他のフィールドではなく、ID でエンティティをフィルタすることをおすすめします。

キャンペーンを選択する以下のコード スニペットを考えてみます。

コーディングのアプローチ コード スニペット
ID でフィルタ（推奨） 
var campaign = AdsApp.campaigns()
    .withIds([12345])
    .get()
    .next();
名前でフィルタ（あまり最適ではない） 
var campaign = AdsApp.campaigns()
    .withCondition('Name="foo"')
    .get()
    .next();

ID ではないフィールドでフィルタしている後者のアプローチは、可能であれば避けてください。

可能な場合は常に親 ID でフィルタする

エンティティを選択する場合、可能であれば常に親 ID でフィルタしてください。これにより、結果をフィルタリングする際にサーバーによって取得されるエンティティのリストが制限され、クエリが高速化されます。

広告グループを ID で取得する次のコード スニペットを考えてみます。 親キャンペーン ID がわかっているとします。

コーディングのアプローチ コード スニペット
キャンペーン ID と広告グループ ID でフィルタする（推奨） 
var adGroup = AdsApp.adGroups()
    .withIds([12345])
    .withCondition('CampaignId="54678"')
    .get()
    .next();
広告グループ ID のみでフィルタする（あまり最適ではない） 
var adGroup = AdsApp.adGroups()
    .withIds([12345])
    .get()
    .next();

どちらのコード スニペットでも結果は同じですが、コード スニペット 1 で親 ID (CampaignId="54678") を使用して追加のフィルタリングを行うと、結果をフィルタリングする際にサーバーが反復する必要があるエンティティのリストが制限されるため、コードの効率が向上します。

フィルタ条件が多すぎる場合はラベルを使う

フィルタリング条件が多すぎる場合は、処理するエンティティのラベルを作成し、そのラベルを使用してエンティティをフィルタリングすることをおすすめします。

キャンペーンのリストを名前で取得する次のコード スニペットについて考えてみましょう。

コーディングのアプローチ コード スニペット
ラベルを使用する（推奨） 
var label = AdsApp.labels()
    .withCondition('Name = "My Label"')
    .get()
    .next();
var campaigns = label.campaigns.get();
while (campaigns.hasNext()) {
  var campaign = campaigns.next();
  // Do more work
}
複雑なセレクタを作成する（非推奨） 
var campaignNames = [‘foo’, ‘bar’, ‘baz’];

for (var i = 0; i < campaignNames.length; i++) {
  campaignNames[i] = '"' + campaignNames[i] + '"';
}

var campaigns = AdsApp.campaigns
    .withCondition('CampaignName in [' + campaignNames.join(',') + ']')
    .get();

while (campaigns.hasNext()) {
  var campaign = campaigns.next();
  // Do more work.
}

どちらのコード スニペットでもパフォーマンスは同程度ですが、2 番目の方法では、セレクタの条件の数が増えるにつれて、より複雑なコードを生成する傾向があります。また、新しいエンティティにラベルを適用するほうが、スクリプトを編集して新しいエンティティを含めるよりも簡単です。

IN 句に含める条件の数を制限する

スクリプトを実行する場合の一般的な使用例は、エンティティのリストに対するレポートの実行です。これは通常、IN 句を使ってエンティティ ID をフィルタする非常に長い AWQL クエリを作成することで実現します。このアプローチは、エンティティの数が限られている場合はうまく機能します。ただし、クエリが長くなると、次の 2 つの理由によりスクリプトのパフォーマンスが低下します。

  • クエリが長くなると解析時間も長くなる。
  • IN 句に ID を追加するたびに評価する条件が追加されるため、時間がかかります。

このような条件では、エンティティにラベルを適用してから、LabelId でフィルタすることをおすすめします。

コーディングのアプローチ コード スニペット
ラベルを適用し、labelID でフィルタする（推奨） 
// The label applied to the entity is "Report Entities"
var label = AdsApp.labels()
    .withCondition('LabelName contains "Report Entities"')
    .get()
    .next();

var report = AdsApp.report('SELECT AdGroupId, Id, Clicks, ' +
    'Impressions, Cost FROM KEYWORDS_PERFORMANCE_REPORT ' +
    'WHERE LabelId = "' + label.getId() + '"');
IN 句を使用して長いクエリを作成する（非推奨） 
var report = AdsApp.report('SELECT AdGroupId, Id, Clicks, ' +
    'Impressions, Cost FROM KEYWORDS_PERFORMANCE_REPORT WHERE ' +
    'AdGroupId IN (123, 456) and Id in (123,345, 456…)');

アカウントの変更

一括で変更する

Google 広告エンティティに変更を加えても、Google 広告スクリプトはその変更をすぐには実行しません。複数の変更をまとめて 1 つのリクエストを発行できるように、複数の変更をバッチに結合しようとします。これにより、スクリプトが高速化され、Google 広告サーバーの負荷が軽減されます。ただし、コードパターンによっては、Google 広告スクリプトがオペレーションのバッチを頻繁にフラッシュすることを強制すると、スクリプトの実行が遅くなります。

キーワードリストの入札単価を更新する以下のスクリプトを考えてみます。

コーディングのアプローチ コード スニペット
更新された要素を追跡する（推奨） 
var keywords = AdsApp.keywords()
    .withCondition('Clicks > 50')
    .withCondition('CampaignName = "Campaign 1"')
    .withCondition('AdGroupName = "AdGroup 1"')
    .forDateRange('LAST_MONTH')
    .get();

var list = [];
while (keywords.hasNext()) {
  var keyword = keywords.next();
  keyword.bidding().setCpc(1.5);
  list.push(keyword);
}

for (var i = 0; i < list.length; i++) {
  var keyword = list[i];
  Logger.log('%s, %s', keyword.getText(),
      keyword.bidding().getCpc());
}
更新された要素をタイトなループで取得する（非推奨） 
var keywords = AdsApp.keywords()
    .withCondition('Clicks > 50')
    .withCondition('CampaignName = "Campaign 1"')
    .withCondition('AdGroupName = "AdGroup 1"')
    .forDateRange('LAST_MONTH')
    .get();

while (keywords.hasNext()) {
  var keyword = keywords.next();
  keyword.bidding().setCpc(1.5);
  Logger.log('%s, %s', keyword.getText(),
      keyword.bidding().getCpc());
}

後者のアプローチはおすすめしません。keyword.bidding().getCpc() を呼び出すと Google 広告スクリプトが setCpc() オペレーションをフラッシュし、一度に 1 つのオペレーションのみを実行するためです。最初のアプローチは、2 番目のアプローチに似ていますが、getCpc() の呼び出しが setCpc() が呼び出されるループとは別のループで実行されるため、バッチ処理をサポートするという追加のメリットがあります。

可能な場合はビルダーを使う

Google 広告スクリプトで新しいオブジェクトを作成する方法は、ビルダーと作成方法の 2 つです。ビルダーは、API 呼び出しから作成されるオブジェクトにアクセスできるため、作成メソッドよりも柔軟性があります。

以下のコード スニペットを考えてみます。

コーディングのアプローチ コード スニペット
ビルダーを使用する（推奨） 
var operation = adGroup.newKeywordBuilder()
    .withText('shoes')
    .build();
var keyword = operation.getResult();
作成方法を使用する（非推奨） 
adGroup.createKeyword('shoes');
var keyword = adGroup.keywords()
    .withCondition('KeywordText="shoes"')
    .get()
    .next();

2 番目の方法では、キーワードの取得に追加の選択オペレーションが伴うため、おすすめしません。また、作成メソッドも非推奨になりました。

ただし、ビルダーを不適切に使用すると、Google 広告スクリプトによるオペレーションの一括処理が妨げられる場合があります。

キーワードのリストを作成し、新しく作成したキーワードの ID を出力する次のコード スニペットを考えてみます。

コーディングのアプローチ コード スニペット
更新された要素を追跡する（推奨） 
var keywords = [‘foo’, ‘bar’, ‘baz’];

var list = [];
for (var i = 0; i < keywords.length; i++) {
  var operation = adGroup.newKeywordBuilder()
      .withText(keywords[i])
      .build();
  list.push(operation);
}

for (var i = 0; i < list.length; i++) {
  var operation = list[i];
  var result = operation.getResult();
  Logger.log('%s %s', result.getId(),
      result.getText());
}
更新された要素をタイトなループで取得する（非推奨） 
var keywords = [‘foo’, ‘bar’, ‘baz’];

for (var i = 0; i < keywords.length; i++) {
  var operation = adGroup.newKeywordBuilder()
      .withText(keywords[i])
      .build();
  var result = operation.getResult();
  Logger.log('%s %s', result.getId(),
      result.getText());
}

後者のアプローチは、オペレーションを作成するのと同じループ内で operation.getResult() を呼び出し、Google 広告スクリプトが一度に 1 つのオペレーションを実行する必要があるため、推奨されません。最初の方法でも似ていますが、 operation.getResult() を作成したループとは異なるループで呼び出すため、バッチ処理が可能です。

更新が大規模な場合は一括アップロードを検討する

デベロッパーがよく実行するタスクは、レポートを実行し、現在のパフォーマンス値に基づいてエンティティ プロパティ（キーワードの入札単価など）を更新することです。多数のエンティティを更新する必要がある場合は、一括アップロードを使用するほうがパフォーマンスが向上する傾向があります。たとえば、先月の TopImpressionPercentage > 0.4 のキーワードの MaxCpc を増やす次のスクリプトについて考えてみましょう。

コーディングのアプローチ コード スニペット
一括アップロードを使用する（推奨） 

var report = AdsApp.report(
  'SELECT AdGroupId, Id, CpcBid FROM KEYWORDS_PERFORMANCE_REPORT ' +
  'WHERE TopImpressionPercentage > 0.4 DURING LAST_MONTH');

var upload = AdsApp.bulkUploads().newCsvUpload([
  report.getColumnHeader('AdGroupId').getBulkUploadColumnName(),
  report.getColumnHeader('Id').getBulkUploadColumnName(),
  report.getColumnHeader('CpcBid').getBulkUploadColumnName()]);
upload.forCampaignManagement();

var reportRows = report.rows();
while (reportRows.hasNext()) {
  var row = reportRows.next();
  row['CpcBid'] = row['CpcBid'] + 0.02;
  upload.append(row.formatForUpload());
}

upload.apply();
ID によるキーワードの選択と更新（あまり最適化されていない） 
var reportRows = AdsApp.report('SELECT AdGroupId, Id, CpcBid FROM ' +
    'KEYWORDS_PERFORMANCE_REPORT WHERE TopImpressionPercentage > 0.4 ' +
    ' DURING LAST_MONTH')
    .rows();

var map = {
};

while (reportRows.hasNext()) {
  var row = reportRows.next();
  var adGroupId = row['AdGroupId'];
  var id = row['Id'];

  if (map[adGroupId] == null) {
    map[adGroupId] = [];
  }
  map[adGroupId].push([adGroupId, id]);
}

for (var key in map) {
  var keywords = AdsApp.keywords()
      .withCondition('AdGroupId="' + key + '"')
      .withIds(map[key])
      .get();

  while (keywords.hasNext()) {
    var keyword = keywords.next();
    keyword.bidding().setCpc(keyword.bidding().getCpc() + 0.02);
  }
}

2 番目のアプローチもかなり優れたパフォーマンスを発揮しますが、この場合は 1 番目のアプローチが推奨されます。その理由は、

  • Google 広告スクリプトでは、1 回の実行で取得または更新できるオブジェクトの数に上限があり、2 番目の方法の選択と更新のオペレーションはその上限にカウントされます。

  • 一括アップロードでは、更新可能なエンティティ数と全体的な実行時間の両方の上限が高くなります。

複数の一括アップロードをキャンペーン別にグループ化する

一括アップロードを作成する場合は、オペレーションを親キャンペーン別にグループ化するようにしてください。これにより、効率が向上し、変更の競合や同時実行エラーの可能性が低くなります。

2 つの一括アップロード タスクを並列で実行する場合を考えてみます。1 つは広告グループの広告を一時停止し、もう 1 つはキーワードの入札単価を調整します。オペレーションに関連性はありませんが、同じ広告グループ（または同じキャンペーンの 2 つの異なる広告グループ）内のエンティティにオペレーションが適用される場合があります。この場合、親エンティティ（共有の広告グループまたはキャンペーン）がロックされ、一括アップロード タスクが相互にブロックされます。

Google 広告 スクリプトでは、1 つの一括アップロード タスクの実行を最適化できます。そのため、最も簡単な方法は、アカウントごとに一度に 1 つの一括アップロード タスクのみを実行することです。アカウントごとに複数の一括アップロードを実行する場合は、最適なパフォーマンスが得られるように、相互に排他的なキャンペーン（およびその子エンティティ）のリストに対して一括アップロードを実行するようにしてください。

レポート

レポートを使って統計情報を取得する

大量のエンティティとその統計情報を取得する場合は、標準の AdsApp メソッドよりもレポートを使用することをおすすめします。レポートの使用が推奨される理由は次のとおりです。

  • 大規模なクエリで良好なパフォーマンスを得られる。
  • 一般的な取得数の上限に達することがない。

前月に 50 回を超えるクリック数を獲得したすべてのキーワードのクリック数、インプレッション数、費用、テキストを取得するコード スニペットを比較してください。

コーディングのアプローチ コード スニペット
レポートを使用する（推奨） 
  report = AdsApp.search(
      'SELECT ' +
      '   ad_group_criterion.keyword.text, ' +
      '   metrics.clicks, ' +
      '   metrics.cost_micros, ' +
      '   metrics.impressions ' +
      'FROM ' +
      '   keyword_view ' +
      'WHERE ' +
      '   segments.date DURING LAST_MONTH ' +
      '   AND metrics.clicks > 50');
  while (report.hasNext()) {
    var row = report.next();
    Logger.log('Keyword: %s Impressions: %s ' +
        'Clicks: %s Cost: %s',
        row.adGroupCriterion.keyword.text,
        row.metrics.impressions,
        row.metrics.clicks,
        row.metrics.cost);
  }
AdsApp イテレータを使用する（非推奨） 
var keywords = AdsApp.keywords()
    .withCondition('metrics.clicks > 50')
    .forDateRange('LAST_MONTH')
    .get();
while (keywords.hasNext()) {
  var keyword = keywords.next();
  var stats = keyword.getStatsFor('LAST_MONTH');
  Logger.log('Keyword: %s Impressions: %s ' +
      'Clicks: %s Cost: %s',
      keyword.getText(),
      stats.getImpressions(),
      stats.getClicks(),
      stats.getCost());
}

後者のアプローチは、キーワードを反復処理し、一度に 1 つずつエンティティを取得するため、おすすめしません。この場合、1 回の呼び出しですべてのデータを取得し、必要に応じてストリーミングするため、レポートの処理速度が向上します。また、2 番目の方法で取得されたキーワードは、get() 呼び出しで取得されたエンティティ数に対するスクリプトの割り当てにカウントされます。

レポートではなく検索を使用する

レポート メソッドは古いインフラストラクチャ用に作成されており、GAQL を使用している場合でも結果がフラット形式で出力されます。つまり、クエリの結果を古いスタイルに合わせて変換する必要がありますが、これはすべてのフィールドでサポートされておらず、各呼び出しのオーバーヘッドが増加することを意味します。

新しい Google Ads API レポートのすべての機能を利用するには、代わりに検索を使用することをおすすめします。

AWQL よりも GAQL を優先する

AWQL はレポートクエリと withCondition 呼び出しで引き続きサポートされますが、実際の AWQL との完全な互換性はありません。クエリを完全に制御するには、GAQL を使用します。

既存の AWQL クエリを変換する場合は、クエリツールをご利用ください。

必要以上の行を選択しないでください

レポート（およびセレクタ）の実行速度は、それらを反復処理するかどうかに関係なく、レポートから返される行の合計数に基づきます。つまり、常に特定のフィルタを使用して、ユースケースに合わせて可能な限り結果セットを最小限に抑える必要があります。

たとえば、入札単価が特定の範囲外にある広告グループを探すとします。すべての広告グループを取得して、関心のない広告グループを無視するよりも、2 つの別々のクエリ（下限を下回る入札単価と上限を超える入札単価に対するクエリ）を作成する方が高速になります。

コーディングのアプローチ コード スニペット
2 つのクエリを使用する（推奨） 
var adGroups = []
var report = AdsApp.search(
    'SELECT ad_group.name, ad_group.cpc_bid_micros' +
    ' FROM ad_group WHERE ad_group.cpc_bid_micros < 1000000');

while (report.hasNext()) {
  var row = report.next();
  adGroups.push(row.adGroup);
}
var report = AdsApp.search(
    'SELECT ad_group.name, ad_group.cpc_bid_micros' +
    ' FROM ad_group WHERE ad_group.cpc_bid_micros > 2000000');

while (report.hasNext()) {
  var row = report.next();
  adGroups.push(row.adGroup);
}
一般的なクエリから絞り込む（非推奨） 
var adGroups = []
var report = AdsApp.search(
    'SELECT ad_group.name, ad_group.cpc_bid_micros' +
    ' FROM ad_group');

while (report.hasNext()) {
  var row = report.next();
  var cpcBidMicros = row.adGroup.cpcBidMicros;
  if (cpcBidMicros < 1000000 || cpcBidMicros > 2000000) {
    adGroups.push(row.adGroup);
  }
}

Google 広告クライアント センター（MCC）スクリプト

可能な限りシリアル実行ではなく executeInParallel を使う

MCC アカウントのスクリプトを記述する際は、可能であれば、シリアル実行ではなく executeInParallel() を使用します。executeInParallel() を使用すると、スクリプトの処理時間が長くなり（最大 1 時間）、処理されるアカウントあたり最大 30 分（シリアル実行の場合は合計 30 分ではなく）なります。詳しくは、上限ページをご覧ください。

スプレッドシート

スプレッドシートの更新には一括操作を使う

スプレッドシートを更新するときは、一度に 1 つのセルを更新するメソッドではなく、一括オペレーションのメソッド（getRange() など）を使用してください。

スプレッドシートにフラクタル パターンを生成する次のコード スニペットについて考えてみましょう。

コーディングのアプローチ コード スニペット
1 回の呼び出しでセル範囲を更新する（推奨） 
var colors = new Array(100);
for (var y = 0; y < 100; y++) {
  xcoord = xmin;
  colors[y] = new Array(100);
  for (var x = 0; x < 100; x++) {
    colors[y][x] = getColor_(xcoord, ycoord);
    xcoord += xincrement;
  }
  ycoord -= yincrement;
}
sheet.getRange(1, 1, 100, 100).setBackgroundColors(colors);
セルを 1 つずつ更新する（非推奨） 
var cell = sheet.getRange('a1');
for (var y = 0; y < 100; y++) {
  xcoord = xmin;
  for (var x = 0; x < 100; x++) {
    var c = getColor_(xcoord, ycoord);
    cell.offset(y, x).setBackgroundColor(c);
    xcoord += xincrement;
  }
  ycoord -= yincrement;
  SpreadsheetApp.flush();
}

Google スプレッドシートは値をキャッシュに保存することで 2 番目のコード スニペットを最適化しようとしますが、実行される API 呼び出しの数が原因で、最初のスニペットよりもパフォーマンスが低下します。