CampaignExcludedAudienceSelector

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

使用範例:

    // Gets the iterator that iterates all campaigns
    // in the account.
    var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get();

    // Loops through all campaigns in the account.
    while (iterator.hasNext()) {
        var campaign = iterator.next();

        // Gets the iterator that iterates all campaign excluded audiences
        // in the campaign excluded audience.
        var audienceIterator = campaign.targeting().excludedAudiences()
            .withLimit(10)
            .withIds("123456789")
            .get();
    
        // Loops through all campaign excluded audiences in the campaign excluded audience.
        while (audienceIterator.hasNext()) {
            var audience = audienceIterator.next();
        }
    }

方法

方法名稱 傳回類型 描述
get CampaignExcludedAudienceIterator 取得反覆運算器,用來逐一查看廣告活動排除的客群清單。
orderBy (字串 orderBy) CampaignExcludedAudienceSelector 將指定的排序套用至選取的廣告活動排除的客群。
withCondition (字串條件) CampaignExcludedAudienceSelector 將篩選條件套用至廣告活動排除的客群。
withIds (string[] ids) CampaignExcludedAudienceSelector 取得具有指定識別碼的廣告活動排除客群。
withLimit (int limit) CampaignExcludedAudienceSelector 取得符合選取準則的前 n 個廣告活動排除客群。

取得

取得反覆運算 ,用來逐一查看廣告活動排除的客群清單。

傳回

類型 描述
CampaignExcludedAudienceIterator 用於逐一查看所選廣告活動的反覆運算器排除了客群。

orderBy (字串 orderBy)

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

在 “columnName orderDirection” 表單中指定 orderBy 參數,其中:

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

例如,下列呼叫會依 AverageCpc 遞增順序傳回廣告活動排除的客群。

selector = selector.orderBy("AverageCpc");

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

引數

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

傳回

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

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

支援的資料欄位

廣告活動排除的客群篩選支援的資料欄位。 名稱區分大小寫。

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

欄位 類型 範例
AudienceId long 相關聯客群的 ID。

withCondition("AudienceId = 123456789")
CampaignName 字串 協會行銷活動的名稱。

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus 列舉 協會行銷活動的狀態。 可能會區分大小寫的值如下:
  • 已啟用
  • 已暫停
  • 已移除
此範例只會傳回父系行銷活動已暫停的已排除客群。

withCondition("CampaignStatus = PAUSED")
狀態 列舉 關聯的狀態。 可能會區分大小寫的值如下:
  • 已啟用
  • 已暫停
  • 已移除
此範例只會傳回已啟用的廣告活動排除客群。

withCondition("Status = ENABLED")
UserListName 字串 相關聯客群的名稱。

withCondition("UserListName = 'foo'")

引數

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

傳回

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

withIds (string[] ids)

取得具有指定識別碼的廣告活動排除客群。

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

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

引數

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

傳回

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

withLimit (int limit)

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

引數

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

傳回

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