AssetGroupSelector

包含用于对资产组列表进行筛选和排序的方法。 有关选择器的信息,请参阅 选择器

示例用法:

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

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

方法

方法名称 返回类型 说明
get AssetGroupIterator 获取用于循环访问资产组列表的迭代器。
orderBy (字符串 orderBy) AssetGroupSelector 将指定的顺序应用于选定的资产组。
withCondition (字符串条件) AssetGroupSelector 将筛选条件应用于资产组。
withIds (string[] ids) AssetGroupSelector 获取具有指定 ID 的资产组。
withLimit (int limit) AssetGroupSelector 获取与选择条件匹配的前 n 个 资产组。

get

获取用于循环访问资产组列表的 迭代器

返回

类型 说明
AssetGroupIterator 用于循环访问所选资产组的迭代器。

orderBy (字符串 orderBy)

将指定的顺序应用于选定的资产组。

在“columnName orderDirection”格式中指定 orderBy 参数,其中:

  • columnName受支持的列之一。
  • orderDirection 是对结果排序所依据的顺序。 设置为 ASC 以按升序对结果进行排序,设置为 DESC 以按降序对结果进行排序。 默认值为 ASC。

例如,以下调用按 Averagecpc 升序返回资产组。

selector = selector.orderBy("AverageCpc");

选择器仅支持按一个字段对实体进行排序。 您不能按字段 x 排序实体列表,按字段 y 排序 x 内的实体列表,等等。 如果在链或单独的选择器调用中指定多个 orderBy() 调用,脚本将使用上次 orderBy() 调用中指定的字段对实体列表进行排序。 

参数

名称 类型 说明
orderBy string 要应用的顺序。

返回

类型 说明
AssetGroupSelector 应用了排序的选择器。

withCondition (字符串条件)

将筛选条件应用于资产组。

在“columnName operator value”格式中指定 条件 参数,其中:

运算符

使用的运算符取决于列的类型。 运算符区分大小写。 例如,使用 STARTS_WITH 而不是 starts_with。

包含整数和长值的列的运算符:

<
<=
>
>=
=
!=

包含 double 值的列的运算符:

<
>

包含字符串值的列的运算符:

=
!=
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 范围内,因此对于 5% 的 CTR 使用 0.05。
展现量 long withCondition("Impressions > 10")
TopImpressionRate double withCondition("TopImpressionRate > 0.25")

以下是可指定的实体属性。

类型 示例
状态 枚举 资产组的状态。 可能的区分大小写的值为:
  • 已启用
  • 已暂停
  • 已删除
此示例仅返回已启用的资产组。

withCondition("Status = ENABLED")
名称 string 资产组的名称。

withCondition("Name CONTAINS_IGNORE_CASE 'sport'")
CampaignName string 市场活动的名称。

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
此示例仅返回父广告系列类型为“购物”的素材资源组。

withCondition("CampaignType = SHOPPING")

参数

名称 类型 说明
条件 string 要应用于选择器的条件。

返回

类型 说明
AssetGroupSelector 应用了条件的选择器。

withIds (string[] ids)

获取具有指定 ID 的资产组。

可以对选择器应用一个或多个条件。 条件链被视为 AND 操作。 例如,仅当条件 A 为 True 且条件 B 为 true 时,才会选择实体。 例如,以下调用仅选择资产组 33333。

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

参数

名称 类型 说明
ids string[] 资产组 ID 的数组。 有关限制,请参阅 脚本执行限制

返回

类型 说明
AssetGroupSelector 应用了 ID 的选择器。

withLimit (int limit)

获取与选择条件匹配的前 n 个 资产组。

参数

名称 类型 说明
limit int 要返回的资产组数。 实际数字可能更少。

返回

类型 说明
AssetGroupSelector 应用了限制的选择器。

另请参阅

Campaign.assetGroups ()