@thinkingai/ae-cli 6.0.31 → 6.0.33
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/README.md +3 -2
- package/README.zh.md +3 -2
- package/dist/{auth-MEJ642P4.js → auth-ENM3FE6L.js} +3 -2
- package/dist/{auth-7H3HAAJ3.js → auth-UPGUOKTW.js} +13 -6
- package/dist/{capability-SEH3JWLN.js → capability-AJC5CBRT.js} +50 -18
- package/dist/{capability-SQ2IWKP3.js → capability-TQ5KU5Q6.js} +50 -18
- package/dist/chunk-24BAVOX3.js +51 -0
- package/dist/{chunk-MDJGDI6K.js → chunk-3KI3RRXX.js} +5 -5
- package/dist/{chunk-PKRD2IEM.js → chunk-3P3562ZX.js} +9 -7
- package/dist/{chunk-R77JT7XD.js → chunk-4Q5TNP4Q.js} +4 -4
- package/dist/{chunk-TKQJQXWT.js → chunk-6CHYBI64.js} +7 -4
- package/dist/{chunk-6LEYLOV3.js → chunk-CPVTECJ3.js} +9 -7
- package/dist/{chunk-KCA6BA5D.js → chunk-DB4Q3ANU.js} +5 -3
- package/dist/{chunk-2NDGFQHW.js → chunk-E7UXXHO3.js} +11 -3
- package/dist/{chunk-I4A62X3N.js → chunk-HQ2A7ITL.js} +23 -14
- package/dist/chunk-IMMGMU54.js +674 -0
- package/dist/{chunk-AJTH7LT3.js → chunk-IR4ZLVPW.js} +4 -2
- package/dist/{chunk-N2QORU5D.js → chunk-ISY6HMHM.js} +7 -4
- package/dist/{chunk-KGJQCYVC.js → chunk-LCXU3AAT.js} +4 -2
- package/dist/chunk-LYVNONC4.js +86 -0
- package/dist/{chunk-DYOS6YY7.js → chunk-RGXCNC4N.js} +23 -14
- package/dist/{chunk-YCLVYFK7.js → chunk-V6FR6WTW.js} +45 -87
- package/dist/chunk-VTWMIC5L.js +27 -0
- package/dist/{cli-token-TVQRSE46.js → cli-token-4SBMXAUK.js} +6 -3
- package/dist/{client-2643Z5AG.js → client-PP5FETMW.js} +4 -3
- package/dist/community-report-client-KK2QBANO.js +145 -0
- package/dist/{config-7UZWDE74.js → config-RCCGHHYA.js} +6 -3
- package/dist/index.js +541 -234
- package/dist/{metadata-W6JFFMBA.js → metadata-3M5F2AED.js} +15 -14
- package/dist/{metadata-X62TKIVK.js → metadata-W2MEOI4Z.js} +15 -14
- package/dist/{model-T3KZJWLW.js → model-OYQLXCQY.js} +3 -2
- package/dist/{raw-CN542NGT.js → raw-TPB7KSZO.js} +6 -4
- package/dist/{sync-ERNHDPB5.js → sync-EFJKFZK2.js} +6 -3
- package/dist/{te-agent-FCCWUDTJ.js → te-agent-K2OWMZXT.js} +3 -2
- package/dist/{te-analysis-NJGNWZFC.js → te-analysis-I73ZS4NK.js} +2196 -120
- package/dist/{te-analysis-YGV5V5EX.js → te-analysis-Q7AZCDU4.js} +2196 -120
- package/dist/te-common-ST3QPSXJ.js +61 -0
- package/dist/te-common-WSLIKKPC.js +61 -0
- package/dist/te-community-WXGB6IOX.js +1659 -0
- package/dist/te-community-X2AHXGCA.js +1659 -0
- package/dist/{te-dataops-ZNJBQ6VT.js → te-dataops-MJV54MNY.js} +10 -8
- package/dist/{te-dataops-F36T656A.js → te-dataops-OA7I6HBG.js} +10 -8
- package/dist/te-engage-GJRVQMK3.js +3895 -0
- package/dist/te-engage-JIXX3WBI.js +3895 -0
- package/dist/{te-kb-NT33UHAE.js → te-kb-CIZXRWMO.js} +105 -23
- package/dist/{te-meta-VKWNAWO4.js → te-meta-Q4L6EE3Q.js} +8 -240
- package/dist/{te-meta-MAAUHFQO.js → te-meta-VHCN4Q62.js} +8 -240
- package/dist/{te-team-OKCOX7OE.js → te-team-PDKKW7Q5.js} +7 -6
- package/dist/tracking/i18n/resources/cli/en.json +4 -3
- package/dist/tracking/i18n/resources/cli/ja.json +4 -3
- package/dist/tracking/i18n/resources/cli/ko.json +4 -3
- package/dist/tracking/i18n/resources/cli/zh.json +4 -3
- package/package.json +6 -2
- package/skills/ae-agent/SKILL.md +2 -1
- package/skills/ae-analysis/SKILL.md +21 -7
- package/skills/ae-analysis/references/adhoc_export.md +5 -6
- package/skills/ae-analysis/references/adhoc_run.md +7 -9
- package/skills/ae-analysis/references/ai_models.md +17 -1
- package/skills/ae-analysis/references/alert_create.md +25 -0
- package/skills/ae-analysis/references/alert_definition_schema_get.md +24 -0
- package/skills/ae-analysis/references/alert_delete.md +26 -0
- package/skills/ae-analysis/references/alert_detail_list.md +27 -0
- package/skills/ae-analysis/references/alert_get.md +25 -0
- package/skills/ae-analysis/references/alert_job_list.md +24 -0
- package/skills/ae-analysis/references/alert_list.md +27 -0
- package/skills/ae-analysis/references/alert_notice_config_list.md +24 -0
- package/skills/ae-analysis/references/alert_start.md +25 -0
- package/skills/ae-analysis/references/alert_stop.md +25 -0
- package/skills/ae-analysis/references/alert_update.md +26 -0
- package/skills/ae-analysis/references/analysis_data_retrieval.md +11 -11
- package/skills/ae-analysis/references/analysis_drilldown_contract.md +93 -0
- package/skills/ae-analysis/references/analysis_gateway_assets.md +9 -8
- package/skills/ae-analysis/references/asset_url_get.md +4 -3
- package/skills/ae-analysis/references/bi_panel_create.md +3 -3
- package/skills/ae-analysis/references/bi_panel_page_data_export.md +2 -2
- package/skills/ae-analysis/references/bi_panel_page_data_run.md +1 -1
- package/skills/ae-analysis/references/check_delete.md +27 -0
- package/skills/ae-analysis/references/check_export.md +27 -0
- package/skills/ae-analysis/references/check_get.md +27 -0
- package/skills/ae-analysis/references/check_list.md +24 -0
- package/skills/ae-analysis/references/check_retry.md +27 -0
- package/skills/ae-analysis/references/check_run.md +25 -0
- package/skills/ae-analysis/references/command_index.md +114 -46
- package/skills/ae-analysis/references/create_entity.md +2 -2
- package/skills/ae-analysis/references/dashboard_create.md +3 -3
- package/skills/ae-analysis/references/dashboard_daily_report_send.md +1 -0
- package/skills/ae-analysis/references/dashboard_daily_report_update.md +2 -0
- package/skills/ae-analysis/references/dashboard_report_data_export.md +4 -4
- package/skills/ae-analysis/references/dashboard_report_data_run.md +4 -4
- package/skills/ae-analysis/references/drilldown_entities_export.md +26 -0
- package/skills/ae-analysis/references/drilldown_entities_run.md +33 -0
- package/skills/ae-analysis/references/drilldown_events_export.md +21 -0
- package/skills/ae-analysis/references/drilldown_events_run.md +23 -0
- package/skills/ae-analysis/references/drilldown_user_events_export.md +6 -3
- package/skills/ae-analysis/references/drilldown_user_events_run.md +6 -6
- package/skills/ae-analysis/references/entity_detail_export.md +2 -0
- package/skills/ae-analysis/references/entity_detail_run.md +8 -1
- package/skills/ae-analysis/references/event_blacklist_add.md +25 -0
- package/skills/ae-analysis/references/event_blacklist_list.md +24 -0
- package/skills/ae-analysis/references/event_blacklist_update.md +26 -0
- package/skills/ae-analysis/references/event_detail_export.md +2 -0
- package/skills/ae-analysis/references/event_detail_run.md +2 -0
- package/skills/ae-analysis/references/event_list.md +10 -2
- package/skills/ae-analysis/references/ingest_error_list.md +27 -0
- package/skills/ae-analysis/references/ingest_summary.md +26 -0
- package/skills/ae-analysis/references/list_entities.md +1 -1
- package/skills/ae-analysis/references/live_data_export.md +27 -0
- package/skills/ae-analysis/references/live_data_list.md +27 -0
- package/skills/ae-analysis/references/metric_create.md +13 -4
- package/skills/ae-analysis/references/metric_delete.md +7 -0
- package/skills/ae-analysis/references/metric_get.md +6 -0
- package/skills/ae-analysis/references/metric_list.md +16 -3
- package/skills/ae-analysis/references/metric_update.md +12 -1
- package/skills/ae-analysis/references/plan_change_log_export.md +27 -0
- package/skills/ae-analysis/references/plan_change_log_list.md +24 -0
- package/skills/ae-analysis/references/plan_delete_items.md +30 -0
- package/skills/ae-analysis/references/plan_export.md +26 -0
- package/skills/ae-analysis/references/plan_generate.md +27 -0
- package/skills/ae-analysis/references/plan_get.md +24 -0
- package/skills/ae-analysis/references/plan_import_excel.md +26 -0
- package/skills/ae-analysis/references/plan_save_items.md +27 -0
- package/skills/ae-analysis/references/plan_sync_from_meta.md +24 -0
- package/skills/ae-analysis/references/project_access_detail_get.md +23 -0
- package/skills/ae-analysis/references/project_data_power_delete.md +26 -0
- package/skills/ae-analysis/references/project_data_power_get.md +24 -0
- package/skills/ae-analysis/references/project_data_power_list.md +23 -0
- package/skills/ae-analysis/references/project_data_power_upsert.md +24 -0
- package/skills/ae-analysis/references/project_entity_create.md +27 -0
- package/skills/ae-analysis/references/project_entity_delete.md +25 -0
- package/skills/ae-analysis/references/project_entity_event_list.md +24 -0
- package/skills/ae-analysis/references/project_entity_get.md +24 -0
- package/skills/ae-analysis/references/project_entity_list.md +28 -0
- package/skills/ae-analysis/references/project_entity_update.md +28 -0
- package/skills/ae-analysis/references/project_function_list.md +24 -0
- package/skills/ae-analysis/references/project_info_get.md +23 -0
- package/skills/ae-analysis/references/project_info_list.md +26 -0
- package/skills/ae-analysis/references/project_info_update.md +25 -0
- package/skills/ae-analysis/references/project_mark_time_create.md +27 -0
- package/skills/ae-analysis/references/project_mark_time_delete.md +25 -0
- package/skills/ae-analysis/references/project_mark_time_list.md +28 -0
- package/skills/ae-analysis/references/project_mark_time_update.md +28 -0
- package/skills/ae-analysis/references/project_member_add.md +25 -0
- package/skills/ae-analysis/references/project_member_batch_update.md +24 -0
- package/skills/ae-analysis/references/project_member_candidate_list.md +25 -0
- package/skills/ae-analysis/references/project_member_handover_export.md +27 -0
- package/skills/ae-analysis/references/project_member_handover_run.md +24 -0
- package/skills/ae-analysis/references/project_member_import.md +25 -0
- package/skills/ae-analysis/references/project_member_list.md +23 -0
- package/skills/ae-analysis/references/project_member_receiver_list.md +23 -0
- package/skills/ae-analysis/references/project_member_remove.md +26 -0
- package/skills/ae-analysis/references/project_member_update.md +25 -0
- package/skills/ae-analysis/references/project_owner_update.md +27 -0
- package/skills/ae-analysis/references/project_permission_binding_list.md +24 -0
- package/skills/ae-analysis/references/project_receive_status_update.md +25 -0
- package/skills/ae-analysis/references/project_role_delete.md +26 -0
- package/skills/ae-analysis/references/project_role_function_list.md +27 -0
- package/skills/ae-analysis/references/project_role_get.md +24 -0
- package/skills/ae-analysis/references/project_role_list.md +25 -0
- package/skills/ae-analysis/references/project_role_upsert.md +24 -0
- package/skills/ae-analysis/references/project_role_user_list.md +24 -0
- package/skills/ae-analysis/references/project_timezone_get.md +23 -0
- package/skills/ae-analysis/references/project_timezone_overview.md +23 -0
- package/skills/ae-analysis/references/project_timezone_update.md +25 -0
- package/skills/ae-analysis/references/project_user_id_items_update.md +24 -0
- package/skills/ae-analysis/references/property_list.md +21 -6
- package/skills/ae-analysis/references/public_link_create.md +1 -1
- package/skills/ae-analysis/references/query_create_result_cluster.md +15 -32
- package/skills/ae-analysis/references/report_create.md +1 -1
- package/skills/ae-analysis/references/report_data_export.md +5 -3
- package/skills/ae-analysis/references/report_data_run.md +13 -3
- package/skills/ae-analysis/references/report_get.md +2 -0
- package/skills/ae-analysis/references/report_update.md +1 -1
- package/skills/ae-analysis/references/sdk_sample_generate.md +24 -0
- package/skills/ae-analysis/references/user_cluster_create.md +5 -1
- package/skills/ae-analysis/references/user_cluster_create_id.md +2 -0
- package/skills/ae-analysis/references/user_cluster_get.md +4 -0
- package/skills/ae-analysis/references/user_cluster_refresh.md +4 -2
- package/skills/ae-analysis/references/user_cluster_update.md +5 -1
- package/skills/ae-analysis/references/user_cluster_update_id.md +2 -0
- package/skills/ae-analysis/references/user_tag_create.md +5 -1
- package/skills/ae-analysis/references/user_tag_create_id.md +2 -0
- package/skills/ae-analysis/references/user_tag_get.md +4 -0
- package/skills/ae-analysis/references/user_tag_refresh.md +4 -2
- package/skills/ae-analysis/references/user_tag_update.md +5 -1
- package/skills/ae-analysis/references/user_tag_update_id.md +2 -0
- package/skills/ae-analysis/references/virtual_event_create.md +22 -3
- package/skills/ae-analysis/references/virtual_property_create.md +23 -2
- package/skills/ae-analysis-global/SKILL.md +2 -0
- package/skills/ae-capability/SKILL.md +7 -5
- package/skills/ae-community/SKILL.md +72 -8
- package/skills/ae-community/references/community-chat-analysis.md +341 -0
- package/skills/ae-community/references/community-data-report.md +301 -0
- package/skills/ae-dataops/SKILL.md +2 -1
- package/skills/ae-engage/SKILL.md +204 -8
- package/skills/ae-engage/references/activity-activity-type.md +42 -0
- package/skills/ae-engage/references/activity-activity.md +70 -0
- package/skills/ae-engage/references/activity-approval.md +53 -0
- package/skills/ae-engage/references/activity-task.md +87 -0
- package/skills/ae-engage/references/activity-topic.md +98 -0
- package/skills/ae-engage/references/approval-approver-delete.md +26 -0
- package/skills/ae-engage/references/channel-test-send.md +37 -0
- package/skills/ae-engage/references/channel-touch-limits-batch-update.md +28 -0
- package/skills/ae-engage/references/channel-touch-limits-save.md +37 -0
- package/skills/ae-engage/references/channel-touch-limits-toggle.md +28 -0
- package/skills/ae-engage/references/channel-update-config.md +36 -0
- package/skills/ae-engage/references/client-param.md +58 -0
- package/skills/ae-engage/references/common-metric.md +75 -0
- package/skills/ae-engage/references/config-table.md +92 -0
- package/skills/ae-engage/references/engage-scene-config-item.md +69 -0
- package/skills/ae-engage/references/operation-log-query.md +1 -1
- package/skills/ae-engage/references/preset-event.md +42 -0
- package/skills/ae-engage/references/push-language.md +39 -0
- package/skills/ae-engage/references/scene-config-channel.md +58 -0
- package/skills/ae-engage/references/scene-config-group.md +62 -0
- package/skills/ae-engage/references/scene-config-item.md +68 -0
- package/skills/ae-engage/references/scene-config-metric.md +79 -0
- package/skills/ae-engage/references/scene-config-param.md +72 -0
- package/skills/ae-engage/references/scene-preset-metric.md +45 -0
- package/skills/ae-engage/references/scene-strategy.md +47 -0
- package/skills/ae-engage/references/scene-template.md +71 -0
- package/skills/ae-engage/references/{ops-delete.md → task-delete.md} +3 -3
- package/skills/ae-engage/references/whitelist.md +72 -0
- package/skills/ae-engage/references/workbench-workbench.md +48 -0
- package/skills/ae-generate-tracking-code/SKILL.md +4 -4
- package/skills/ae-generate-tracking-plan/SKILL.md +140 -16
- package/skills/ae-generate-tracking-plan/references/business-dimension-mapping.md +98 -33
- package/skills/ae-generate-tracking-plan/references/te-api.md +1 -1
- package/skills/ae-generate-tracking-plan/references/xlsx-schema.md +16 -14
- package/skills/ae-kb/SKILL.md +36 -9
- package/skills/ae-metadata/SKILL.md +3 -2
- package/skills/ae-metadata/references/metadata_event_get.md +4 -4
- package/skills/ae-metadata/references/metadata_property_dimension_table_bind_existing.md +1 -1
- package/skills/ae-metadata/references/metadata_property_get.md +4 -4
- package/skills/ae-team/SKILL.md +2 -1
- package/dist/chunk-NOO24N7W.js +0 -11
- package/dist/chunk-TNW2CI4W.js +0 -129
- package/dist/te-common-5NJLF3XG.js +0 -130
- package/dist/te-common-7VTJZPII.js +0 -130
- package/dist/te-community-PEZ2VEF7.js +0 -687
- package/dist/te-community-TSKJ652U.js +0 -687
- package/dist/te-engage-BUWVSSSK.js +0 -1912
- package/dist/te-engage-EPE3QKDE.js +0 -1912
- package/skills/ae-analysis/references/create_metric.md +0 -58
- package/skills/ae-analysis/references/create_virtual_event.md +0 -60
- package/skills/ae-analysis/references/create_virtual_property.md +0 -69
- package/skills/ae-analysis/references/delete_metric.md +0 -32
- package/skills/ae-analysis/references/drilldown_users_export.md +0 -17
- package/skills/ae-analysis/references/drilldown_users_run.md +0 -61
- package/skills/ae-analysis/references/get_metric.md +0 -38
- package/skills/ae-analysis/references/get_resource_url.md +0 -33
- package/skills/ae-analysis/references/list_events.md +0 -46
- package/skills/ae-analysis/references/list_metrics.md +0 -52
- package/skills/ae-analysis/references/list_properties.md +0 -47
- package/skills/ae-analysis/references/update_metric.md +0 -58
- package/dist/{chunk-HL2AJQ4Q.js → chunk-PTE56QPL.js} +3 -3
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# engage-setting config-table
|
|
2
|
+
|
|
3
|
+
> Capability ids: `engage-setting.config-table.{upload,save,list,query-data,update-data,delete}` · Domain: `engage`.
|
|
4
|
+
|
|
5
|
+
## Commands
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# 1. Upload and parse a config table file (base64 content) → caches rows under request-id
|
|
9
|
+
ae-cli engage-setting config-table upload \
|
|
10
|
+
--project-id <project_id> --request-id <request_id> --file-name data.csv \
|
|
11
|
+
--file-content "$(base64 -i data.csv)"
|
|
12
|
+
|
|
13
|
+
# 2. Persist the parsed rows as a new config table
|
|
14
|
+
ae-cli engage-setting config-table save \
|
|
15
|
+
--project-id <project_id> --request-id <request_id> --info-name <table_name>
|
|
16
|
+
|
|
17
|
+
# List config tables
|
|
18
|
+
ae-cli engage-setting config-table list --project-id <project_id>
|
|
19
|
+
|
|
20
|
+
# Query rows of a config table
|
|
21
|
+
ae-cli engage-setting config-table query-data --project-id <project_id> --info-id <info_id>
|
|
22
|
+
|
|
23
|
+
# Replace an existing config table's data with a freshly uploaded file
|
|
24
|
+
ae-cli engage-setting config-table update-data \
|
|
25
|
+
--project-id <project_id> --request-id <request_id> --info-name <table_name> --info-id <info_id>
|
|
26
|
+
|
|
27
|
+
# Delete a config table and its data (high-risk)
|
|
28
|
+
ae-cli engage-setting config-table delete --project-id <project_id> --info-id <info_id> --yes
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Parameters
|
|
32
|
+
|
|
33
|
+
### upload
|
|
34
|
+
|
|
35
|
+
| Parameter | Required | Description |
|
|
36
|
+
|---|---|---|
|
|
37
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
38
|
+
| `--request-id` | Yes | Client-supplied request id used to cache parsed rows for the subsequent save/update-data. |
|
|
39
|
+
| `--file-name` | Yes | Original file name including extension (.csv/.xlsx). |
|
|
40
|
+
| `--file-content` | Yes | Base64-encoded file content. |
|
|
41
|
+
|
|
42
|
+
### save
|
|
43
|
+
|
|
44
|
+
| Parameter | Required | Description |
|
|
45
|
+
|---|---|---|
|
|
46
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
47
|
+
| `--request-id` | Yes | Request id returned by a prior upload. |
|
|
48
|
+
| `--info-name` | Yes | Config table name. |
|
|
49
|
+
|
|
50
|
+
### list
|
|
51
|
+
|
|
52
|
+
| Parameter | Required | Description |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
55
|
+
|
|
56
|
+
### query-data
|
|
57
|
+
|
|
58
|
+
| Parameter | Required | Description |
|
|
59
|
+
|---|---|---|
|
|
60
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
61
|
+
| `--info-id` | Yes | Config table ID. |
|
|
62
|
+
|
|
63
|
+
### update-data
|
|
64
|
+
|
|
65
|
+
| Parameter | Required | Description |
|
|
66
|
+
|---|---|---|
|
|
67
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
68
|
+
| `--request-id` | Yes | Request id returned by a prior upload. |
|
|
69
|
+
| `--info-name` | Yes | Config table name. |
|
|
70
|
+
| `--info-id` | Yes | Config table ID to update. |
|
|
71
|
+
|
|
72
|
+
### delete
|
|
73
|
+
|
|
74
|
+
| Parameter | Required | Description |
|
|
75
|
+
|---|---|---|
|
|
76
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
77
|
+
| `--info-id` | Yes | Config table ID to delete. |
|
|
78
|
+
|
|
79
|
+
## Output
|
|
80
|
+
|
|
81
|
+
- `upload`: `data.file_name`, `data.data_num` (parsed row count), `data.data_list` (preview of up to 10 rows, each with `data_key`, `data_value`).
|
|
82
|
+
- `save`: `data.info_id` — created config table ID.
|
|
83
|
+
- `list`: `data.items` (each with `id`, `project_id`, `info_id`, `info_name`, `creator_open_id`, `login_name`, `create_time`, `update_time`) and `data.total`.
|
|
84
|
+
- `query-data`: `data.items` (each with `project_id`, `info_id`, `data_key`, `data_value`) and `data.total`.
|
|
85
|
+
- `update-data` / `delete`: `data.success`.
|
|
86
|
+
|
|
87
|
+
## Decision Rules
|
|
88
|
+
|
|
89
|
+
- Creating or replacing a config table is a two-step flow: `upload` (parse + cache by `request-id`) then `save` (new table) or `update-data` (replace existing). Always use a fresh `--request-id` per upload.
|
|
90
|
+
- The upload cache is keyed by `project-id` + `request-id`, expires after 10 minutes, and is consumed after a successful `save` or `update-data`.
|
|
91
|
+
- Discover existing `info_id` values with `config-table list` first; never invent them.
|
|
92
|
+
- `delete` is `high-risk-write` and requires `--yes` (or interactive confirmation).
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# engage-scene config-item
|
|
2
|
+
|
|
3
|
+
> Capability ids: `engage-scene.config-item.{list,create,update}` · Domain: `engage`.
|
|
4
|
+
|
|
5
|
+
`config-item` 是配置中心(场景管理)里的配置项。create 走 multipart,可携带可选头像文件。
|
|
6
|
+
|
|
7
|
+
## Commands
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# List config items of a project
|
|
11
|
+
ae-cli engage-scene config-item list --project-id <project_id>
|
|
12
|
+
|
|
13
|
+
# Create a config item (business type, group, optional avatar)
|
|
14
|
+
ae-cli engage-scene config-item create \
|
|
15
|
+
--project-id <project_id> --config-id <config_id> --config-name <name> \
|
|
16
|
+
--business-type <config_file|params> \
|
|
17
|
+
[--config-remark <remark>] [--group-id <group_id>] \
|
|
18
|
+
[--avatar-word '["A","B"]'] [--file-name avatar.png] [--file-content "$(base64 -i avatar.png)"]
|
|
19
|
+
|
|
20
|
+
# Update a config item's basic info and bound channel
|
|
21
|
+
ae-cli engage-scene config-item update \
|
|
22
|
+
--project-id <project_id> --config-id <config_id> \
|
|
23
|
+
[--config-name <name>] [--config-remark <remark>] [--business-type <type>] \
|
|
24
|
+
[--group-id <group_id>] [--channel-id <channel_id>]
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Parameters
|
|
28
|
+
|
|
29
|
+
### list
|
|
30
|
+
|
|
31
|
+
| Parameter | Required | Description |
|
|
32
|
+
|---|---|---|
|
|
33
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
34
|
+
|
|
35
|
+
### create
|
|
36
|
+
|
|
37
|
+
| Parameter | Required | Description |
|
|
38
|
+
|---|---|---|
|
|
39
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
40
|
+
| `--config-id` | Yes | Config item ID (unique within the project). |
|
|
41
|
+
| `--config-name` | Yes | Config item display name (<=80 chars). |
|
|
42
|
+
| `--business-type` | Yes | Business type: `config_file` or `params`. |
|
|
43
|
+
| `--config-remark` | No | Remark (<=200 chars). |
|
|
44
|
+
| `--group-id` | No | Group ID (0 = default group). |
|
|
45
|
+
| `--avatar-word` | No | JSON array of avatar words for the icon. |
|
|
46
|
+
| `--file-name` | No | Avatar file name incl. extension. |
|
|
47
|
+
| `--file-content` | No | Base64-encoded avatar file content. |
|
|
48
|
+
|
|
49
|
+
### update
|
|
50
|
+
|
|
51
|
+
| Parameter | Required | Description |
|
|
52
|
+
|---|---|---|
|
|
53
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
54
|
+
| `--config-id` | Yes | Config item ID to update. |
|
|
55
|
+
| `--config-name` | No | New display name. |
|
|
56
|
+
| `--config-remark` | No | New remark. |
|
|
57
|
+
| `--business-type` | No | New business type. |
|
|
58
|
+
| `--group-id` | No | New group ID. |
|
|
59
|
+
| `--channel-id` | No | Config channel ID to bind. |
|
|
60
|
+
|
|
61
|
+
## Output
|
|
62
|
+
|
|
63
|
+
- `list`: `data.items` + `data.total`.
|
|
64
|
+
- `create` / `update`: `data.success` — whether the operation succeeded.
|
|
65
|
+
|
|
66
|
+
## Decision Rules
|
|
67
|
+
|
|
68
|
+
- `create` / `update` are `write`; `list` is read.
|
|
69
|
+
- Use `config-item list` (or `engage +config_item_list`) to discover existing config items first; never invent IDs.
|
|
@@ -5,7 +5,7 @@ Use this command to query aggregated operation records and application logs for
|
|
|
5
5
|
> Capability id: `engage-flow.operation-log.query` · Domain: `engage`.
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
ae-cli engage-flow operation-log query --project-id <project-id> --flow-
|
|
8
|
+
ae-cli engage-flow operation-log query --project-id <project-id> --flow-id <flow-id>
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
The result contains `operation_record_list` and `app_log_list`, grouped by flow version.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# engage-setting preset-event
|
|
2
|
+
|
|
3
|
+
> Capability ids: `engage-setting.preset-event.{list,update}` · Domain: `engage`.
|
|
4
|
+
|
|
5
|
+
## Commands
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# Query the project preset-event config
|
|
9
|
+
ae-cli engage-setting preset-event list --project-id <project_id>
|
|
10
|
+
|
|
11
|
+
# Update the project preset-event config
|
|
12
|
+
ae-cli engage-setting preset-event update --project-id <project_id> [--add-event-desc <qp>] [--active-event-desc <qp>] [--recharge-event-desc <qp>]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
### list
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
22
|
+
|
|
23
|
+
### update
|
|
24
|
+
|
|
25
|
+
| Parameter | Required | Description |
|
|
26
|
+
|---|---|---|
|
|
27
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
28
|
+
| `--add-event-desc` | No | Add-event qp definition. |
|
|
29
|
+
| `--active-event-desc` | No | Active-event qp definition. |
|
|
30
|
+
| `--recharge-event-desc` | No | Recharge-success-event qp definition. |
|
|
31
|
+
|
|
32
|
+
At least one `*-event-desc` must be provided for `update`.
|
|
33
|
+
|
|
34
|
+
## Output
|
|
35
|
+
|
|
36
|
+
- `list`: `data.add_event_desc`, `data.active_event_desc`, `data.recharge_event_desc` (each may be `null`).
|
|
37
|
+
- `update`: `data.success` — whether the config was updated.
|
|
38
|
+
|
|
39
|
+
## Decision Rules
|
|
40
|
+
|
|
41
|
+
- Use these commands when the user asks to query or configure preset events (预置事件) for the analysis workbench.
|
|
42
|
+
- `update` replaces the provided desc fields; omitting a field clears it. Before clearing a field that is in use, the backend rejects the update if metrics still depend on it.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# engage-setting push-language
|
|
2
|
+
|
|
3
|
+
> Capability ids: `engage-setting.push-language.{get,set}` · Domain: `engage`.
|
|
4
|
+
|
|
5
|
+
## Commands
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# Query the project push-language property field
|
|
9
|
+
ae-cli engage-setting push-language get --project-id <project_id>
|
|
10
|
+
|
|
11
|
+
# Set the project push-language property field
|
|
12
|
+
ae-cli engage-setting push-language set --project-id <project_id> --push-language-column <prop_code>
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
### get
|
|
18
|
+
|
|
19
|
+
| Parameter | Required | Description |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
22
|
+
|
|
23
|
+
### set
|
|
24
|
+
|
|
25
|
+
| Parameter | Required | Description |
|
|
26
|
+
|---|---|---|
|
|
27
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
28
|
+
| `--push-language-column` | Yes | User property code used as the push language field. |
|
|
29
|
+
|
|
30
|
+
## Output
|
|
31
|
+
|
|
32
|
+
- `get`: `data.push_language_column` — configured push-language property code, or `null` if unset.
|
|
33
|
+
- `set`: `data.success` — whether the field was updated.
|
|
34
|
+
|
|
35
|
+
## Decision Rules
|
|
36
|
+
|
|
37
|
+
- Use these commands when the user asks to query or configure the project push-language (本地化) property field.
|
|
38
|
+
- `--push-language-column` must be a real user property code; discover available properties via the analysis metadata commands first.
|
|
39
|
+
- `set` is `write`; ordinary update, no confirmation gate.
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# engage-scene config-channel
|
|
2
|
+
|
|
3
|
+
> Capability ids: `engage-scene.config-channel.{create,update,query-log}` · Domain: `engage`.
|
|
4
|
+
|
|
5
|
+
场景管理 / 配置中心 - 配置通道管理与操作日志。
|
|
6
|
+
|
|
7
|
+
## Commands
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Create a config channel and enable it
|
|
11
|
+
ae-cli engage-scene config-channel create \
|
|
12
|
+
--project-id <project_id> --channel-name <name> --channel-type <0|1> --config '<json string>'
|
|
13
|
+
|
|
14
|
+
# Update a config channel's name and optionally its config
|
|
15
|
+
ae-cli engage-scene config-channel update \
|
|
16
|
+
--project-id <project_id> --channel-id <channel_id> --channel-name <name> [--config '<json string>']
|
|
17
|
+
|
|
18
|
+
# Query a config channel's operation log
|
|
19
|
+
ae-cli engage-scene config-channel query-log --project-id <project_id> --channel-id <channel_id>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Parameters
|
|
23
|
+
|
|
24
|
+
### create
|
|
25
|
+
|
|
26
|
+
| Parameter | Required | Description |
|
|
27
|
+
|---|---|---|
|
|
28
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
29
|
+
| `--channel-name` | Yes | Channel name. |
|
|
30
|
+
| `--channel-type` | Yes | Channel type: **0 webhook**, **1 client** (not the same as engage push `channelType`, where 1=webhook). |
|
|
31
|
+
| `--config` | Yes | Channel-specific JSON config string. Webhook (`0`) requires `config.url`; client (`1`) must not include `url`. |
|
|
32
|
+
|
|
33
|
+
### update
|
|
34
|
+
|
|
35
|
+
| Parameter | Required | Description |
|
|
36
|
+
|---|---|---|
|
|
37
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
38
|
+
| `--channel-id` | Yes | Channel ID to update. |
|
|
39
|
+
| `--channel-name` | Yes | New channel name. |
|
|
40
|
+
| `--config` | No | Channel-specific JSON config string. Omit to keep the current config (typical when renaming an enabled channel). Required when changing webhook URL, auth, or parameter definitions on a disabled channel. |
|
|
41
|
+
|
|
42
|
+
### query-log
|
|
43
|
+
|
|
44
|
+
| Parameter | Required | Description |
|
|
45
|
+
|---|---|---|
|
|
46
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
47
|
+
| `--channel-id` | Yes | Channel ID whose operation log to query. |
|
|
48
|
+
|
|
49
|
+
## Output
|
|
50
|
+
|
|
51
|
+
- `create`: `data.channel_id` — the created channel ID.
|
|
52
|
+
- `update`: `data.success`.
|
|
53
|
+
- `query-log`: `data.items` + `data.total`.
|
|
54
|
+
|
|
55
|
+
## Decision Rules
|
|
56
|
+
|
|
57
|
+
- `create`/`update` are `write`; `query-log` is read.
|
|
58
|
+
- Discover real `channel_id`s with `ae-cli engage +config_channel_list --project_id <project_id>` first.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# engage-scene config-group
|
|
2
|
+
|
|
3
|
+
> Capability ids: `engage-scene.config-group.{list,batch-add,update,batch-delete}` · Domain: `engage`.
|
|
4
|
+
|
|
5
|
+
场景管理 / 配置中心 - 配置项分组管理。
|
|
6
|
+
|
|
7
|
+
## Commands
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# List config groups of a project
|
|
11
|
+
ae-cli engage-scene config-group list --project-id <project_id>
|
|
12
|
+
|
|
13
|
+
# Batch-create config groups
|
|
14
|
+
ae-cli engage-scene config-group batch-add --project-id <project_id> --group-names '["g1","g2"]'
|
|
15
|
+
|
|
16
|
+
# Rename a config group
|
|
17
|
+
ae-cli engage-scene config-group update --project-id <project_id> --group-id <group_id> --group-name <name>
|
|
18
|
+
|
|
19
|
+
# Batch-delete config groups (high-risk)
|
|
20
|
+
ae-cli engage-scene config-group batch-delete --project-id <project_id> --group-ids '[1,2]' --yes
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Parameters
|
|
24
|
+
|
|
25
|
+
### list
|
|
26
|
+
|
|
27
|
+
| Parameter | Required | Description |
|
|
28
|
+
|---|---|---|
|
|
29
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
30
|
+
|
|
31
|
+
### batch-add
|
|
32
|
+
|
|
33
|
+
| Parameter | Required | Description |
|
|
34
|
+
|---|---|---|
|
|
35
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
36
|
+
| `--group-names` | Yes | JSON array of group names (<=80 chars each). |
|
|
37
|
+
|
|
38
|
+
### update
|
|
39
|
+
|
|
40
|
+
| Parameter | Required | Description |
|
|
41
|
+
|---|---|---|
|
|
42
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
43
|
+
| `--group-id` | Yes | Group ID to update. |
|
|
44
|
+
| `--group-name` | Yes | New group name (<=80 chars). |
|
|
45
|
+
|
|
46
|
+
### batch-delete
|
|
47
|
+
|
|
48
|
+
| Parameter | Required | Description |
|
|
49
|
+
|---|---|---|
|
|
50
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
51
|
+
| `--group-ids` | Yes | JSON array of group IDs. |
|
|
52
|
+
|
|
53
|
+
## Output
|
|
54
|
+
|
|
55
|
+
- `list`: `data.items` + `data.total`.
|
|
56
|
+
- `batch-add` / `batch-delete`: `data.success_num` + `data.fail_list` (looped single calls; non-atomic).
|
|
57
|
+
- `update`: `data.success`.
|
|
58
|
+
|
|
59
|
+
## Decision Rules
|
|
60
|
+
|
|
61
|
+
- Discover real `group_id`s with `list` before update/delete; never invent IDs.
|
|
62
|
+
- `batch-delete` is `high-risk-write` and requires `--yes`.
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# engage-scene config-item
|
|
2
|
+
|
|
3
|
+
> Capability ids: `engage-scene.config-item.{list,create,update}` · Domain: `engage`.
|
|
4
|
+
|
|
5
|
+
场景管理 / 配置中心 - 配置项管理。
|
|
6
|
+
|
|
7
|
+
## Commands
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# List config items of a project
|
|
11
|
+
ae-cli engage-scene config-item list --project-id <project_id>
|
|
12
|
+
|
|
13
|
+
# Create a config item (business type, group, optional avatar)
|
|
14
|
+
ae-cli engage-scene config-item create \
|
|
15
|
+
--project-id <project_id> --config-id <config_id> --config-name <name> \
|
|
16
|
+
--business-type <config_file|params> \
|
|
17
|
+
[--config-remark <remark>] [--group-id <group_id>] \
|
|
18
|
+
[--avatar-word '["A"]'] [--file-name icon.png] [--file-content "$(base64 -i icon.png)"]
|
|
19
|
+
|
|
20
|
+
# Update a config item's basic info and bound channel
|
|
21
|
+
ae-cli engage-scene config-item update \
|
|
22
|
+
--project-id <project_id> --config-id <config_id> \
|
|
23
|
+
[--config-name <name>] [--config-remark <remark>] [--business-type <type>] \
|
|
24
|
+
[--group-id <group_id>] [--channel-id <channel_id>]
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Parameters
|
|
28
|
+
|
|
29
|
+
### list
|
|
30
|
+
|
|
31
|
+
| Parameter | Required | Description |
|
|
32
|
+
|---|---|---|
|
|
33
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
34
|
+
|
|
35
|
+
### create
|
|
36
|
+
|
|
37
|
+
| Parameter | Required | Description |
|
|
38
|
+
|---|---|---|
|
|
39
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
40
|
+
| `--config-id` | Yes | Config item ID (unique within the project). |
|
|
41
|
+
| `--config-name` | Yes | Config item display name (<=80 chars). |
|
|
42
|
+
| `--business-type` | Yes | Business type: `config_file` or `params`. |
|
|
43
|
+
| `--config-remark` | No | Remark (<=200 chars). |
|
|
44
|
+
| `--group-id` | No | Group ID (0 = default group). |
|
|
45
|
+
| `--avatar-word` | No | JSON array of avatar words for the icon. |
|
|
46
|
+
| `--file-name` | No | Avatar file name including extension. |
|
|
47
|
+
| `--file-content` | No | Base64-encoded avatar file content. |
|
|
48
|
+
|
|
49
|
+
### update
|
|
50
|
+
|
|
51
|
+
| Parameter | Required | Description |
|
|
52
|
+
|---|---|---|
|
|
53
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
54
|
+
| `--config-id` | Yes | Config item ID to update. |
|
|
55
|
+
| `--config-name` | No | New display name. |
|
|
56
|
+
| `--config-remark` | No | New remark. |
|
|
57
|
+
| `--business-type` | No | New business type. |
|
|
58
|
+
| `--group-id` | No | New group ID. |
|
|
59
|
+
| `--channel-id` | No | Config channel ID to bind. |
|
|
60
|
+
|
|
61
|
+
## Output
|
|
62
|
+
|
|
63
|
+
- `list`: `data.items` + `data.total`.
|
|
64
|
+
- `create` / `update`: `data.success` — whether the operation succeeded.
|
|
65
|
+
|
|
66
|
+
## Decision Rules
|
|
67
|
+
|
|
68
|
+
- `create` / `update` are `write`; `list` is read. Use `config-item list` (or `engage +config_item_list`) to discover real `config_id`s and group IDs; never invent IDs.
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# engage-scene config-metric
|
|
2
|
+
|
|
3
|
+
> Capability ids: `engage-scene.config-metric.{list,get,batch-add,update-rule,batch-delete}` · Domain: `engage`.
|
|
4
|
+
|
|
5
|
+
场景管理 / 配置中心 - 配置项关联指标管理。
|
|
6
|
+
|
|
7
|
+
## Commands
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# List related metrics of a config item (optionally include preset metrics)
|
|
11
|
+
ae-cli engage-scene config-metric list --project-id <project_id> --config-id <config_id> [--all-metric]
|
|
12
|
+
|
|
13
|
+
# Get a related metric's detail
|
|
14
|
+
ae-cli engage-scene config-metric get --project-id <project_id> --metric-id <metric_id>
|
|
15
|
+
|
|
16
|
+
# Batch-relate TA (event-analysis) metrics to a config item
|
|
17
|
+
ae-cli engage-scene config-metric batch-add --project-id <project_id> --config-id <config_id> --ta-metric-ids '[1,2]'
|
|
18
|
+
|
|
19
|
+
# Update a config metric's event relation rule
|
|
20
|
+
ae-cli engage-scene config-metric update-rule \
|
|
21
|
+
--project-id <project_id> --metric-id <metric_id> \
|
|
22
|
+
--event-list '[{"event_name":"e1","filter":"true"}]'
|
|
23
|
+
|
|
24
|
+
# Batch-remove related metrics (high-risk)
|
|
25
|
+
ae-cli engage-scene config-metric batch-delete --project-id <project_id> --config-id <config_id> --metric-ids '[1,2]' --yes
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Parameters
|
|
29
|
+
|
|
30
|
+
### list
|
|
31
|
+
|
|
32
|
+
| Parameter | Required | Description |
|
|
33
|
+
|---|---|---|
|
|
34
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
35
|
+
| `--config-id` | Yes | Config item ID. |
|
|
36
|
+
| `--all-metric` | No | Include preset metrics as well. |
|
|
37
|
+
|
|
38
|
+
### get
|
|
39
|
+
|
|
40
|
+
| Parameter | Required | Description |
|
|
41
|
+
|---|---|---|
|
|
42
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
43
|
+
| `--metric-id` | Yes | Config metric primary ID. |
|
|
44
|
+
|
|
45
|
+
### batch-add
|
|
46
|
+
|
|
47
|
+
| Parameter | Required | Description |
|
|
48
|
+
|---|---|---|
|
|
49
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
50
|
+
| `--config-id` | Yes | Config item ID. |
|
|
51
|
+
| `--ta-metric-ids` | Yes | JSON array of TA metric IDs. |
|
|
52
|
+
|
|
53
|
+
### update-rule
|
|
54
|
+
|
|
55
|
+
| Parameter | Required | Description |
|
|
56
|
+
|---|---|---|
|
|
57
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
58
|
+
| `--metric-id` | Yes | Config metric primary ID. |
|
|
59
|
+
| `--event-list` | Yes | JSON array of event rules (`event_name` or `eventName`, plus `filter`). |
|
|
60
|
+
|
|
61
|
+
### batch-delete
|
|
62
|
+
|
|
63
|
+
| Parameter | Required | Description |
|
|
64
|
+
|---|---|---|
|
|
65
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
66
|
+
| `--config-id` | Yes | Config item ID. |
|
|
67
|
+
| `--metric-ids` | Yes | JSON array of config metric primary IDs. |
|
|
68
|
+
|
|
69
|
+
## Output
|
|
70
|
+
|
|
71
|
+
- `list`: `data.items` + `data.total`.
|
|
72
|
+
- `get`: `data` — metric detail.
|
|
73
|
+
- `batch-add` / `update-rule`: `data.success`.
|
|
74
|
+
- `batch-delete`: `data.success`.
|
|
75
|
+
|
|
76
|
+
## Decision Rules
|
|
77
|
+
|
|
78
|
+
- Discover real metric IDs via `list`/`get`; never invent IDs.
|
|
79
|
+
- `batch-delete` is `high-risk-write` and requires `--yes`.
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# engage-scene config-param
|
|
2
|
+
|
|
3
|
+
> Capability ids: `engage-scene.config-param.{list,batch-add,update,batch-delete}` · Domain: `engage`.
|
|
4
|
+
|
|
5
|
+
场景管理 / 配置中心 - 配置项参数管理。
|
|
6
|
+
|
|
7
|
+
## Commands
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# List params of a config item
|
|
11
|
+
ae-cli engage-scene config-param list --project-id <project_id> --config-id <config_id>
|
|
12
|
+
|
|
13
|
+
# Batch-add params to a config item
|
|
14
|
+
ae-cli engage-scene config-param batch-add \
|
|
15
|
+
--project-id <project_id> --config-id <config_id> \
|
|
16
|
+
--params '[{"param_name":"title","param_display_name":"标题","param_type":"STRING","param_sub_type":"SHORT_TEXT","is_required":1}]'
|
|
17
|
+
|
|
18
|
+
# Update a param
|
|
19
|
+
ae-cli engage-scene config-param update \
|
|
20
|
+
--project-id <project_id> --config-id <config_id> --param-id <param_id> \
|
|
21
|
+
[--param-name <name>] [--param-display-name <name>] [--param-type <type>] \
|
|
22
|
+
[--param-sub-type <sub>] [--table-id <table_id>] [--param-placeholder <ph>] \
|
|
23
|
+
[--is-required 1] [--default-value <value>]
|
|
24
|
+
|
|
25
|
+
# Batch-delete params (high-risk)
|
|
26
|
+
ae-cli engage-scene config-param batch-delete --project-id <project_id> --param-ids '[1,2]' --yes
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Parameters
|
|
30
|
+
|
|
31
|
+
### list
|
|
32
|
+
|
|
33
|
+
| Parameter | Required | Description |
|
|
34
|
+
|---|---|---|
|
|
35
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
36
|
+
| `--config-id` | Yes | Config item ID. |
|
|
37
|
+
|
|
38
|
+
### batch-add
|
|
39
|
+
|
|
40
|
+
| Parameter | Required | Description |
|
|
41
|
+
|---|---|---|
|
|
42
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
43
|
+
| `--config-id` | Yes | Config item ID. |
|
|
44
|
+
| `--params` | Yes | JSON array of params (`param_name`, `param_display_name`, `param_type`, `param_sub_type`, `table_id`, `param_placeholder`, `is_required`, `default_value`). `param_type` must be uppercase enum: `STRING`, `NUM`, `DATE`, `DATE_TIME`, `BOOLEAN`, `OBJ`, `SINGLE_SELECT`, `ARRAY`, `JSON`. For `STRING`/`ARRAY`, `param_sub_type` is required (e.g. `SHORT_TEXT`, `LONG_TEXT`, `NUM`). For `SINGLE_SELECT`, `table_id` is required. **`param_display_name` must be unique within the config item** — duplicate display names return `INVALID_CAPABILITY_REQUEST`. |
|
|
45
|
+
|
|
46
|
+
### update
|
|
47
|
+
|
|
48
|
+
| Parameter | Required | Description |
|
|
49
|
+
|---|---|---|
|
|
50
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
51
|
+
| `--config-id` | Yes | Config item ID. |
|
|
52
|
+
| `--param-id` | Yes | Param ID to update. |
|
|
53
|
+
| others | No | See flag descriptions above. |
|
|
54
|
+
|
|
55
|
+
### batch-delete
|
|
56
|
+
|
|
57
|
+
| Parameter | Required | Description |
|
|
58
|
+
|---|---|---|
|
|
59
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
60
|
+
| `--param-ids` | Yes | JSON array of param IDs. |
|
|
61
|
+
|
|
62
|
+
## Output
|
|
63
|
+
|
|
64
|
+
- `list`: `data.items` + `data.total`.
|
|
65
|
+
- `batch-add` / `update`: `data.success`.
|
|
66
|
+
- `batch-delete`: `data.success_num` + `data.fail_list` (looped single deletes; non-atomic).
|
|
67
|
+
|
|
68
|
+
## Decision Rules
|
|
69
|
+
|
|
70
|
+
- Use `list` to discover real `param_id`s before update/delete; never invent IDs.
|
|
71
|
+
- `param_type` is case-sensitive; lowercase values like `"string"` are rejected with `PARAM_TYPE_INVALID`.
|
|
72
|
+
- `batch-delete` is `high-risk-write` and requires `--yes`.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# engage-scene preset-metric
|
|
2
|
+
|
|
3
|
+
> Capability ids: `engage-scene.preset-metric.{get,set}` · Domain: `engage`.
|
|
4
|
+
|
|
5
|
+
场景管理 / 配置中心 - 配置项预置指标(曝光/点击/参与)QP 配置。
|
|
6
|
+
|
|
7
|
+
## Commands
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Get preset metric QP config of a config item
|
|
11
|
+
ae-cli engage-scene preset-metric get --project-id <project_id> --config-id <config_id>
|
|
12
|
+
|
|
13
|
+
# Set preset metric QP config
|
|
14
|
+
ae-cli engage-scene preset-metric set \
|
|
15
|
+
--project-id <project_id> --config-id <config_id> \
|
|
16
|
+
[--impression-event-qp '<qp json>'] [--click-event-qp '<qp json>'] [--attend-event-qp '<qp json>']
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Parameters
|
|
20
|
+
|
|
21
|
+
### get
|
|
22
|
+
|
|
23
|
+
| Parameter | Required | Description |
|
|
24
|
+
|---|---|---|
|
|
25
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
26
|
+
| `--config-id` | Yes | Config item ID. |
|
|
27
|
+
|
|
28
|
+
### set
|
|
29
|
+
|
|
30
|
+
| Parameter | Required | Description |
|
|
31
|
+
|---|---|---|
|
|
32
|
+
| `--project-id` / `-p` | Yes | Numeric project ID. |
|
|
33
|
+
| `--config-id` | Yes | Config item ID. |
|
|
34
|
+
| `--impression-event-qp` | No | Impression event QP JSON string. |
|
|
35
|
+
| `--click-event-qp` | No | Click event QP JSON string. |
|
|
36
|
+
| `--attend-event-qp` | No | Attend event QP JSON string. |
|
|
37
|
+
|
|
38
|
+
## Output
|
|
39
|
+
|
|
40
|
+
- `get`: `data` — preset metric QP config.
|
|
41
|
+
- `set`: `data.success` — whether the operation succeeded.
|
|
42
|
+
|
|
43
|
+
## Decision Rules
|
|
44
|
+
|
|
45
|
+
- `get` is read; `set` is `write`.
|