AdGroupAudienceSelector

Artikkeli
11/13/2024

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

Example usage:

    // Gets the iterator that iterates all ad group audiences
    // in the account.
    var iterator = AdsApp.adGroups().get();

    // Loops through all ad groups in the account.
    while (iterator.hasNext()) {
        var adGroup = iterator.next();

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

Methods

Method Name	Return Type	Description
forDateRange(Object dateFrom, Object dateTo)	AdGroupAudienceSelector	Applies the start and end dates for selecting performance metrics.
forDateRange(string dateRange)	AdGroupAudienceSelector	Applies the predefined date range for selecting performance metrics.
get	AdGroupAudienceIterator	Gets an iterator used to iterate through the list of ad group audiences.
orderBy(string orderBy)	AdGroupAudienceSelector	Applies the specified ordering to the selected ad group audiences.
withCondition(string condition)	AdGroupAudienceSelector	Applies filter criteria to the ad group audiences.
withIds(string[] ids)	AdGroupAudienceSelector	Gets ad group audiences with the specified IDs.
withLimit(int limit)	AdGroupAudienceSelector	Gets the top n ad group audiences that match the selection criteria.

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

Name	Type	Description
dateFrom	Object	The start date of the date range that specifies the performance data to include in the selector. Specify the date using a string in the form, YYYYMMDD, or an object in the form, {year: 2020, month: 12, day: 31}.
dateTo	Object	The end date of the date range that specifies the performance data to include in the selector. Specify the date using a string in the form, YYYYMMDD, or an object in the form, {year: 2020, month: 12, day: 1}.

Returns

Type	Description
AdGroupAudienceSelector	Selector with date range applied.

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

Name	Type	Description
dateRange	String	The predefined date range string that specifies the performance data to include in the selector. The predefined date-range string is case sensitive. Possible case-sensitive values are: 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.

Returns

Type	Description
AdGroupAudienceSelector	Selector with date range applied.

get

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

Returns

Type	Description
AdGroupAudienceIterator	An iterator used to iterate through the selected ad group audiences.

orderBy(String orderBy)

Applies the specified ordering to the selected ad group 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 ad group 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

Name	Type	Description
orderBy	string	The ordering to apply.

Returns

Type	Description
AdGroupAudienceSelector	Selector with ordering applied.

withCondition(String condition)

Applies filter criteria to the ad group 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 ad group audience filtering. The names are case sensitive.

The following are the performance metrics columns you may specify.

Column	Type	Example
AbsoluteTopImpressionRate	double	`withCondition("AbsoluteTopImpressionRate > 0.25")`
AverageCpc	double	`withCondition("AverageCpc < 2.75")`
AverageCpm	double	`withCondition("AverageCpm > 0.65")`
ClickConversionRate	double	`withCondition("ClickConversionRate > 0.25")`
Clicks	long	`withCondition("Clicks >= 33")`
ConvertedClicks	long	`withCondition("ConvertedClicks >= 10")`
Cost	double	`withCondition("Cost > 3.25")` The cost is in the account's currency.
Ctr	double	`withCondition("Ctr > 0.05")` The CTR is in the range 0..1, so use 0.05 for a 5% CTR.
Impressions	long	`withCondition("Impressions > 10")`
TopImpressionRate	double	`withCondition("TopImpressionRate > 0.25")`

The following are the entity properties you may specify.

Column	Type	Example
AdGroupName	string	The name of the association's ad group. `withCondition("AdGroupName CONTAINS_IGNORE_CASE 'truck'")`
AdGroupStatus	enumeration	The status of the association's ad group. Possible case-sensitive values are: ENABLED PAUSED REMOVED This example returns only ad group audiences whose parent ad group is paused. `withCondition("AdGroupStatus = PAUSED")`
AudienceId	long	The associated audience's ID. `withCondition("AudienceId = 123456789")`
CampaignName	string	The name of the campaign that contains the association's ad group. `withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")`
CampaignStatus	enumeration	The status of the campaign that contains the association's ad group. Possible case-sensitive values are: ENABLED PAUSED REMOVED This example returns only ad group audiences whose parent campaign is paused. `withCondition("CampaignStatus = PAUSED")`
Status	enumeration	The association's status. Possible case-sensitive values are: ENABLED PAUSED REMOVED This example returns only enabled ad group audiences. `withCondition("Status = ENABLED")`
UserListName	string	The associated audience's name. `withCondition("UserListName = 'foo'")`

Arguments

Name	Type	Description
condition	string	The condition to apply to the selector.

Returns

Type	Description
AdGroupAudienceSelector	Selector with the condition applied.

withIds(string[] ids)

Gets ad group 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 ad group audience 33333.

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

Arguments

Name	Type	Description
ids	string[]	An array of ad group audience IDs. For limits, see Script execution limits.

Returns

Type	Description
AdGroupAudienceSelector	Selector with the IDs applied.

withLimit(int limit)

Gets the top n ad group audiences that match the selection criteria.

Arguments

Name	Type	Description
limit	int	The number of ad group audiences to return. The actual number may be less.

Returns

Type	Description
AdGroupAudienceSelector	Selector with limit applied.

Jaa

AdGroupAudienceSelector

Methods

forDateRange(Object dateFrom, Object dateTo)

Arguments

Returns

forDateRange(String dateRange)

Arguments

Returns

get

Returns

orderBy(String orderBy)

Arguments

Returns

withCondition(String condition)

Operators

Supported Columns

Arguments

Returns

withIds(string[] ids)

Arguments

Returns

withLimit(int limit)

Arguments

Returns

Palaute

Lisäresursseja