CampaignSelector

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

使用範例：

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

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

方法

方法名稱 傳回類型 描述
forDateRange (Object dateFrom， Object dateTo) CampaignSelector 套用選取效能指標的開始日期和結束日期。
forDateRange (字串 dateRange) CampaignSelector 套用預先定義的日期範圍以選取效能指標。
get CampaignIterator 取得用來逐一查看行銷活動清單的反覆運算器。
orderBy (字串 orderBy) CampaignSelector 將指定的排序套用至選取的廣告活動。
withCondition (字串條件) CampaignSelector 將篩選條件套用至廣告活動清單。
withIds (string[] ids) CampaignSelector 取得具有指定識別碼的廣告活動。
withLimit (int limit) CampaignSelector 取得符合選取準則的前 n 個 廣告活動。

forDateRange (Object dateFrom， Object dateTo)

套用選取效能指標的開始日期和結束日期。

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

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

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

  • 年
  • 月
  • 天

例如：

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

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

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

引數

名稱 類型 描述
dateFrom 物件 指定要包含在選取器中的廣告成效資料的日期範圍的開始日期。
dateTo 物件 指定要包含在選取器中的廣告成效資料之日期範圍的結束日期。

傳回

類型 描述
CampaignSelector 已套用日期範圍的選取器。

forDateRange (字串 dateRange)

套用預先定義的日期範圍以選取效能指標。

支援的日期範圍值：

  • 今天
  • 昨天
  • 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

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

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

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

引數

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

傳回

類型 描述
CampaignSelector 已套用日期範圍的選取器。

取得

取得用來逐一查看行銷活動清單的 反覆運算器 。

傳回

類型 描述
CampaignIterator 用來逐一查看所選行銷活動的反覆運算器。

orderBy (字串 orderBy)

將指定的排序套用至選取的廣告活動。

在 “columnName orderDirection” 表單中指定 orderBy 參數，其中：

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

例如，下列呼叫會依 AverageCpc 遞增順序傳回廣告活動。

selector = selector.orderBy("AverageCpc");

選取器僅支援依一個欄位來排序實體。 您不得依欄位 x、在 x 內依欄位 y 排序實體清單，依此類推。 如果您在鏈結或單獨的選擇器呼叫中指定多個 orderBy() 呼叫，則指令碼會使用上次 orderBy() 呼叫中指定的欄位對實體清單進行排序。 

引數

名稱 類型 描述
orderBy 字串 要申請的順序。

傳回

類型 描述
CampaignSelector 已套用排序的選擇器。

withCondition (字串條件)

將篩選條件套用至廣告活動廣告活動清單。

在「columnName operator value」表單中指定 條件 參數，其中：

運算子

您使用的運算子取決於資料欄位的類型。 運算子會區分大小寫。 例如，使用 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")

費用以帳戶貨幣表示。
Ctr double withCondition("Ctr > 0.05")

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

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

欄位 類型 範例
狀態 列舉 行銷活動的狀態。 可能會區分大小寫的值如下：
  • 已啟用
  • 已暫停
  • 已移除
  • BUDGET_PAUSED
  • BUDGET_AND_USER_PAUSED
此範例僅傳回已啟用。

withCondition("Status = ENABLED")
名稱 字串 行銷活動的名稱。

withCondition("Name CONTAINS_IGNORE_CASE 'clearance'")
Budget double 廣告活動的預算。

withCondition("Budget > 500.0")
BudgetType 列舉 廣告活動的預算類型。 可能會區分大小寫的值如下：
  • 標準版
  • 加速
withCondition("BudgetType = 'STANDARD'")
DeliveryStatus 列舉 廣告活動的廣告播送狀態。 可能會區分大小寫的值如下：
  • 符合資格
  • LIMITED_BY_BUDGET
  • 保留
  • CAMPAIGN_OUT_OF_BUDGET
  • CAMPAIGN_SUSPENDED
  • CAMPAIGN_PAUSED
withCondition("DeliveryStatus NOT_IN ['LIMITED_BY_BUDGET', 'HOLD', 'CAMPAIGN_OUT_OF_BUDGET']")
LabelNames 字串集 一或多個區分大小寫的標籤名稱清單。 用來取得與具名標籤相關聯的廣告活動。

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

withCondition("CampaignType = SHOPPING")

引數

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

傳回

類型 描述
CampaignSelector 具有套用條件的選擇器。

withIds (string[] ids)

取得具有指定識別碼的廣告活動。

您可以將一或多個條件套用至選取器。 條件鏈會被視為 AND 運算。 例如，只有在條件 A 為 True 且條件 B 為 True 時，才會選取實體。 例如，下列呼叫只會選取行銷活動 33333。

AdsApp.campaigns()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

引數

名稱 類型 描述
IDS string[] 廣告活動識別碼的陣列。 如需限制，請參閱 指令碼執行限制。

傳回

類型 描述
CampaignSelector 具有套用識別碼的選擇器。

withLimit (int limit)

取得符合選取準則的前 n 個 廣告活動。

引數

名稱 類型 描述
限制 int 要返回的廣告活動數目。 實際數字可能會更少。

傳回

類型 描述
CampaignSelector 已套用限制的選取器。

另請參閱

  • Last updated on