最佳做法

本页介绍了使用 Google Ads 脚本进行开发的各种最佳做法。

选择器

使用选择器进行过滤

尽量使用过滤器,做到只请求您需要的实体。应用适当的过滤器有以下几个好处:

  • 代码更简单、更容易理解。
  • 脚本执行速度更快。

我们来比较以下代码段:

编码方案 代码段
使用选择器进行过滤(推荐)
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.
  }
}

不推荐第二种方案,因为它试图获取对象(广告系列、广告组)的整个层次结构,而其中只有广告。

使用特定的父级访问器方法

有时候您需要获取某个检索对象的父级实体。在这种情况下,您应该使用提供的访问器方法,而不是提取整个层次结构。

比较以下代码段,它们会提取在上个月获得超过 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.
    }
  }
}

不推荐第二种方案,因为它会获取您帐号中的整个广告系列和广告组层级,而您只需要与您的一组广告相关联的一部分广告系列和广告组。第一种方法将自身限制为仅获取相关广告集合,并使用适当的方法来访问其父级对象。

使用特定的父级过滤器

如需访问特定广告系列或广告组中的实体,请在选择器中使用特定的过滤条件,而不是提取信息并遍历层级结构。

请比较以下代码段,它们会提取指定广告系列和广告组内在上个月获得 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.
    }
  }
}

不推荐第二种方案,因为它会迭代帐号中的广告系列和广告组层次结构,而您只需要一组选定的广告及其父级广告系列和广告组。第一种方法通过在选择器上对父实体应用特定过滤器,将迭代限制为广告列表。

尽量使用 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 过滤(推荐)
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.
}

虽然这两种代码段能够提供相近的性能水平,但随着选择器中条件数量的增加,第二种方法往往会生成更复杂的代码。此外,与修改脚本以包含新实体相比,将标签应用于新实体也更容易。

限制 IN 子句中的条件数量

运行脚本时,一种常见的使用场景是针对实体列表生成报告。开发者通常通过构造一个很长的 AWQL 查询来实现此目的,该查询使用 IN 子句对实体 ID 进行过滤。当实体数量有限时,此方法很有效。不过,随着查询长度的增加,脚本性能会变差,原因有两个:

  • 较长的查询需要更长的时间来解析。
  • 您添加到 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 Ads 实体时,Google Ads 脚本不会立即执行更改,而是会尝试将多项更改合并为批次,以便发出单个请求来执行多项更改。这种方法加快了脚本的运行速度,并降低了 Google Ads 服务器的负载。不过,有些代码模式会迫使 Google Ads 脚本频繁刷新其批量操作,从而导致脚本运行缓慢。

来考虑以下脚本,该脚本将更新某个关键字列表的出价。

编码方案 代码段
跟踪更新的元素(推荐)
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 Ads 脚本刷新 setCpc() 操作,并且一次只执行一项操作。第一种方法虽然与第二种方法类似,但具有支持批处理的额外好处,因为 getCpc() 调用是在不同于调用 setCpc() 的循环中完成的。

尽量使用构建器

Google Ads 脚本支持两种创建新对象的方式:构建器和创建方法。构建器比创建方法更灵活,因为它允许您访问通过 API 调用创建的对象。

我们来考虑以下代码段:

编码方案 代码段
使用构建器(推荐)
var operation = adGroup.newKeywordBuilder()
    .withText('shoes')
    .build();
var keyword = operation.getResult();
使用创建方法(不推荐)
adGroup.createKeyword('shoes');
var keyword = adGroup.keywords()
    .withCondition('KeywordText="shoes"')
    .get()
    .next();

不建议采用第二种方案,因为在检索关键字时需要执行额外的选择操作。此外,还废弃了各种创建方法。

不过请注意,构建器如果使用不当,可能会阻止 Google Ads 脚本批量执行操作。

