共用方式為

AdGroupSelector

  • 發行項

包含篩選和排序廣告群組清單的方法。 如需選取器的相關資訊，請參閱 選取器。

範例使用方式：

    var iterator = AdsApp.adGroups()
        .withCondition("ClickConversionRate > 0.3")
        .forDateRange("LAST_WEEK")
        .orderBy("Clicks DESC")
        .get();

    while (iterator.hasNext()) {
        var adGroup = iterator.next();
        var metrics = adGroup.getStats();
    }

方法

方法名稱 傳回類型 說明
forDateRange (Object dateFrom， Object dateTo) AdGroupSelector 套用開始和結束日期以選取效能計量。
forDateRange (字串 dateRange) AdGroupSelector 套用預先定義的日期範圍，以選取效能計量。
get AdGroupIterator 取得用來逐一查看廣告群組清單的反覆運算器。
orderBy (字串 orderBy) AdGroupSelector 將指定的順序套用至選取的廣告群組。
withCondition (字串條件) AdGroupSelector 將篩選準則套用至廣告群組。
withIds (string[] ids) AdGroupSelector 取得具有指定識別碼的廣告群組。
withLimit (int 限制) AdGroupSelector 取得符合選取準則的前 n 個廣告群組。

forDateRange (Object dateFrom， Object dateTo)

套用開始和結束日期以選取效能計量。

只有在下列狀況下，才指定日期範圍：

  • 您可以套用參考效能計量欄位的條件或順序。
  • 您想要取得所選物件的效能資料。 例如，如果您打算呼叫 getStats() 方法。

您可以使用字串或物件來指定日期參數。 若要使用字串，請以 YYYYMMDD 格式指定日期。 如果您使用 物件，請使用下欄欄位建立 物件：

  • 年
  • 月
  • 一天

例如：

var date = {year: 2018, month: 5, day: 13};

月份是以一為基底，其中 1 是 1 月，12 是 12 月。

日期範圍包含在內。 如果您指定多個日期範圍，則只會使用最後一個日期範圍。

引數

名稱 類型 說明
dateFrom 物件 日期範圍的開始日期，指定要包含在選取器中的效能資料。
dateTo 物件 日期範圍的結束日期，指定要包含在選取器中的效能資料。

傳回

類型 說明
AdGroupSelector 已套用日期範圍的選取器。

forDateRange (String dateRange)

套用預先定義的日期範圍，以選取效能計量。

只有在下列狀況下，才指定日期範圍：

  • 您可以套用參考效能計量欄位的條件或順序。
  • 您想要取得所選物件的效能資料。 例如，如果您打算呼叫 getStats() 方法。

如果您指定多個日期範圍，則只會使用最後一個日期範圍。

支援的日期範圍值：

  • 今天
  • 昨天
  • LAST_WEEK
  • LAST_BUSINESS_WEEK
  • LAST_7_DAYS
  • THIS_WEEK_SUN_TODAY
  • LAST_14_DAYS
  • LAST_30_DAYS
  • LAST_WEEK_SUN_SAT
  • THIS_MONTH
  • LAST_MONTH
  • ALL_TIME

引數

名稱 類型 說明
dateRange 字串 預先定義的日期範圍字串，指定要包含在選取器中的效能資料。 預先定義的日期範圍字串會區分大小寫。

傳回

類型 說明
AdGroupSelector 已套用日期範圍的選取器。

獲取

取得用來逐一查看廣告群組清單的 反覆運算器 。

傳回

類型 說明
AdGroupIterator 反覆運算器，用來逐一查看選取的廣告群組。

orderBy (String orderBy)

將指定的順序套用至選取的廣告群組。

以 「columnName orderDirection」 格式指定 orderBy 參數，其中：

  • columnName 是其中一個 支援的資料行。
  • orderDirection 是排序結果的順序。 設定為 ASC，以遞增順序排序結果或 DESC，以遞減順序排序結果。 預設值為 ASC。

例如，下列呼叫會依 AverageCpc 以遞增順序傳回廣告群組。

selector = selector.orderBy("AverageCpc");

