ベスト プラクティス

このページでは、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.
  }
}

2 番目の方法は、リストを取得しようとするため、おすすめしません。 リストのみにフィルタを適用できます。

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

特定のレベルでエンティティを取得するには、コレクションを使用します。 メソッドを実行します。イン シンプルになるだけでなく、パフォーマンスも格段に向上します。つまり、 すべてのキャンペーンと広告グループで不必要に読み取る必要がありません。

次のように、キャンペーン内のすべての広告を取得する次のコード スニペットを比較します。 account:

コーディングのアプローチ コード スニペット
適切な収集方法を使用する（推奨） 
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 番目の方法はキャンペーン全体を取得するため、おすすめしません。 広告グループ階層を作成できますが、必要なのは一部のみ 一連の広告に関連付けられたキャンペーンと広告グループ最初の 関連性の高い広告コレクションのみを取得するよう制限し、 適切なメソッドを呼び出して、その親オブジェクトにアクセスします。

特定の親フィルタを使う

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

指定したキャンペーンと広告グループ内のテキスト広告のリストを取得し、前月に 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 広告スクリプトでは変更がすぐに実行されるわけではありません。複数の変更を組み合わせて 複数の変更を行う単一のリクエストを発行できるようにします。 この方法では、スクリプトの実行速度が向上し、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());
}

2 つ目の方法は、API 呼び出しの呼び出しが 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());
}

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

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

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

コーディングのアプローチ コード スニペット
一括アップロードを使用する（推奨） 
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 広告スクリプトでは、取得できるオブジェクトの数に上限があります。 SELECT オペレーションと UPDATE オペレーションが 1 回の実行で 上限にカウントされます。

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

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

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

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

Google 広告スクリプトでは、1 つの一括アップロード タスク内で実行を最適化できるため、最も簡単な方法は、アカウントごとに一度に 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());
}

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

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

report メソッドは古いインフラストラクチャ用に構築されており、結果が出力されます。 フラット形式でデータを取得できますつまり、クエリの結果を変換して古いスタイルに合わせる必要があります。これはすべてのフィールドでサポートされているわけではなく、各呼び出しにオーバーヘッドが発生します。

代わりに検索を使用して、 Google Ads API の新しいレポートです

AWQL よりも GAQL を優先する

AWQL はレポートクエリと withCondition 呼び出しでは引き続きサポートされますが、 完全な互換性がない変換レイヤを経由する 測定しますクエリを完全に制御するには、 GAQLを使用します。

変換する既存の AWQL クエリがある場合は、クエリ 移行ツールをご覧ください。

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

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

たとえば、指定した範囲外の入札がある広告グループを 指定します。入札単価用のクエリを 1 つずつ、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 呼び出しの数が多いため、最初のスニペットと比較してパフォーマンスが低下します。