请考虑以下代码段,它会创建关键字列表并输出新创建的关键字的 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 Ads 脚本一次只执行一项操作。第一种方法虽然类似,但允许进行批处理,因为我们调用 actions.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);
  }
}

虽然第二种方法的性能非常好,但在这种情况下,第一种方法是首选方法,因为

  • Google Ads 脚本对在单次运行中可检索或更新的对象数量有限制,第二种方法中的选择和更新操作会计入该限制。

  • 在可以更新的实体数量和总执行时间方面,批量上传具有更高的限制。

将批量上传按广告系列分组

创建批量上传时,请尝试按父级广告系列对操作进行分组。这样可以提高效率,并降低发生有冲突的更改 / 并发错误的可能性。

考虑两个同时运行的批量上传任务。一个用于暂停某个广告组中的广告;另一个用于调整关键字出价。虽然操作是不相关的,但操作可能适用于同一广告组(或同一广告系列下的两个不同广告组)下的实体。发生这种情况时,系统将锁定父实体(共享的广告组或广告系列),从而导致批量上传任务彼此受阻。

Google Ads 脚本可以优化单个批量上传任务中的执行,因此最简单的方法是,每个帐号一次只运行一个批量上传任务。如果您决定为每个帐号运行多个批量上传,请确保针对互斥的广告系列(及其子实体)列表执行批量上传,以获得最佳效果。

Reporting(报告)

使用报告获取统计信息

如果要检索大量实体及其统计信息,使用报告比使用标准的 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());
}

不建议采用第二种方法,因为它会遍历关键字,并且一次检索一个实体的统计信息。这种情况下,报告的执行速度更快,因为它在一次调用中就提取了所有数据,并根据需要流式传输数据。此外,在第二种方法中检索到的关键字会计入脚本的配额:使用 get() 调用检索的实体数。

使用搜索功能而非报告

报告方法专为旧的基础架构而构建,即使您使用的是 GAQL,它也会以平面格式输出结果。这意味着它必须转换查询结果以匹配旧样式,旧样式并不支持所有字段,并且还会增加每个调用的开销。

我们建议您改用搜索功能,以便充分利用全新 Google Ads API 报告的所有功能。

首选 GAQL 而非 AWQL

虽然报告查询和 withCondition 调用仍然支持 AWQL,但它是通过与真正的 AWQL 不完全兼容的转换层运行的。如需完全控制查询,请确保您使用的是 GAQL

如果您想翻译现有的 AWQL 查询,可以使用我们的查询迁移工具

不要选择超出您需要的行

报告(和选择器)的执行速度取决于报告返回的总行数,无论您是否遍历这些报告。这意味着,您应始终使用特定过滤条件,以根据您的用例尽可能减少结果集。

例如,假设您希望查找出价不在某个特定范围之内的广告组。进行两个单独的查询(一个针对低于最低阈值的出价,另一个针对高于最高阈值的出价)会比提取所有广告组并忽略您不感兴趣的广告组,这样会更快。

编码方案 代码段
使用两个查询(推荐)
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 Ads 管理器 (MCC) 脚本

选择 executeInParallel 而非串行执行

为经理帐号编写脚本时,请尽可能使用 executeInParallel() 而不是串行执行。executeInParallel() 会为您的脚本提供更多的处理时间(最多 1 小时),每个帐号处理时间最长可达 30 分钟(而非串行执行的总时间不超过 30 分钟)。如需了解详情,请参阅我们的限制页面

电子表格

更新电子表格时使用批量操作

更新电子表格时,请尝试对一次只更新一个单元格的方法使用批量操作方法(例如 getRange())。

我们来考虑以下在电子表格中生成分形模式的代码段。

编码方案 代码段
在单次调用中更新一系列单元格(推荐)
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);
一次更新一个单元格(不推荐)
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 电子表格会尝试通过缓存值来优化第二个代码段,但由于要执行的 API 调用次数过多,与第一个代码段相比,它仍会导致性能不佳。