Edit

LabelSelector

  • Article

Contains the methods for filtering and ordering a list of labels in the account. For information about selectors, see Selectors.

Methods

Method Name Return Type Description
get LabelIterator Gets an iterator used to iterate through the list of labels.
orderBy(string orderBy) LabelSelector Applies the specified ordering to the selected labels.
withCondition(string condition) LabelSelector Applies filter criteria to the labels.
withIds(string[] ids) LabelSelector Gets labels with the specified IDs.
withLimit(int limit) LabelSelector Gets the top n labels that match the selection criteria.

get

Gets an iterator used to iterate through the list of labels.

Returns

Type Description
LabelIterator An iterator used to iterate through the selected labels.

orderBy(string orderBy)

Applies the specified ordering to the selected labels.

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 results in ascending order by the label's name.

selector = selector.orderBy("Name");

If you specify a count column, such as KeywordCount, the selector orders by count and then by name in ascending order.

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
LabelSelector Selector with ordering applied.

withCondition(String condition)

Applies filter criteria to the labels.

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

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 for label filtering. The column names are case sensitive.

Column Type Example
Name string The label's name.

withCondition("Name = 'foo'")
KeywordCount string The number of keywords associated with the label.

withCondition("KeywordCount > 5")
AdCount string The number of ads associated with the label.

withCondition("AdCount > 5")
AdGroupCount string The number of ad groups associated with the label.

withCondition("AdGroupCount > 5")
CampaignCount string The number of campaigns associated with the label.

withCondition("CampaignCount > 5")

Arguments

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

Returns

Type Description
LabelSelector Selector with the condition applied.

withIds(string[] ids)

Gets labels 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 label 33333.

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

Arguments

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

Returns

Type Description
LabelSelector Selector with the IDs applied.

withLimit(int limit)

Gets the top n labels that match the selection criteria.

Arguments

Name Type Description
limit int The number of labels to return. The actual number may be less.

Returns

Type Description
LabelSelector Selector with limit applied.

See also