選取器僅支援依一個欄位排序實體。 您不能依欄位 x 排序實體清單，也無法依欄位 y 排序 x 中的實體清單，依此類推。 如果您在鏈結或個別選取器呼叫中指定多個呼叫，則腳本會使用上 orderBy() 一個 orderBy() 呼叫中指定的欄位來排序實體清單。 

引數

名稱 類型 說明
orderBy 字串 要套用的順序。

傳回

類型 說明
AdGroupSelector 已套用排序的選取器。

withCondition (字串條件)

將篩選準則套用至廣告群組。

指定 「columnName 運算子值」 格式 的條件 參數，其中：

運算子

您使用的運算子取決於資料行的類型。 運算子會區分大小寫。 例如，使用 STARTS_WITH 而非 starts_with。

包含整數和長值之資料行的運算子：

<
<=
>
>=
=
!=

包含雙精度浮點數之資料行的運算子：

<
>

包含字串值之資料行的運算子：

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

包含列舉值之資料行的運算子：

=
!=
IN []
NOT_IN []

包含字串陣列之資料行的運算子：

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

支援的資料行

支援用於廣告群組篩選的資料行。 名稱區分大小寫。

以下是您可以指定的效能計量資料行。

欄位 類型 範例
AbsoluteTopImpressionRate double withCondition("AbsoluteTopImpressionRate > 0.25")
AverageCpc double withCondition("AverageCpc < 2.75")
AverageCpm double withCondition("AverageCpm > 0.65")
ClickConversionRate double withCondition("ClickConversionRate > 0.25")
點擊 long withCondition("Clicks >= 33")
ConvertedClicks long withCondition("ConvertedClicks >= 10")
成本 double withCondition("Cost > 3.25")

成本是以帳戶的貨幣為單位。
點擊率 double withCondition("Ctr > 0.05")

CTR 的範圍為 0..1，因此使用 0.05 表示 5% CTR。
閱聽 long withCondition("Impressions > 10")
TopImpressionRate double withCondition("TopImpressionRate > 0.25")

以下是您可以指定的實體屬性。

欄位 類型 範例
狀態 枚舉 廣告群組的狀態。 可能區分大小寫的值為：
  • 啟用
  • 暫停
  • 刪除
此範例只會傳回已啟用的廣告群組。

withCondition("Status = ENABLED")
名稱 字串 廣告群組的名稱。

withCondition("Name CONTAINS_IGNORE_CASE 'sport'")
CampaignName 字串 行銷活動的名稱。

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
KeywordMaxCpc double 廣告群組的一次的檢索。 中標是以帳戶的貨幣表示。

withCondition("KeywordMaxCpc > 5.0")
CampaignStatus 枚舉 行銷活動的狀態。 可能區分大小寫的值為：
  • 啟用
  • 暫停
  • 刪除
此範例只會傳回其父活動已暫停的廣告群組。

withCondition("CampaignStatus = PAUSED")
LabelNames 字串集 一或多個區分大小寫的標籤名稱清單。 使用 取得與具名標籤相關聯的廣告群組。

withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']")
CampaignType 枚舉 行銷活動的類型。 可能區分大小寫的值為：
  • SEARCH_AND_CONTENT
  • 購物
  • DYNAMIC_SEARCH_ADS
此範例只會傳回父活動類型為 Shopping 的廣告群組。

withCondition("CampaignType = SHOPPING")

引數

名稱 類型 說明
條件 字串 要套用至選取器的條件。

傳回

類型 說明
AdGroupSelector 已套用條件的選取器。

withIds (string[] ids)

取得具有指定識別碼的廣告群組。

您可以將一或多個條件套用至選取器。 條件鏈結會被視為 AND 作業。 例如，只有在條件 A 為 true 且條件 B 為 true 時，才會選取實體。 例如，下列呼叫只會選取廣告群組 33333。

var selector = AdsApp.adGroups()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

引數

名稱 類型 說明
Id string[] 廣告群組識別碼的陣列。 如需限制，請參閱 腳本執行限制。

傳回

類型 說明
AdGroupSelector 已套用識別碼的選取器。

withLimit (int 限制)

取得符合選取準則的前 n 個廣告群組。

引數

名稱 類型 說明
限制 int 要傳回的廣告群組數目。 實際數目可能較少。

傳回

類型 說明
AdGroupSelector 已套用限制的選取器。

另請參閱

AdsApp.adGroups ()