AdsApp.SnippetSelector
Typical usage:
varsnippetSelector=AdsApp.extensions().snippets().withCondition("asset.id IN [1, 2, 3]").orderBy("asset.id DESC");varsnippetIterator=snippetSelector.get();while(snippetIterator.hasNext()){varsnippet=snippetIterator.next();}
Methods:
| Member | Type | Description |
|---|---|---|
AdsApp.SnippetSelector | Sets a predefined date range onto the selector. | |
AdsApp.SnippetSelector | Sets a custom date range onto the selector. | |
| get | AdsApp.SnippetIterator | Fetches the requested snippets and returns an iterator. |
| orderBy | AdsApp.SnippetSelector | Specifies the ordering of the resulting entities. |
| withCondition | AdsApp.SnippetSelector | Adds the specified condition to the selector in order to narrow down theresults. |
| withIds | AdsApp.SnippetSelector | Restricts this selector to return only snippets with thegivensnippet IDs. |
| withLimit | AdsApp.SnippetSelector | Specifies limit for the selector to use. |
| withResourceNames | AdsApp.SnippetSelector | Restricts this selector to return only snippets with thegiven Google Ads API resource names. |
forDateRange(dateRange)
Sets a predefined date range onto the selector. Supported values:TODAY, YESTERDAY, LAST_7_DAYS, LAST_14_DAYS, LAST_30_DAYS,LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT, LAST_WEEK_MON_SUN,THIS_WEEK_MON_TODAY, THIS_WEEK_SUN_TODAY, LAST_MONTH, THIS_MONTH,ALL_TIME. Example:
selector.forDateRange("THIS_WEEK_SUN_TODAY");Date range must be specified if the selector has conditions or orderingfor a stat field. Note that only the last date range specified for theselector will take effect.
Filtering on stats is not supported for upgradedextensions (only for *attached* upgraded extensions). As such, this methodno longer does anything.Deprecated.Arguments:
| Name | Type | Description |
|---|---|---|
| dateRange | String | Date range to set onto the selector. |
Return values:
| Type | Description |
|---|---|
AdsApp.SnippetSelector | The selector with date range applied. |
forDateRange(dateFrom, dateTo)
Sets a custom date range onto the selector. Both parameters can be eitheran object containing year, month, and day fields, or an 8-digit string inYYYYMMDD form. For instance,March 24th, 2013 isrepresented as either{year: 2013, month: 3, day: 24} or"20130324". The date range is inclusive on both ends, soforDateRange("20130324", "20130324") sets the range of oneday.Date range must be specified if the selector has conditions or orderingfor a stat field. Note that only the last date range specified for theselector will take effect.
Filtering on stats is not supported for upgradedextensions (only for *attached* upgraded extensions). As such, this methodno longer does anything.Deprecated.Arguments:
| Name | Type | Description |
|---|---|---|
| dateFrom | Object | Start date of the date range. |
| dateTo | Object | End date of the date range. |
Return values:
| Type | Description |
|---|---|
AdsApp.SnippetSelector | The selector with date range applied. |
get()
Fetches the requested snippets and returns an iterator.Return values:
| Type | Description |
|---|---|
AdsApp.SnippetIterator | Iterator of the requested snippets. |
orderBy(orderBy)
Specifies the ordering of the resulting entities.orderByparameter can have one of the following forms:orderBy("metrics.cost_micros")- orders results by metrics.cost_micros, in ascending order.orderBy("metrics.ctr ASC")- orders results by metrics.ctr, in ascending order.orderBy("ad_group_criterion.cpc_bid_micros DESC")- orders results by ad_group_criterion.cpc_bid_micros, in descending order.
SeeSnippetSelector.withCondition(String) for enumeration of columns that canbe used.
orderBy() may be called multiple times. Consider thefollowing example:
selector = selector.forDateRange("LAST_14_DAYS") .orderBy("metrics.clicks DESC") .orderBy("metrics.ctr ASC");The results will be ordered by metrics.clicks in descending order.Results with equal metrics.clicks value will be ordered by metrics.ctr inascending order.
LabelNames column cannot be used for ordering.
| Name | Type | Description |
|---|---|---|
| orderBy | String | Ordering to apply. |
Return values:
| Type | Description |
|---|---|
AdsApp.SnippetSelector | The selector with ordering applied. |
withCondition(condition)
Adds the specified condition to the selector in order to narrow down theresults.Multiple conditions may be added to the same selector:
selector = selector.forDateRange("LAST_MONTH") .withCondition("metrics.clicks > 5") .withCondition("metrics.impressions > 100");AND-ed together. The aboveexample will retrieve entities that observed over 100 metrics.impressionsAND more than 5 clicks.The parameter to be passed into this method must be of the followingform:
"COLUMN_NAME OPERATOR VALUE"
Operators
The operator that can be used in a condition depends on the type of column.- For
IntegerandLongcolumns (e.g. metrics.clicks and metrics.impressions):<<= > >= = !=
- For
Doublecolumns (e.g. metrics.ctr):< >
- For
Stringcolumns (e.g. campaign.name):= != (NOT) (LIKE | CONTAINS | REGEXP_MATCH)
- For
Enumerationcolumns (ones that can only take one value from a predefined list, such as Status):= != IN () NOT IN ()
- For
StringSetcolumns (e.g. campaign.labels):CONTAINS ALL () CONTAINS ANY () CONTAINS NONE ()
IN,NOT IN,CONTAINSALL,CONTAINS ANY andCONTAINS NONEoperators look as follows:withCondition("resource.column_name IN (Value1, Value2)")Columns
All column names are case-sensitive, and so are all values of enumeratedcolumns (such as Status).
| Column | Type | Example |
|---|---|---|
| asset.id | Long | withCondition("asset.id = 12345") |
| asset.name | String | withCondition("asset.name = 'my asset'") |
| asset.structured_snippet_asset.header | String | withCondition("asset.structured_snippet_asset.header = 'Shoes'") |
Arguments:
| Name | Type | Description |
|---|---|---|
| condition | String | Condition to add to the selector. |
Return values:
| Type | Description |
|---|---|
AdsApp.SnippetSelector | The selector with the condition applied. |
withIds(ids)
Restricts this selector to return only snippets with thegivensnippet IDs.varsnippetIds=['12345','23456','34567'];selector=selector.withIds(snippetIds);
The resulting selector can be further refined by applying additionalconditions to it. The ID-based condition will then be AND-ed together withall the other conditions, including any other ID-based conditions. So, forinstance, the following selector:
AdsApp.extensions().snippets() .withIds(['12345', '23456', '34567']) .withIds(['34567', '45678', '56789']);
34567, since itwould be the onlysnippet that satisfies both ID conditions.The selector can only support up to 10,000 IDs. If more than 10,000 IDsare specified, the corresponding get() call will fail with a runtime error.
Arguments:
| Name | Type | Description |
|---|---|---|
| ids | Object[] | Array of snippet IDs. |
Return values:
| Type | Description |
|---|---|
AdsApp.SnippetSelector | The selector restricted to the given IDs. |
withLimit(limit)
Specifies limit for the selector to use. For instance,withLimit(50) returns only the first 50 entities.Arguments:
| Name | Type | Description |
|---|---|---|
| limit | int | How many entities to return. |
Return values:
| Type | Description |
|---|---|
AdsApp.SnippetSelector | The selector with limit applied. |
withResourceNames(resourceNames)
Restricts this selector to return only snippets with thegiven Google Ads API resource names.constsnippetResourceNames=['customers/1234567890/extensionFeedItems/111','customers/1234567890/extensionFeedItems/222','customers/1234567890/extensionFeedItems/333',];selector=selector.withResourceNames(snippetResourceNames);
The resulting selector can be further refined by applying additionalconditions to it. The resource name condition will then be AND-ed togetherwith all the other conditions.
The selector can only support up to 10,000 resource names. If more than10,000 resource names are specified, the corresponding get() call will failwith a runtime error.
Arguments:
| Name | Type | Description |
|---|---|---|
| resourceNames | String[] | Array of snippet resource names. |
Return values:
| Type | Description |
|---|---|
AdsApp.SnippetSelector | The selector restricted to the given resource names. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-14 UTC.