@adkit/cli 1.13.11 → 1.13.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli.js +19 -6
- package/package.json +1 -1
package/dist/cli.js
CHANGED
|
@@ -4569,19 +4569,20 @@ function formatHelpSearch(data) {
|
|
|
4569
4569
|
for (const result of cliData.results) {
|
|
4570
4570
|
lines.push(`adkit ${result.path} --help`);
|
|
4571
4571
|
if (result.description) lines.push(` ${result.description}`);
|
|
4572
|
+
if (result.snippet) lines.push(` \u21B3 ${result.snippet}`);
|
|
4572
4573
|
}
|
|
4573
4574
|
lines.push("", "Each command above opens the matching CLI help.");
|
|
4574
4575
|
return lines.join("\n");
|
|
4575
4576
|
}
|
|
4576
4577
|
function serverHelpPointerToCli(result) {
|
|
4577
4578
|
const override = CLI_HELP_OVERRIDES[result.path];
|
|
4578
|
-
if (override) return { path: override.path, description: override.description || result.description };
|
|
4579
|
+
if (override) return { path: override.path, description: override.description || result.description, snippet: result.snippet };
|
|
4579
4580
|
const negativeListPrefix = "manage google negative-list ";
|
|
4580
4581
|
if (result.path.startsWith(negativeListPrefix)) {
|
|
4581
4582
|
const action = result.path.slice(negativeListPrefix.length);
|
|
4582
|
-
return { path: `manage google keywords negative-lists ${action}`, description: result.description };
|
|
4583
|
+
return { path: `manage google keywords negative-lists ${action}`, description: result.description, snippet: result.snippet };
|
|
4583
4584
|
}
|
|
4584
|
-
if (result.path.startsWith("manage platform-api-request ")) return { path: "manage platform-api-requests", description: result.description };
|
|
4585
|
+
if (result.path.startsWith("manage platform-api-request ")) return { path: "manage platform-api-requests", description: result.description, snippet: result.snippet };
|
|
4585
4586
|
return result;
|
|
4586
4587
|
}
|
|
4587
4588
|
function isHelpSearchResponse(value) {
|
|
@@ -6095,22 +6096,34 @@ ${FLAG.data}
|
|
|
6095
6096
|
--campaign-ids <ids> Comma-separated campaign IDs for filtered reads
|
|
6096
6097
|
--campaign <id> Parent campaign ID (create only)
|
|
6097
6098
|
--name <name> Ad group name
|
|
6098
|
-
--status <s> active, paused
|
|
6099
|
+
--status <s> active, paused (create default: paused)
|
|
6099
6100
|
--budget-daily <n> Daily budget in account currency
|
|
6100
6101
|
--budget-lifetime <n> Lifetime budget in account currency
|
|
6101
6102
|
--start-date <value> Optional TikTok schedule datetime; omit to start now
|
|
6102
6103
|
--end-date <value> Optional TikTok schedule datetime; required with lifetime budget
|
|
6103
6104
|
--billing-event <s> cpc, cpm, ocpm
|
|
6104
6105
|
--bid-strategy <s> bid_type_no_bid, bid_type_custom, bid_type_max_conversion
|
|
6105
|
-
--optimization <s> click, convert, lead_generation, video_view, reach
|
|
6106
|
+
--optimization <s> click, convert, lead_generation, video_view, reach, value
|
|
6106
6107
|
--bid-amount <n> Custom bid in account currency; conversion/OCPM maps to cost per conversion
|
|
6107
6108
|
--event-type <s> purchase, add_to_cart, view_content, complete_registration, lead, submit_form
|
|
6108
6109
|
--pixel <id> Pixel ID; falls back to account default pixel when conversion is used
|
|
6109
6110
|
--placement <ids> Override TikTok placement IDs (publish default: PLACEMENT_TIKTOK)
|
|
6110
6111
|
|
|
6112
|
+
Value Optimization (website):
|
|
6113
|
+
--optimization value bids on purchase value. It needs --event-type purchase plus a pixel (--pixel, or the account default), and rejects --bid-strategy, --bid-amount, and any --billing-event other than ocpm.
|
|
6114
|
+
targetRoas has no flag \u2014 send it with --data. targetRoas set = Minimum ROAS (0.01-1000, where 1.5 = 150%); targetRoas omitted = Highest Value.
|
|
6115
|
+
update only retunes targetRoas on an ad group that already uses Value Optimization. TikTok cannot move an ordinary ad group onto it \u2014 create a new ad group instead.
|
|
6116
|
+
TikTok checks account and pixel eligibility, so a valid payload can still be rejected at publish.
|
|
6117
|
+
|
|
6111
6118
|
Examples:
|
|
6112
6119
|
adkit manage tiktok ad-groups create --campaign 1770 --name "US Broad" --budget-daily 50 --billing-event cpc --optimization click
|
|
6113
|
-
adkit manage tiktok ad-groups create --data '{"adGroups":[{"campaignId":"1770","name":"Purchase","budget":{"daily":50},"startDate":"2026-05-15 12:00:00","bidAmount":80,"conversion":{"eventType":"purchase"},"targeting":{"geoLocations":{"include":[{"type":"country","country":"US"}]}}}]}'
|
|
6120
|
+
adkit manage tiktok ad-groups create --data '{"adGroups":[{"campaignId":"1770","name":"Purchase","budget":{"daily":50},"startDate":"2026-05-15 12:00:00","bidAmount":80,"conversion":{"eventType":"purchase"},"targeting":{"geoLocations":{"include":[{"type":"country","country":"US"}]}}}]}'
|
|
6121
|
+
# Highest Value
|
|
6122
|
+
adkit manage tiktok ad-groups create --campaign 1770 --name "Highest value" --budget-daily 50 --optimization value --event-type purchase
|
|
6123
|
+
# Minimum ROAS 1.5x
|
|
6124
|
+
adkit manage tiktok ad-groups create --data '{"adGroups":[{"campaignId":"1770","name":"Min ROAS 1.5x","budget":{"daily":50},"optimization":"value","targetRoas":1.5,"conversion":{"eventType":"purchase"}}]}'
|
|
6125
|
+
# Retune the ROAS target on an existing Value Optimization ad group
|
|
6126
|
+
adkit manage tiktok ad-groups update 1770000000000000000 --data '{"targetRoas":2}'`.trim(),
|
|
6114
6127
|
"tiktok ads": `adkit manage tiktok ads \u2014 TikTok video ads
|
|
6115
6128
|
|
|
6116
6129
|
list List ads
|
package/package.json
CHANGED