Fetches drafts. Supports filtering and sorting.
Typical usage:
var draftSelector = AdsApp.drafts()
.withCondition("BaseCampaignId = 123456789")
.orderBy("DraftName ASC");
var draftIterator = draftSelector.get();
while (draftIterator.hasNext()) {
var draft = draftIterator.next();
}
Related:
Methods:
get()
Fetches the requested drafts and returns an iterator.
Return values:
orderBy(orderBy)
Specifies the ordering of the resulting entities.
orderBy parameter can have one of the
following forms:
orderBy("DraftName") - orders results by DraftName, in ascending order.
orderBy("BaseCampaignId ASC") - orders results by base campaign id, in ascending
order.
orderBy("DraftId DESC") - orders results by draft id, in descending order.
See DraftSelector.withCondition(String) for enumeration of columns that can be used.
orderBy() may be called multiple times. Consider the following example:
selector = selector.orderBy("BaseCampaignId ASC").orderBy("DraftName");
The results will be ordered by BaseCampaignId in ascending order. Results with equal
BaseCampaignId values will be ordered by DraftName in ascending order.
Arguments:
| Name | Type | Description |
|---|
| orderBy |
String |
Ordering to apply. |
Return values:
withCondition(condition)
Adds the specified condition to the selector in order to narrow down the results.
Multiple conditions may be added to the same selector:
selector = selector
.withCondition("BaseCampaignId = 123456789")
.withCondition("DraftStatus = DRAFTED");
All specified conditions are
AND-ed together. The above example will retrieve drafts
with base campaign id 123456789 and status DRAFTED.
The parameter to be passed into this method must be of the following form:
"COLUMN_NAME OPERATOR VALUE"
Operators
The operator that can be used in a condition depends on the type of column.
- For
Long columns (e.g. BaseCampaignId):
< <= > >= = !=
- For
String columns (e.g. DraftName):
= != STARTS_WITH STARTS_WITH_IGNORE_CASE
CONTAINS CONTAINS_IGNORE_CASE DOES_NOT_CONTAIN DOES_NOT_CONTAIN_IGNORE_CASE
- For
Enumeration columns (ones that can only take one value from a predefined
list, such as DraftStatus) and Boolean columns:
= != IN [] NOT_IN []
Conditions using
IN and
NOT_IN operators look as follows:
withCondition("ColumnName IN [Value1, Value2]")
Operators are case-sensitive:
starts_with won't work.
Columns
All column names are case-sensitive, and so are all values of enumerated columns (such as
DraftStatus).
| Column |
Type |
Example |
| DraftName |
String |
withCondition("DraftName CONTAINS 'draft_'") |
| DraftStatus |
Enumeration: DRAFTED, APPLIED, APPLYING,
REMOVED, UNABLE_TO_APPLY |
withCondition("DraftStatus = DRAFTED") |
| BaseCampaignId |
Long |
withCondition("BaseCampaignId = 123456789") |
| DraftCampaignId |
Long |
withCondition("DraftCampaignId = 123456789") |
| DraftId |
Long |
withCondition("DraftId = 123456789") |
| HasRunningExperiment |
Boolean |
withCondition("HasRunningExperiment = true") |
Arguments:
| Name | Type | Description |
|---|
| condition |
String |
Condition to add to the selector. |
Return values:
withIds(ids)
Restricts this selector to return only drafts with the given
draft IDs.
All drafts are uniquely identified by the combination of their
base campaign ID and draft ID. The IDs for this selector are thus
represented as two-element arrays, with the first element being the base campaign ID and
the second being the draft ID:
var draftIds = [
[12345, 987987],
[23456, 876876],
[34567, 765765],
];
selector = selector.withIds(draftIds);
The resulting selector can be further refined by applying additional conditions to it. The
ID-based condition will then be AND-ed together with all the other conditions, including any
other ID-based conditions. So, for instance, the following selector:
var ids1 = [
[12345, 987987],
[23456, 876876],
[34567, 765765],
];
var ids2 = [
[34567, 765765],
[45678, 654654],
[56789, 543543],
];
AdsApp.drafts()
.withIds(ids1)
.withIds(ids2);
will only get the draft with ID
[34567, 765765], since it would be
the only draft that satisfies both ID conditions.
Arguments:
| Name | Type | Description |
|---|
| ids |
long[][] |
Array of draft IDs. |
Return values:
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:
