CampaignAudienceSelector

Contains the methods for filtering and sorting a list of campaign audiences. For information about selectors, see Selectors.

Example usage:

    // 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 audiences
        // in the campaign audience.
        var audienceIterator = campaign.targeting().audiences()
            .withLimit(10)
            .withIds("123456789")
            .get();
    
        // Loops through all campaign audiences in the campaign audience.
        while (audienceIterator.hasNext()) {
            var audience = audienceIterator.next();
        }
    }

Methods

forDateRange(Object dateFrom, Object dateTo)

Applies the start and end dates for selecting performance metrics.

Specify a date range only if:

• You apply conditions or ordering that reference performance metric fields.
• You want to get performance data for the objects you're selecting. For example, if you plan to call the getStats() method.

You may specify the date parameters using strings or objects. To use strings, specify the date in the form, YYYYMMDD. If you use objects, create an object with the following fields:

• year
• month
• day

For example:

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

The month is one-based where 1 is January and 12 is December.

The date range is inclusive. If you specify multiple date ranges, only the last date range is used.

Arguments

Returns

forDateRange(String dateRange)

Applies the predefined date range for selecting performance metrics.

Specify a date range only if:

• You apply conditions or ordering that reference performance metric fields.
• You want to get performance data for the objects you're selecting. For example, if you plan to call the getStats() method.

If you specify multiple date ranges, only the last date range is used.

Supported date range values:

• TODAY
• YESTERDAY
• 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

Arguments

Returns

get

Gets an iterator used to iterate through the list of campaign audiences.

Returns

orderBy(String orderBy)

Applies the specified ordering to the selected campaign audiences.

Specify the orderBy parameter in the form, "columnName orderDirection" where:

• columnName is one of the supported columns.
• orderDirection is the order to sort the results in. Set to ASC to order the results in ascending order or DESC to order the results in descending order. The default is ASC.

For example, the following call returns campaign audiences in ascending order by AverageCpc.

selector = selector.orderBy("AverageCpc");

Selectors support ordering entities by one field only. You may not order the list of entities by field x, and within x by field y, and so on. If you specify more than one orderBy() call in a chain or in separate selector calls, Scripts orders the list of entities using the field specified in the last orderBy() call. 

Arguments

Returns

withCondition(String condition)

Applies filter criteria to the campaign audiences.

Specify the condition parameter in the form, "columnName operator value" where:

• columnName is one of the supported Columns. If columName is set to a performance metric column name, you must specify a date range using forDateRange(String dateRange) or forDateRange(Object dateFrom, Object dateTo).
• operator is one of the supported operators.

Operators

The operator that you use depends on the column's type. Operators are case-sensitive. For example, use STARTS_WITH instead of starts_with.

Operators for columns that contain integers and long values:

<
<=
>
>=
=
!=

Operators for columns that contain double values:

<
>

Operators for columns that contain string values:

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

Operators for columns that contain enumeration values:

=
!=
IN []
NOT_IN []

Operators for columns that contain an array of strings:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Supported Columns

Supported columns for campaign audience filtering. The names are case sensitive.

The following are the performance metrics columns you may specify.

The following are the entity properties you may specify.

Arguments

Returns

withIds(string[] ids)

Gets campaign audiences with the specified IDs.

You may apply one or more conditions to a selector. A chain of conditions is considered an AND operation. For example, the entity is selected only if condition A is true AND condition B is true. For example, the following call selects only campaign audience 33333.

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

Arguments

Returns

withLimit(int limit)

Gets the top n campaign audiences that match the selection criteria.

Arguments

Returns