@redonvn/zalo-ads-sdk 0.2.0 → 0.2.4
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/index.d.mts +2002 -601
- package/dist/index.d.ts +2002 -601
- package/dist/index.js +2436 -762
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2402 -761
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -439,7 +439,7 @@ declare class ZaloSdkError extends Error {
|
|
|
439
439
|
readonly status: number;
|
|
440
440
|
readonly operationId: string;
|
|
441
441
|
readonly responseBody: unknown;
|
|
442
|
-
constructor(message: string, status
|
|
442
|
+
constructor(message: string, status?: number, operationId?: string, responseBody?: unknown);
|
|
443
443
|
}
|
|
444
444
|
interface FileDownloadResponse {
|
|
445
445
|
file: Blob;
|
|
@@ -447,6 +447,62 @@ interface FileDownloadResponse {
|
|
|
447
447
|
contentType: string | null;
|
|
448
448
|
}
|
|
449
449
|
|
|
450
|
+
/**
|
|
451
|
+
* Mã trạng thái kỹ thuật & nghiệp vụ của Instant Page:
|
|
452
|
+
* - 0: Bản sao mới tạo (Clone Draft) - vừa nhân bản từ template hoặc trang khác, chưa từng sửa và chưa xuất bản
|
|
453
|
+
* - 1: Bản nháp đang sửa (Draft) - đang biên tập trong trình tạo trang (Canvas Editor), lưu trong draft
|
|
454
|
+
* - 2: Đã xuất bản (Published / Active) - trang chính thức, cấu hình live nằm trong content, sẵn sàng chạy ads
|
|
455
|
+
* - 3: Lưu trữ / Đã kết thúc (Archived / Ended) - trang đã ngưng hoạt động hoặc kết thúc chiến dịch
|
|
456
|
+
*/
|
|
457
|
+
type ZaloInstantPageStatus = 0 | 1 | 2 | 3;
|
|
458
|
+
/**
|
|
459
|
+
* Cờ trạng thái hoạt động của Instant Page:
|
|
460
|
+
* - 0: Tắt (tạm khóa, không cho người dùng truy cập)
|
|
461
|
+
* - 1: Bật (cho phép xem trang qua https://page.zalo.me/p/{publicId})
|
|
462
|
+
* Bắt buộc kiểu số nguyên 0 | 1, không truyền boolean true/false.
|
|
463
|
+
*/
|
|
464
|
+
type ZaloInstantPageActive = 0 | 1;
|
|
465
|
+
/**
|
|
466
|
+
* Danh mục mã định danh các loại khối giao diện (Block Types) trong Instant Page Canvas (trường draft và content):
|
|
467
|
+
*/
|
|
468
|
+
declare enum ZaloInstantPageBlockType {
|
|
469
|
+
/** Slide ảnh/video banner trình chiếu sản phẩm */
|
|
470
|
+
CAROUSEL_SLIDER = 1,
|
|
471
|
+
/** Đồng hồ đếm ngược Flash sale / thời gian khuyến mãi */
|
|
472
|
+
COUNTDOWN = 2,
|
|
473
|
+
/** Văn bản mô tả giàu định dạng (HTML / Quill Delta ops) */
|
|
474
|
+
RICH_TEXT = 4,
|
|
475
|
+
/** Hình ảnh đơn / banner minh họa (Hero image) */
|
|
476
|
+
HERO_IMAGE = 6,
|
|
477
|
+
/** Form field: Ô nhập họ và tên khách hàng */
|
|
478
|
+
FORM_NAME = 7,
|
|
479
|
+
/** Nút CTA Đặt hàng ngay (cố định chân trang hoặc mở form popup) */
|
|
480
|
+
ORDER_CTA_BUTTON = 8,
|
|
481
|
+
/** Form field: Ô nhập số điện thoại */
|
|
482
|
+
FORM_PHONE = 9,
|
|
483
|
+
/** Form field: Ô nhập địa chỉ giao hàng */
|
|
484
|
+
FORM_ADDRESS = 10,
|
|
485
|
+
/** Chân trang thương hiệu (Hotline, Email, Website, Địa chỉ) */
|
|
486
|
+
FOOTER = 14,
|
|
487
|
+
/** Form field: Ô chọn số lượng sản phẩm mua */
|
|
488
|
+
FORM_QUANTITY = 16,
|
|
489
|
+
/** Phân loại / Biến thể sản phẩm (Màu sắc, Size, Combo) */
|
|
490
|
+
PRODUCT_VARIANT = 18,
|
|
491
|
+
/** Tiêu đề sản phẩm & Giá bán (name, rawPrice, price) */
|
|
492
|
+
PRODUCT_TITLE_PRICE = 19,
|
|
493
|
+
/** Câu hỏi gợi ý nhanh (FAQ quick replies) */
|
|
494
|
+
QUICK_QUESTIONS = 20,
|
|
495
|
+
/** Nút CTA nhắn tin trực tiếp đến Zalo Official Account */
|
|
496
|
+
MESSAGE_CTA_BUTTON = 21,
|
|
497
|
+
/** Tiêu đề phân đoạn (Section Heading) */
|
|
498
|
+
SECTION_HEADING = 22,
|
|
499
|
+
/** Nút Hotline gọi điện thoại tư vấn viên */
|
|
500
|
+
CALL_HOTLINE_BUTTON = 23,
|
|
501
|
+
/** Bảng thông số / Ưu đãi 2 cột (Key-Value rows) */
|
|
502
|
+
KEY_VALUE_TABLE = 25,
|
|
503
|
+
/** Điều khoản đồng thuận thu thập dữ liệu cá nhân theo NĐ 13 */
|
|
504
|
+
CONSENT_NOTICE = 27
|
|
505
|
+
}
|
|
450
506
|
/** Sao chép một Instant Page hiện có và trả về bản Instant Page mới cùng toàn bộ draft được sao chép. Đây là mutation tool thuộc lane zalo-ads-content; dùng khi cần tạo bản làm việc độc lập trước khi chỉnh sửa nội dung hoặc trạng thái. Bản sao có id và publicId mới, không ghi đè Instant Page nguồn. */
|
|
451
507
|
type ZaloInstantPagesCloneInstantPageRequest = {
|
|
452
508
|
/** ID Instant Page nguồn cần sao chép. */
|
|
@@ -465,12 +521,12 @@ type ZaloInstantPagesCloneInstantPageResponse = {
|
|
|
465
521
|
oaId: string;
|
|
466
522
|
/** Chuỗi JSON cấu hình bản nháp đã được sao chép, gồm data các block/section, renderList và các thiết lập layout. Đây chưa tự đại diện cho nội dung public đã phát hành. */
|
|
467
523
|
draft: string;
|
|
468
|
-
/** Cờ bật/tắt của Instant Page
|
|
469
|
-
active:
|
|
524
|
+
/** Cờ bật/tắt của Instant Page: 0 = Tắt, 1 = Bật. */
|
|
525
|
+
active: ZaloInstantPageActive;
|
|
470
526
|
/** ID form liên kết; có thể rỗng. */
|
|
471
527
|
formId: string;
|
|
472
|
-
/** Mã trạng thái Instant Page
|
|
473
|
-
status: number;
|
|
528
|
+
/** Mã trạng thái Instant Page: 0 = Bản sao mới tạo, 1 = Bản nháp, 2 = Đã xuất bản, 3 = Lưu trữ. */
|
|
529
|
+
status: ZaloInstantPageStatus | number;
|
|
474
530
|
/** ID người dùng sở hữu Instant Page. */
|
|
475
531
|
userId: number;
|
|
476
532
|
/** Nội dung đã phát hành/được lưu ngoài draft; có thể rỗng. */
|
|
@@ -508,12 +564,12 @@ type ZaloInstantPagesGetInstantPageDetailResponse = {
|
|
|
508
564
|
oaId: string;
|
|
509
565
|
/** Bản nháp cấu hình Instant Page chưa được phát hành hoặc chưa áp dụng làm nội dung chính; dạng chuỗi JSON/serialized payload. Dùng để so sánh hoặc tiếp tục chỉnh sửa, không tự xem là bản public. */
|
|
510
566
|
draft: string;
|
|
511
|
-
/** Trạng thái kích hoạt. */
|
|
512
|
-
active:
|
|
567
|
+
/** Trạng thái kích hoạt: 0 = Tắt, 1 = Bật. */
|
|
568
|
+
active: ZaloInstantPageActive;
|
|
513
569
|
/** ID form liên kết, khi có. */
|
|
514
570
|
formId: string;
|
|
515
|
-
/** Trạng thái nghiệp v
|
|
516
|
-
status: number;
|
|
571
|
+
/** Trạng thái nghiệp vụ: 0 = Bản sao mới tạo, 1 = Bản nháp, 2 = Đã xuất bản, 3 = Lưu trữ. */
|
|
572
|
+
status: ZaloInstantPageStatus | number;
|
|
517
573
|
/** ID người dùng sở hữu page. */
|
|
518
574
|
userId: number;
|
|
519
575
|
/** Nội dung/cấu hình Instant Page đang được lưu, dạng chuỗi JSON hoặc serialized payload. */
|
|
@@ -577,7 +633,6 @@ type ZaloInstantPagesListInstantPageEditHistoryResponse = {
|
|
|
577
633
|
created: number;
|
|
578
634
|
/** Tên hiển thị của người dùng thực hiện thao tác. */
|
|
579
635
|
userName: string;
|
|
580
|
-
[key: string]: unknown;
|
|
581
636
|
}>;
|
|
582
637
|
metadata: {
|
|
583
638
|
/** Giới hạn bản ghi của trang đã trả về. */
|
|
@@ -586,19 +641,32 @@ type ZaloInstantPagesListInstantPageEditHistoryResponse = {
|
|
|
586
641
|
total: number;
|
|
587
642
|
/** Vị trí bắt đầu của trang đã trả về. */
|
|
588
643
|
offset: number;
|
|
589
|
-
[key: string]: unknown;
|
|
590
644
|
};
|
|
591
|
-
[key: string]: unknown;
|
|
592
645
|
};
|
|
593
|
-
[key: string]: unknown;
|
|
594
646
|
};
|
|
595
|
-
/** Lấy danh sách bản ghi gửi form của một Instant Page. Đây là detail tool thuộc lane zalo-ads-content; dùng khi cần xem dữ liệu khách hàng đã gửi từ form gắn với trang cụ thể.
|
|
647
|
+
/** Lấy danh sách bản ghi gửi form của một Instant Page. Đây là detail tool thuộc lane zalo-ads-content; dùng khi cần xem dữ liệu khách hàng đã gửi từ form gắn với trang cụ thể. */
|
|
596
648
|
type ZaloInstantPagesListInstantPageFormRecordsRequest = {
|
|
597
649
|
/** ID Instant Page có form cần lấy bản ghi gửi. */
|
|
598
650
|
instantPageId: number;
|
|
599
651
|
};
|
|
600
|
-
type
|
|
601
|
-
|
|
652
|
+
type ZaloInstantPagesFormRecordItem = {
|
|
653
|
+
id: string;
|
|
654
|
+
pageId: number;
|
|
655
|
+
userId?: string;
|
|
656
|
+
userName?: string;
|
|
657
|
+
phone?: string;
|
|
658
|
+
created: number;
|
|
659
|
+
answers: Array<{
|
|
660
|
+
questionId: string;
|
|
661
|
+
title: string;
|
|
662
|
+
value: string;
|
|
663
|
+
}>;
|
|
664
|
+
};
|
|
665
|
+
type ZaloInstantPagesListInstantPageFormRecordsResponse = Blob | {
|
|
666
|
+
data: {
|
|
667
|
+
items: Array<ZaloInstantPagesFormRecordItem>;
|
|
668
|
+
total: number;
|
|
669
|
+
};
|
|
602
670
|
};
|
|
603
671
|
/** Lấy danh sách người dùng được chia sẻ quyền truy cập một Instant Page, gồm quyền trên trang và quyền Official Account. Đây là detail tool thuộc lane zalo-ads-content; dùng để kiểm tra quyền cộng tác trước khi chia sẻ, chỉnh sửa hoặc thu hồi quyền. Mỗi phần tử xác định người dùng bằng userId và thông tin hiển thị. */
|
|
604
672
|
type ZaloInstantPagesListInstantPageSharesRequest = {
|
|
@@ -679,14 +747,14 @@ type ZaloInstantPagesSearchInstantPagesResponse = {
|
|
|
679
747
|
oaId: string;
|
|
680
748
|
/** Tên hiển thị chủ sở hữu. */
|
|
681
749
|
owner: string;
|
|
682
|
-
/** Trạng thái bật/tắt
|
|
683
|
-
active:
|
|
750
|
+
/** Trạng thái bật/tắt: 0 = Tắt, 1 = Bật. */
|
|
751
|
+
active: ZaloInstantPageActive;
|
|
684
752
|
/** ID form liên kết; có thể rỗng. */
|
|
685
753
|
formId: string;
|
|
686
754
|
/** Tên các người dùng được chia sẻ quyền. */
|
|
687
755
|
shares: Array<string>;
|
|
688
|
-
/** Mã trạng thái
|
|
689
|
-
status: number;
|
|
756
|
+
/** Mã trạng thái: 0 = Bản sao mới tạo, 1 = Bản nháp, 2 = Đã xuất bản, 3 = Lưu trữ. */
|
|
757
|
+
status: ZaloInstantPageStatus | number;
|
|
690
758
|
/** Unix timestamp theo giây lúc tạo. */
|
|
691
759
|
created: number;
|
|
692
760
|
/** Tên hiển thị người tạo. */
|
|
@@ -695,9 +763,9 @@ type ZaloInstantPagesSearchInstantPagesResponse = {
|
|
|
695
763
|
ownerId: number;
|
|
696
764
|
/** Unix timestamp theo giây lúc cập nhật. */
|
|
697
765
|
modified: number;
|
|
698
|
-
/** Mã công khai của Instant Page. */
|
|
766
|
+
/** Mã công khai 12 ký tự của Instant Page (dùng trên https://page.zalo.me/p/{publicId}). */
|
|
699
767
|
publicId: string;
|
|
700
|
-
/** Unix timestamp theo giây lúc xuất bản. */
|
|
768
|
+
/** Unix timestamp theo giây lúc xuất bản (0 nếu chưa xuất bản). */
|
|
701
769
|
published: number;
|
|
702
770
|
/** Quyền trực tiếp trên Instant Page khi API trả về. */
|
|
703
771
|
permission?: number;
|
|
@@ -709,7 +777,15 @@ type ZaloInstantPagesSearchInstantPagesResponse = {
|
|
|
709
777
|
}>;
|
|
710
778
|
[key: string]: unknown;
|
|
711
779
|
};
|
|
712
|
-
/**
|
|
780
|
+
/**
|
|
781
|
+
* Cập nhật thông tin, cấu hình bản nháp (draft), nội dung chính thức (content) hoặc bật/tắt trạng thái (active) của Instant Page theo ID.
|
|
782
|
+
*
|
|
783
|
+
* Hỗ trợ 4 loại thao tác nghiệp vụ:
|
|
784
|
+
* - **Loại 1 (Bật/Tắt nhanh)**: `{ id, active: 0 | 1 }` (0: Tắt, 1: Bật)
|
|
785
|
+
* - **Loại 2 (Đổi tên / Đổi OA)**: `{ id, name?: string, oaId?: string }`
|
|
786
|
+
* - **Loại 3 (Lưu bản nháp - Save Draft)**: `{ id, name?: string, status: 1, draft: string }`
|
|
787
|
+
* - **Loại 4 (Xuất bản - Publish Live)**: `{ id, name?: string, status: 2, draft: string, content: string }`
|
|
788
|
+
*/
|
|
713
789
|
type ZaloInstantPagesUpdateInstantPageRequest = {
|
|
714
790
|
/** ID Instant Page cần cập nhật. */
|
|
715
791
|
instantPageId: number;
|
|
@@ -717,15 +793,26 @@ type ZaloInstantPagesUpdateInstantPageRequest = {
|
|
|
717
793
|
id: number;
|
|
718
794
|
/** Tên Instant Page mới; giao diện giới hạn tối đa 40 ký tự. Chỉ gửi khi cần đổi tên. */
|
|
719
795
|
name?: string;
|
|
720
|
-
/** ID Official Account liên kết;
|
|
796
|
+
/** ID Official Account liên kết; truyền chuỗi rỗng "" nếu trang chưa liên kết OA hoặc không dùng OA. */
|
|
721
797
|
oaId?: string;
|
|
722
|
-
/**
|
|
798
|
+
/**
|
|
799
|
+
* Chuỗi JSON bản nháp cấu hình Instant Page đang biên tập trên Canvas Editor (chưa xuất bản).
|
|
800
|
+
* Gồm renderList (mảng ID thứ tự hiển thị), data (map ID -> block object), freezedTop, freezedBottom, version.
|
|
801
|
+
* Danh mục block types:
|
|
802
|
+
* 1: CAROUSEL_SLIDER | 2: COUNTDOWN | 4: RICH_TEXT | 6: HERO_IMAGE | 7: FORM_NAME |
|
|
803
|
+
* 8: ORDER_CTA_BUTTON | 9: FORM_PHONE | 10: FORM_ADDRESS | 14: FOOTER | 16: FORM_QUANTITY |
|
|
804
|
+
* 18: PRODUCT_VARIANT | 19: PRODUCT_TITLE_PRICE | 20: QUICK_QUESTIONS | 21: MESSAGE_CTA_BUTTON |
|
|
805
|
+
* 22: SECTION_HEADING | 23: CALL_HOTLINE_BUTTON | 25: KEY_VALUE_TABLE | 27: CONSENT_NOTICE
|
|
806
|
+
*/
|
|
723
807
|
draft?: string;
|
|
724
|
-
/** Thao tác bật/tắt Instant Page: 0 là tắt, 1 là bật. */
|
|
725
|
-
active?:
|
|
726
|
-
/** Mã trạng thái
|
|
727
|
-
status?: number;
|
|
728
|
-
/**
|
|
808
|
+
/** Thao tác bật/tắt Instant Page: 0 là tắt, 1 là bật. BẮT BUỘC là số nguyên 0 | 1, không truyền kiểu boolean. */
|
|
809
|
+
active?: ZaloInstantPageActive;
|
|
810
|
+
/** Mã trạng thái của Instant Page: 1 = Lưu bản nháp (Draft), 2 = Xuất bản chính thức (Published). */
|
|
811
|
+
status?: ZaloInstantPageStatus | number;
|
|
812
|
+
/**
|
|
813
|
+
* Chuỗi JSON cấu hình nội dung chính thức đang chạy ở Production của Instant Page (sau khi xuất bản).
|
|
814
|
+
* Chỉ gửi khi xuất bản chính thức (status = 2). Cấu trúc tương tự draft.
|
|
815
|
+
*/
|
|
729
816
|
content?: string;
|
|
730
817
|
};
|
|
731
818
|
type ZaloInstantPagesUpdateInstantPageResponse = {
|
|
@@ -809,10 +896,10 @@ type ZaloInstantPagesUpsertInstantPageFormRequest = {
|
|
|
809
896
|
/** Mô tả phụ của câu hỏi (có thể để chuỗi rỗng). */
|
|
810
897
|
description: string;
|
|
811
898
|
}>;
|
|
812
|
-
/** Sử dụng cấu hình điều khoản đồng ý tùy chỉnh hay mặc định. */
|
|
813
|
-
useCustomConsent
|
|
814
|
-
/** Cấu hình thông tin pháp lý và phạm vi thu thập dữ liệu cá nhân của biểu mẫu. */
|
|
815
|
-
consentConfig
|
|
899
|
+
/** Sử dụng cấu hình điều khoản đồng ý tùy chỉnh hay mặc định (mặc định: false). */
|
|
900
|
+
useCustomConsent?: boolean;
|
|
901
|
+
/** Cấu hình thông tin pháp lý và phạm vi thu thập dữ liệu cá nhân của biểu mẫu (bắt buộc khi useCustomConsent = true). */
|
|
902
|
+
consentConfig?: {
|
|
816
903
|
/** Địa chỉ liên hệ của bên kiểm soát hoặc sở hữu dữ liệu. */
|
|
817
904
|
address: string;
|
|
818
905
|
/** Tên cá nhân hoặc đơn vị sở hữu dữ liệu. */
|
|
@@ -968,60 +1055,195 @@ type ZaloAdsUpdateFlowRequest = {
|
|
|
968
1055
|
messages: ZaloAdsFlowMessageDto[];
|
|
969
1056
|
};
|
|
970
1057
|
type ZaloAdsUpdateFlowResponse = {
|
|
971
|
-
code
|
|
1058
|
+
code: number;
|
|
972
1059
|
msg?: string;
|
|
973
|
-
data?:
|
|
974
|
-
|
|
1060
|
+
data?: {
|
|
1061
|
+
id?: number;
|
|
1062
|
+
};
|
|
975
1063
|
};
|
|
1064
|
+
interface ZaloAdsAdPriceSettingsDto {
|
|
1065
|
+
Bid: number;
|
|
1066
|
+
Type: number;
|
|
1067
|
+
Limit: number;
|
|
1068
|
+
LimitType: number;
|
|
1069
|
+
SpendingMethod: number;
|
|
1070
|
+
}
|
|
1071
|
+
interface ZaloAdsAdMultiImageItemDto {
|
|
1072
|
+
Url: string;
|
|
1073
|
+
Title?: string;
|
|
1074
|
+
Description?: string;
|
|
1075
|
+
TargetUrl?: string;
|
|
1076
|
+
}
|
|
1077
|
+
interface ZaloAdsAdImageSettingsDto {
|
|
1078
|
+
LogoUrl?: string;
|
|
1079
|
+
LandscapeCoverUrl?: string;
|
|
1080
|
+
SquareCoverUrl?: string;
|
|
1081
|
+
VideoUrl?: string;
|
|
1082
|
+
VideoDuration?: number;
|
|
1083
|
+
MediaId?: number;
|
|
1084
|
+
MultiImages?: Array<ZaloAdsAdMultiImageItemDto>;
|
|
1085
|
+
}
|
|
1086
|
+
interface ZaloAdsAdInfoSettingsDto {
|
|
1087
|
+
Title?: string;
|
|
1088
|
+
Description?: string;
|
|
1089
|
+
Caption?: string;
|
|
1090
|
+
Action?: number;
|
|
1091
|
+
ButtonText?: string;
|
|
1092
|
+
MoreInfo?: string;
|
|
1093
|
+
TargetUrl?: string;
|
|
1094
|
+
Phone?: string;
|
|
1095
|
+
Address?: string;
|
|
1096
|
+
}
|
|
1097
|
+
interface ZaloAdsAdAppInfoSettingsDto {
|
|
1098
|
+
AppType?: number;
|
|
1099
|
+
OsType?: number;
|
|
1100
|
+
StoreUrl?: string;
|
|
1101
|
+
}
|
|
1102
|
+
interface ZaloAdsAdTargetingSettingsDto {
|
|
1103
|
+
Gender?: number;
|
|
1104
|
+
AgeRanges?: Array<number>;
|
|
1105
|
+
Locations?: string;
|
|
1106
|
+
Provinces?: Array<number>;
|
|
1107
|
+
DistrictsTargeting?: string;
|
|
1108
|
+
WardsTargeting?: string;
|
|
1109
|
+
Platforms?: Array<number>;
|
|
1110
|
+
NetworkTypes?: Array<number>;
|
|
1111
|
+
OsTypes?: Array<number>;
|
|
1112
|
+
AdvanceTargetings?: Array<number>;
|
|
1113
|
+
CustomAudiences?: Array<number>;
|
|
1114
|
+
ExcludeCustomAudiences?: Array<number>;
|
|
1115
|
+
}
|
|
1116
|
+
interface ZaloAdsAdZVideoSettingsDto {
|
|
1117
|
+
Url: string;
|
|
1118
|
+
Duration: number;
|
|
1119
|
+
Src: number;
|
|
1120
|
+
Thumbnail: string;
|
|
1121
|
+
Description: string;
|
|
1122
|
+
ChannelName: string;
|
|
1123
|
+
ChannelAvt: string;
|
|
1124
|
+
VideoThumbnail: string;
|
|
1125
|
+
ThumbnailIndex: number | null;
|
|
1126
|
+
}
|
|
1127
|
+
interface ZaloAdsAdSettingsDto {
|
|
1128
|
+
Image: ZaloAdsAdImageSettingsDto;
|
|
1129
|
+
Price: ZaloAdsAdPriceSettingsDto;
|
|
1130
|
+
AdInfo: ZaloAdsAdInfoSettingsDto;
|
|
1131
|
+
AppInfo?: ZaloAdsAdAppInfoSettingsDto;
|
|
1132
|
+
Targeting: ZaloAdsAdTargetingSettingsDto;
|
|
1133
|
+
ZVideo?: ZaloAdsAdZVideoSettingsDto;
|
|
1134
|
+
VideoPlatform?: number;
|
|
1135
|
+
Rating?: number;
|
|
1136
|
+
NewFeatures?: Array<number>;
|
|
1137
|
+
CreatedClientVersion?: number;
|
|
1138
|
+
}
|
|
1139
|
+
interface ZaloAdsAdUpdatePayloadDto {
|
|
1140
|
+
AdId: number;
|
|
1141
|
+
CampaignId: number;
|
|
1142
|
+
MemberId: number;
|
|
1143
|
+
RowVersion: number;
|
|
1144
|
+
AdName: string;
|
|
1145
|
+
Type: number;
|
|
1146
|
+
Settings: ZaloAdsAdSettingsDto;
|
|
1147
|
+
Status: number;
|
|
1148
|
+
StartDate: number;
|
|
1149
|
+
EndDate: number;
|
|
1150
|
+
ZaloFlowId?: number;
|
|
1151
|
+
ZaloPageId?: number;
|
|
1152
|
+
ZaloFormId?: string;
|
|
1153
|
+
ZaloFeedId?: string | number;
|
|
1154
|
+
MiniPageId?: number;
|
|
1155
|
+
UseConversion?: 0 | 1;
|
|
1156
|
+
ConversionId?: number;
|
|
1157
|
+
Report?: Record<string, number>;
|
|
1158
|
+
}
|
|
1159
|
+
interface ZaloAdsAdMutationResultDto {
|
|
1160
|
+
AdId?: number;
|
|
1161
|
+
CampaignId?: number;
|
|
1162
|
+
Status?: number;
|
|
1163
|
+
RowVersion?: number;
|
|
1164
|
+
}
|
|
1165
|
+
interface ZaloAdsCampaignCreatePayloadDto {
|
|
1166
|
+
name: string;
|
|
1167
|
+
campaignType: number;
|
|
1168
|
+
pageId: number;
|
|
1169
|
+
productId: number;
|
|
1170
|
+
targetUrl?: string;
|
|
1171
|
+
articleId?: number;
|
|
1172
|
+
adtype: number;
|
|
1173
|
+
budgetType: number;
|
|
1174
|
+
budgetlimit: number;
|
|
1175
|
+
limitType: number;
|
|
1176
|
+
campaignObjective: number;
|
|
1177
|
+
campaignId: number;
|
|
1178
|
+
adId: number;
|
|
1179
|
+
}
|
|
1180
|
+
interface ZaloAdsFormSectionTableItemDto {
|
|
1181
|
+
key: string;
|
|
1182
|
+
value: string;
|
|
1183
|
+
}
|
|
1184
|
+
interface ZaloAdsFormSectionImageItemDto {
|
|
1185
|
+
url: string;
|
|
1186
|
+
title?: string;
|
|
1187
|
+
caption?: string;
|
|
1188
|
+
}
|
|
1189
|
+
interface ZaloAdsFormSectionContentDto {
|
|
1190
|
+
title?: string;
|
|
1191
|
+
description?: string;
|
|
1192
|
+
table?: Array<ZaloAdsFormSectionTableItemDto>;
|
|
1193
|
+
images?: Array<ZaloAdsFormSectionImageItemDto>;
|
|
1194
|
+
}
|
|
1195
|
+
interface ZaloAdsFormSectionDto {
|
|
1196
|
+
type: "0" | "1" | "2" | "3" | "4" | number;
|
|
1197
|
+
title: string;
|
|
1198
|
+
expand: boolean;
|
|
1199
|
+
disable: boolean;
|
|
1200
|
+
content: ZaloAdsFormSectionContentDto;
|
|
1201
|
+
}
|
|
1202
|
+
interface ZaloAdsFormQuestionUiDto {
|
|
1203
|
+
icon?: string;
|
|
1204
|
+
title?: string;
|
|
1205
|
+
removable?: boolean;
|
|
1206
|
+
}
|
|
1207
|
+
interface ZaloAdsFormAnswerDto {
|
|
1208
|
+
id?: string;
|
|
1209
|
+
type: "2" | "7" | "13" | number;
|
|
1210
|
+
value?: string | null;
|
|
1211
|
+
priority?: number;
|
|
1212
|
+
placeHolder?: string;
|
|
1213
|
+
}
|
|
1214
|
+
interface ZaloAdsFormQuestionDto {
|
|
1215
|
+
id?: string;
|
|
1216
|
+
ui?: ZaloAdsFormQuestionUiDto;
|
|
1217
|
+
type: "1" | number;
|
|
1218
|
+
title: string;
|
|
1219
|
+
answers: Array<ZaloAdsFormAnswerDto>;
|
|
1220
|
+
groupIdx?: number;
|
|
1221
|
+
priority?: number;
|
|
1222
|
+
isRequired: boolean;
|
|
1223
|
+
editDisabled?: boolean;
|
|
1224
|
+
}
|
|
1225
|
+
interface ZaloAdsCreateFormPayloadDto {
|
|
1226
|
+
id?: string;
|
|
1227
|
+
oaId: string;
|
|
1228
|
+
formName: string;
|
|
1229
|
+
title?: string;
|
|
1230
|
+
description?: string;
|
|
1231
|
+
coverPhoto?: string;
|
|
1232
|
+
thanks?: string;
|
|
1233
|
+
gotoText?: string;
|
|
1234
|
+
gotoActionType?: number;
|
|
1235
|
+
website?: string;
|
|
1236
|
+
phone?: string;
|
|
1237
|
+
submitTitle?: string;
|
|
1238
|
+
reviewSubmit?: boolean;
|
|
1239
|
+
oaConsentWidget?: boolean;
|
|
1240
|
+
useCustomConsent?: boolean;
|
|
1241
|
+
sections?: Array<ZaloAdsFormSectionDto>;
|
|
1242
|
+
questions: Array<ZaloAdsFormQuestionDto>;
|
|
1243
|
+
}
|
|
976
1244
|
/** Cập nhật quảng cáo Video; service tự JSON.stringify data rồi gửi form-urlencoded. */
|
|
977
1245
|
declare class ZaloAdsUpdateVideoAdRequest {
|
|
978
|
-
data:
|
|
979
|
-
AdId: number;
|
|
980
|
-
CampaignId: number;
|
|
981
|
-
MemberId: number;
|
|
982
|
-
RowVersion: number;
|
|
983
|
-
AdName: string;
|
|
984
|
-
/** 11 = Quảng cáo Video. */
|
|
985
|
-
Type: 11;
|
|
986
|
-
Settings: {
|
|
987
|
-
Image: {
|
|
988
|
-
LogoUrl: string;
|
|
989
|
-
LandscapeCoverUrl: string;
|
|
990
|
-
VideoUrl: string;
|
|
991
|
-
VideoDuration: number;
|
|
992
|
-
[key: string]: unknown;
|
|
993
|
-
};
|
|
994
|
-
Price: {
|
|
995
|
-
Bid: number;
|
|
996
|
-
Type: 1;
|
|
997
|
-
Limit: number;
|
|
998
|
-
LimitType: 1;
|
|
999
|
-
SpendingMethod: 0;
|
|
1000
|
-
};
|
|
1001
|
-
AdInfo: Record<string, unknown>;
|
|
1002
|
-
AppInfo: Record<string, unknown>;
|
|
1003
|
-
Targeting: Record<string, unknown>;
|
|
1004
|
-
ZVideo: {
|
|
1005
|
-
Url: string;
|
|
1006
|
-
Duration: number;
|
|
1007
|
-
Src: 2;
|
|
1008
|
-
Thumbnail: string;
|
|
1009
|
-
Description: string;
|
|
1010
|
-
ChannelName: string;
|
|
1011
|
-
ChannelAvt: string;
|
|
1012
|
-
VideoThumbnail: string;
|
|
1013
|
-
ThumbnailIndex: number | null;
|
|
1014
|
-
};
|
|
1015
|
-
VideoPlatform: 1;
|
|
1016
|
-
[key: string]: unknown;
|
|
1017
|
-
};
|
|
1018
|
-
Status: number;
|
|
1019
|
-
StartDate: number;
|
|
1020
|
-
EndDate: number;
|
|
1021
|
-
ZaloFlowId: number;
|
|
1022
|
-
UseConversion: 0 | 1;
|
|
1023
|
-
[key: string]: unknown;
|
|
1024
|
-
};
|
|
1246
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
1025
1247
|
est?: string;
|
|
1026
1248
|
isBoostAd?: 0 | 1;
|
|
1027
1249
|
stt?: number;
|
|
@@ -1029,7 +1251,7 @@ declare class ZaloAdsUpdateVideoAdRequest {
|
|
|
1029
1251
|
declare class ZaloAdsUpdateVideoAdResponse {
|
|
1030
1252
|
code: number;
|
|
1031
1253
|
msg: string;
|
|
1032
|
-
data?:
|
|
1254
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
1033
1255
|
}
|
|
1034
1256
|
/** Lấy danh sách hoặc Flow cụ thể của một Official Account. Dùng flowId khi cần đọc một Flow trước khi cập nhật, hoặc offset và limit khi duyệt danh sách. */
|
|
1035
1257
|
type ZaloAdsListFlowsByOfficialAccountRequest = {
|
|
@@ -1060,20 +1282,20 @@ type ZaloAdsListFlowsByOfficialAccountResponse = {
|
|
|
1060
1282
|
text: string;
|
|
1061
1283
|
editable: boolean;
|
|
1062
1284
|
url: string;
|
|
1063
|
-
messages: Array<
|
|
1285
|
+
messages: Array<ZaloAdsFlowChildMessageDto>;
|
|
1286
|
+
}>;
|
|
1287
|
+
elements: Array<{
|
|
1288
|
+
type?: number;
|
|
1289
|
+
title?: string;
|
|
1290
|
+
url?: string;
|
|
1064
1291
|
}>;
|
|
1065
|
-
elements: Array<unknown>;
|
|
1066
1292
|
stepId: number;
|
|
1067
|
-
[key: string]: unknown;
|
|
1068
1293
|
}>;
|
|
1069
|
-
[key: string]: unknown;
|
|
1070
1294
|
}>;
|
|
1071
1295
|
extend: {
|
|
1072
1296
|
total: number;
|
|
1073
1297
|
index?: number;
|
|
1074
|
-
[key: string]: unknown;
|
|
1075
1298
|
};
|
|
1076
|
-
[key: string]: unknown;
|
|
1077
1299
|
};
|
|
1078
1300
|
/** Thay đổi trạng thái của một chiến dịch Zalo Ads theo mã trạng thái được chỉ định. Đây là destructive mutation tool thuộc lane quản lý chiến dịch; dùng khi cần dừng, hủy hoặc chuyển trạng thái chiến dịch và phải xác minh rõ mã trạng thái trước khi gọi. Giá trị -2 trong request đã ghi nhận sẽ xóa chiến dịch. */
|
|
1079
1301
|
type ZaloAdsChangeCampaignStatusRequest = {
|
|
@@ -1131,7 +1353,7 @@ type ZaloAdsCreateCustomAudienceResponse = {
|
|
|
1131
1353
|
/** Tạo chiến dịch quảng cáo E-commerce (Commerce) trên Zalo Ads (campaignType = 9). Service tự JSON.stringify nếu truyền object. */
|
|
1132
1354
|
type ZaloAdsCreateEcommerceCampaignRequest = {
|
|
1133
1355
|
/** Cấu hình chiến dịch Commerce (object hoặc chuỗi JSON): { name, campaignType: 9, pageId, productId, targetUrl, adtype: -1, budgetType: 1, budgetlimit, limitType: 2, campaignObjective: 0, campaignId: 0, adId: 0 }. */
|
|
1134
|
-
data:
|
|
1356
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
1135
1357
|
};
|
|
1136
1358
|
type ZaloAdsCreateEcommerceCampaignResponse = {
|
|
1137
1359
|
msg: string;
|
|
@@ -1144,8 +1366,8 @@ type ZaloAdsCreateEcommerceCampaignResponse = {
|
|
|
1144
1366
|
};
|
|
1145
1367
|
/** Tạo form gắn Official Account, câu hỏi thu thập thông tin, nội dung section và màn hình cảm ơn. Đây là thao tác mutation; form mới sẽ xuất hiện trong danh sách biểu mẫu của OA. */
|
|
1146
1368
|
type ZaloAdsCreateFormRequest = {
|
|
1147
|
-
/**
|
|
1148
|
-
data:
|
|
1369
|
+
/** Cấu hình biểu mẫu thu thập thông tin khách hàng hoặc chuỗi JSON.stringify(CreateFormPayload). */
|
|
1370
|
+
data: ZaloAdsCreateFormPayloadDto | string;
|
|
1149
1371
|
};
|
|
1150
1372
|
type ZaloAdsCreateFormResponse = {
|
|
1151
1373
|
code: "0" | 0;
|
|
@@ -1159,57 +1381,8 @@ type ZaloAdsCreateFormResponse = {
|
|
|
1159
1381
|
/** Unix epoch giây. */
|
|
1160
1382
|
createAt: number;
|
|
1161
1383
|
formName: string;
|
|
1162
|
-
sections: Array<
|
|
1163
|
-
|
|
1164
|
-
type: "0" | "1" | "2" | "3" | "4";
|
|
1165
|
-
title: string;
|
|
1166
|
-
/** Mở rộng section khi hiển thị. */
|
|
1167
|
-
expand: boolean;
|
|
1168
|
-
content: {
|
|
1169
|
-
table?: Array<{
|
|
1170
|
-
key: string;
|
|
1171
|
-
value: string;
|
|
1172
|
-
}>;
|
|
1173
|
-
title?: string;
|
|
1174
|
-
images?: Array<{
|
|
1175
|
-
url: string;
|
|
1176
|
-
title?: string;
|
|
1177
|
-
caption?: string;
|
|
1178
|
-
}>;
|
|
1179
|
-
videos?: Array<Record<string, never>>;
|
|
1180
|
-
description?: string;
|
|
1181
|
-
};
|
|
1182
|
-
/** Ẩn/vô hiệu section. */
|
|
1183
|
-
disable: boolean;
|
|
1184
|
-
}>;
|
|
1185
|
-
questions: Array<{
|
|
1186
|
-
/** ID câu hỏi. Không cần khi tạo thông thường; được backend trả về và được gửi lại khi chỉnh sửa/logic. */
|
|
1187
|
-
id?: string;
|
|
1188
|
-
ui?: {
|
|
1189
|
-
icon?: string;
|
|
1190
|
-
title?: string;
|
|
1191
|
-
removable?: boolean;
|
|
1192
|
-
};
|
|
1193
|
-
/** Loại câu hỏi đã capture. */
|
|
1194
|
-
type: "1";
|
|
1195
|
-
/** Nhãn câu hỏi. UI báo lỗi ngoài khoảng 2–180 ký tự. */
|
|
1196
|
-
title: string;
|
|
1197
|
-
answers: Array<{
|
|
1198
|
-
/** ID đáp án do backend cấp. Chỉ cần gửi khi dùng logic câu hỏi/chỉnh sửa; tạo mới thông thường có thể không có. */
|
|
1199
|
-
id?: string;
|
|
1200
|
-
/** 2=số điện thoại phụ; 7=họ tên; 13=số điện thoại chuẩn. */
|
|
1201
|
-
type: "2" | "7" | "13";
|
|
1202
|
-
/** Request mẫu gửi null cho đáp án chuẩn; không thấy ở số điện thoại phụ. */
|
|
1203
|
-
value?: string | null;
|
|
1204
|
-
/** Placeholder do backend trả về sau khi tạo. */
|
|
1205
|
-
placeHolder?: string;
|
|
1206
|
-
}>;
|
|
1207
|
-
/** Chỉ số trang của câu hỏi trong form nhiều trang, bắt đầu từ 0. Không gửi field này trong form một trang. */
|
|
1208
|
-
groupIdx?: number;
|
|
1209
|
-
isRequired: boolean;
|
|
1210
|
-
/** Khóa việc sửa câu hỏi chuẩn. */
|
|
1211
|
-
editDisabled?: boolean;
|
|
1212
|
-
}>;
|
|
1384
|
+
sections: Array<ZaloAdsFormSectionDto>;
|
|
1385
|
+
questions: Array<ZaloAdsFormQuestionDto>;
|
|
1213
1386
|
/** Unix epoch giây. */
|
|
1214
1387
|
updatedAt: number;
|
|
1215
1388
|
description?: string;
|
|
@@ -1218,7 +1391,7 @@ type ZaloAdsCreateFormResponse = {
|
|
|
1218
1391
|
/** Tạo chiến dịch quảng cáo biểu mẫu (Form) trên Zalo Ads (campaignType = 8). Service tự JSON.stringify nếu truyền object. */
|
|
1219
1392
|
type ZaloAdsCreateFormCampaignRequest = {
|
|
1220
1393
|
/** Cấu hình chiến dịch biểu mẫu (object hoặc chuỗi JSON). */
|
|
1221
|
-
data:
|
|
1394
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
1222
1395
|
};
|
|
1223
1396
|
type ZaloAdsCreateFormCampaignResponse = {
|
|
1224
1397
|
msg: string;
|
|
@@ -1231,7 +1404,7 @@ type ZaloAdsCreateFormCampaignResponse = {
|
|
|
1231
1404
|
/** Tạo chiến dịch quảng cáo Tin nhắn trên Zalo Ads (campaignType = 10). Service tự JSON.stringify nếu truyền object. */
|
|
1232
1405
|
type ZaloAdsCreateMessageCampaignRequest = {
|
|
1233
1406
|
/** Cấu hình chiến dịch Tin nhắn (object hoặc chuỗi JSON). */
|
|
1234
|
-
data:
|
|
1407
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
1235
1408
|
};
|
|
1236
1409
|
type ZaloAdsCreateMessageCampaignResponse = {
|
|
1237
1410
|
code?: number;
|
|
@@ -1247,7 +1420,7 @@ type ZaloAdsCreateMessageCampaignResponse = {
|
|
|
1247
1420
|
/** Tạo chiến dịch quảng cáo Zalo Official Account (campaignType = 2). Service tự JSON.stringify nếu truyền object. */
|
|
1248
1421
|
type ZaloAdsCreateOfficialAccountCampaignRequest = {
|
|
1249
1422
|
/** Cấu hình chiến dịch Official Account (object hoặc chuỗi JSON). */
|
|
1250
|
-
data:
|
|
1423
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
1251
1424
|
};
|
|
1252
1425
|
type ZaloAdsCreateOfficialAccountCampaignResponse = {
|
|
1253
1426
|
msg: string;
|
|
@@ -1261,27 +1434,7 @@ type ZaloAdsCreateOfficialAccountCampaignResponse = {
|
|
|
1261
1434
|
/** Tạo chiến dịch quảng cáo Bài viết trên Zalo Ads (campaignType = 4). Service tự JSON.stringify payload này vào field form data. */
|
|
1262
1435
|
declare class ZaloAdsCreatePostCampaignRequest {
|
|
1263
1436
|
/** Cấu hình chiến dịch Bài viết (object hoặc chuỗi JSON). */
|
|
1264
|
-
data:
|
|
1265
|
-
name: string;
|
|
1266
|
-
/** 4 = Quảng cáo Bài viết. */
|
|
1267
|
-
campaignType: 4;
|
|
1268
|
-
/** ID Official Account/trang chứa bài viết. */
|
|
1269
|
-
pageId: number;
|
|
1270
|
-
/** Mẫu Bài viết dùng -1. */
|
|
1271
|
-
productId: -1;
|
|
1272
|
-
/** ID bài viết Zalo cần quảng cáo. */
|
|
1273
|
-
articleId: number;
|
|
1274
|
-
adtype: -1;
|
|
1275
|
-
budgetType: number;
|
|
1276
|
-
budgetlimit: number;
|
|
1277
|
-
limitType: number;
|
|
1278
|
-
campaignObjective: number;
|
|
1279
|
-
/** Đặt 0 để tạo chiến dịch mới. */
|
|
1280
|
-
campaignId: 0;
|
|
1281
|
-
/** Đặt 0 để tạo quảng cáo mới. */
|
|
1282
|
-
adId: 0;
|
|
1283
|
-
[key: string]: unknown;
|
|
1284
|
-
} | string;
|
|
1437
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
1285
1438
|
}
|
|
1286
1439
|
declare class ZaloAdsCreatePostCampaignResponse {
|
|
1287
1440
|
code: number;
|
|
@@ -1292,6 +1445,11 @@ declare class ZaloAdsCreatePostCampaignResponse {
|
|
|
1292
1445
|
campaignId: number;
|
|
1293
1446
|
};
|
|
1294
1447
|
}
|
|
1448
|
+
interface ZaloAdsConversionElementSelectorDto {
|
|
1449
|
+
class?: Array<string>;
|
|
1450
|
+
id?: string;
|
|
1451
|
+
tag?: string;
|
|
1452
|
+
}
|
|
1295
1453
|
/** Tạo conversion để đo lường hành động trên trang đích Zalo Ads. Đây là mutation tool thuộc lane zalo-ads-conversion; dùng sau khi đã xác định nhãn conversion, URL trang đích và quy tắc sự kiện click hoặc URL. Chỉ gọi khi cần tạo mới vì mỗi lần gọi sẽ phát sinh một conversion trong tài khoản quảng cáo. */
|
|
1296
1454
|
type ZaloAdsCreateConversionRequest = {
|
|
1297
1455
|
/** Tên conversion, phải duy nhất trong tài khoản quảng cáo (2–180 ký tự). */
|
|
@@ -1301,10 +1459,7 @@ type ZaloAdsCreateConversionRequest = {
|
|
|
1301
1459
|
/** Kiểu khớp URL: 1 hoặc 2. */
|
|
1302
1460
|
urlType: 1 | 2 | number;
|
|
1303
1461
|
/** Bộ chọn phần tử click; ví dụ [{"class":["btn"]}]. Dùng mảng rỗng khi không áp dụng. */
|
|
1304
|
-
elements: Array<
|
|
1305
|
-
class?: Array<string>;
|
|
1306
|
-
[key: string]: unknown;
|
|
1307
|
-
}>;
|
|
1462
|
+
elements: Array<ZaloAdsConversionElementSelectorDto>;
|
|
1308
1463
|
/** Từ khóa URL cần ghi nhận; dùng mảng rỗng khi không áp dụng. */
|
|
1309
1464
|
keywords: Array<string>;
|
|
1310
1465
|
/** Danh sách ID nút theo cấu hình click; dùng mảng rỗng khi không áp dụng. */
|
|
@@ -1312,11 +1467,20 @@ type ZaloAdsCreateConversionRequest = {
|
|
|
1312
1467
|
/** URL trang đích có Zalo Pixel. */
|
|
1313
1468
|
landingPage: string;
|
|
1314
1469
|
};
|
|
1470
|
+
interface ZaloAdsConversionItemDto {
|
|
1471
|
+
conversionId: number;
|
|
1472
|
+
name: string;
|
|
1473
|
+
labelId: number;
|
|
1474
|
+
urlType?: number;
|
|
1475
|
+
landingPage?: string;
|
|
1476
|
+
status?: number;
|
|
1477
|
+
created?: number;
|
|
1478
|
+
memberId?: number;
|
|
1479
|
+
}
|
|
1315
1480
|
type ZaloAdsCreateConversionResponse = {
|
|
1316
|
-
code
|
|
1481
|
+
code: number;
|
|
1317
1482
|
msg?: string;
|
|
1318
|
-
data?:
|
|
1319
|
-
[key: string]: unknown;
|
|
1483
|
+
data?: ZaloAdsConversionItemDto | number;
|
|
1320
1484
|
};
|
|
1321
1485
|
/** Xóa một conversion đã cấu hình trên Zalo Ads. Đây là destructive tool thuộc lane zalo-ads-conversion; chỉ dùng sau khi đối chiếu ID từ danh sách conversion và xác nhận cần dừng ghi nhận dữ liệu mới. Không dùng để tạm dừng hoặc chỉnh sửa conversion vì thao tác không thể khôi phục. */
|
|
1322
1486
|
type ZaloAdsDeleteConversionRequest = {
|
|
@@ -1327,8 +1491,7 @@ type ZaloAdsDeleteConversionResponse = {
|
|
|
1327
1491
|
/** Thông báo trạng thái từ Zalo Ads. */
|
|
1328
1492
|
msg: string;
|
|
1329
1493
|
/** Mã thành công đã capture: 0. */
|
|
1330
|
-
code: 0;
|
|
1331
|
-
[key: string]: unknown;
|
|
1494
|
+
code: 0 | number;
|
|
1332
1495
|
};
|
|
1333
1496
|
/** Xóa một audience tùy chỉnh theo ID trên Zalo Ads. Đây là destructive tool thuộc lane zalo-ads-audience; chỉ dùng sau khi xác nhận đúng audience và hệ quả không thể hoàn tác. Dùng CustomAudienceId từ tool danh sách hoặc tạo audience. */
|
|
1334
1497
|
type ZaloAdsDeleteCustomAudienceRequest = {
|
|
@@ -1345,10 +1508,29 @@ type ZaloAdsDeleteCustomAudienceResponse = {
|
|
|
1345
1508
|
type ZaloAdsGetAdByIdRequest = {
|
|
1346
1509
|
/** ID mẫu quảng cáo cần lấy chi tiết (query param `adId`). */
|
|
1347
1510
|
adId?: number | string;
|
|
1348
|
-
[key: string]: unknown;
|
|
1349
1511
|
};
|
|
1350
1512
|
type ZaloAdsGetAdByIdResponse = {
|
|
1351
|
-
|
|
1513
|
+
code?: number;
|
|
1514
|
+
msg?: string;
|
|
1515
|
+
data?: ZaloAdsAdUpdatePayloadDto;
|
|
1516
|
+
AdId?: number;
|
|
1517
|
+
CampaignId?: number;
|
|
1518
|
+
MemberId?: number;
|
|
1519
|
+
RowVersion?: number;
|
|
1520
|
+
AdName?: string;
|
|
1521
|
+
Type?: number;
|
|
1522
|
+
Settings?: ZaloAdsAdSettingsDto;
|
|
1523
|
+
Status?: number;
|
|
1524
|
+
StartDate?: number;
|
|
1525
|
+
EndDate?: number;
|
|
1526
|
+
ZaloFlowId?: number;
|
|
1527
|
+
ZaloPageId?: number;
|
|
1528
|
+
ZaloFormId?: string;
|
|
1529
|
+
ZaloFeedId?: string | number;
|
|
1530
|
+
MiniPageId?: number;
|
|
1531
|
+
UseConversion?: 0 | 1;
|
|
1532
|
+
ConversionId?: number;
|
|
1533
|
+
Report?: Record<string, number>;
|
|
1352
1534
|
};
|
|
1353
1535
|
/** Lấy lịch sử thao tác và các hạng mục thay đổi của một quảng cáo Zalo Ads. Đây là detail tool thuộc lane quản lý quảng cáo; dùng để kiểm tra ai đã tạo hoặc điều chỉnh nội dung, đối tượng, hình/video và conversion. Mỗi bản ghi nêu người thực hiện, thời điểm và danh sách thay đổi chính hoặc bổ sung. */
|
|
1354
1536
|
type ZaloAdsGetAdChangeLogRequest = {
|
|
@@ -1394,25 +1576,96 @@ type ZaloAdsGetApiAdGetlistadadvancetargetingResponse = {
|
|
|
1394
1576
|
displayName: string;
|
|
1395
1577
|
}>;
|
|
1396
1578
|
};
|
|
1397
|
-
|
|
1398
|
-
|
|
1579
|
+
interface ZaloAdsAccessorItemDto {
|
|
1580
|
+
/** ID định danh của thành viên trên Zalo Ads (ví dụ: 257887336). */
|
|
1581
|
+
memberId: number;
|
|
1582
|
+
/** Tên hiển thị của thành viên. */
|
|
1583
|
+
memberName: string;
|
|
1584
|
+
/** Số điện thoại của thành viên (định dạng 84...). */
|
|
1585
|
+
memberPhone?: string;
|
|
1586
|
+
/** URL ảnh đại diện của thành viên. */
|
|
1587
|
+
memberAvatar?: string;
|
|
1588
|
+
/** Cấp độ quyền truy cập (0 = Chủ tài khoản gốc). */
|
|
1589
|
+
accessLevel: number;
|
|
1590
|
+
}
|
|
1591
|
+
interface ZaloAdsAccountAgencyInfoDto {
|
|
1592
|
+
/** Mã định danh của Agency (ví dụ: 277596648). */
|
|
1593
|
+
agencyId: number;
|
|
1594
|
+
/** ID tài khoản chủ sở hữu Agency (ví dụ: 257887336). */
|
|
1595
|
+
ownerId: number;
|
|
1596
|
+
/** Tên pháp nhân hoặc tên hiển thị của Agency. */
|
|
1597
|
+
agencyName: string;
|
|
1598
|
+
/** Thời điểm khởi tạo Agency, định dạng Unix timestamp tính bằng giây. */
|
|
1599
|
+
created?: number;
|
|
1600
|
+
/** Cấp độ quyền của tài khoản hiện tại trong Agency (ví dụ: 9 = Chủ sở hữu Agency). */
|
|
1601
|
+
accessLevel: number;
|
|
1602
|
+
}
|
|
1603
|
+
/** Lấy danh sách tài khoản hoặc thành viên có quyền truy cập/tạo chiến dịch trên tài khoản quảng cáo hiện tại (dùng cho bộ lọc người tạo hoặc chuyển đổi ngữ cảnh tài khoản). Đây là entry tool thuộc lane zalo-ads-account; hỗ trợ tham số isShowAll (0 hoặc 1) và trả về danh sách personalAccessors, agencyInfo, agencyAccessors. */
|
|
1604
|
+
type ZaloAdsGetApiBaAccountAllaccessorsRequest = {
|
|
1605
|
+
/** Cờ hiển thị toàn bộ danh sách người truy cập (0 = Chỉ hiển thị mặc định/đang hoạt động, 1 = Hiển thị tất cả). Mặc định giao diện Zalo Ads truyền 0. */
|
|
1606
|
+
isShowAll?: 0 | 1 | number;
|
|
1607
|
+
};
|
|
1399
1608
|
type ZaloAdsGetApiBaAccountAllaccessorsResponse = {
|
|
1400
|
-
|
|
1609
|
+
/** Mã kết quả (0 = Thành công). */
|
|
1610
|
+
code: number;
|
|
1611
|
+
/** Thông điệp trạng thái (ví dụ: 'success'). */
|
|
1612
|
+
msg?: string;
|
|
1613
|
+
data: {
|
|
1614
|
+
/** Danh sách thành viên truy cập cấp tài khoản cá nhân (bao gồm chủ tài khoản với accessLevel = 0). */
|
|
1615
|
+
personalAccessors: Array<ZaloAdsAccessorItemDto>;
|
|
1616
|
+
/** Thông tin Agency liên kết (nếu có). */
|
|
1617
|
+
agencyInfo?: ZaloAdsAccountAgencyInfoDto;
|
|
1618
|
+
/** Danh sách thành viên thuộc Agency có quyền truy cập tài khoản khách hàng này (nếu có). */
|
|
1619
|
+
agencyAccessors?: Array<ZaloAdsAccessorItemDto>;
|
|
1620
|
+
};
|
|
1401
1621
|
};
|
|
1402
|
-
|
|
1622
|
+
interface ZaloAdsGrantedMemberItemDto {
|
|
1623
|
+
/** ID định danh của thành viên trên Zalo Ads (ví dụ: 330114198). */
|
|
1624
|
+
memberId: number;
|
|
1625
|
+
/** Tên hiển thị của thành viên. */
|
|
1626
|
+
memberName: string;
|
|
1627
|
+
/** Số điện thoại liên hệ của thành viên (định dạng 84...). */
|
|
1628
|
+
memberPhone?: string;
|
|
1629
|
+
/** URL ảnh đại diện của thành viên. */
|
|
1630
|
+
memberAvatar?: string;
|
|
1631
|
+
/** Cấp độ phân quyền truy cập của thành viên (ví dụ: 1 = Quản trị viên, 2 = Nhà quảng cáo, 3 = Người phân tích/Xem báo cáo). */
|
|
1632
|
+
accessLevel: number;
|
|
1633
|
+
}
|
|
1634
|
+
/** Lấy danh sách toàn bộ thành viên đã được cấp quyền truy cập trong tài khoản quảng cáo cá nhân và Agency hiện tại. Đây là entry tool thuộc lane zalo-ads-account; dùng để kiểm tra thông tin Agency (agencyInfo), danh sách thành viên được cấp quyền cấp cá nhân (personalGrantedAccessMembers) và cấp Agency (agencyGrantedAccessMembers) trước khi phối hợp quản trị. */
|
|
1403
1635
|
type ZaloAdsGetApiBaAccountAllgrantedmembersRequest = Record<string, never>;
|
|
1404
1636
|
type ZaloAdsGetApiBaAccountAllgrantedmembersResponse = {
|
|
1405
|
-
|
|
1637
|
+
/** Mã kết quả (0 = Thành công). */
|
|
1638
|
+
code: number;
|
|
1639
|
+
/** Thông điệp trạng thái (ví dụ: 'success'). */
|
|
1640
|
+
msg?: string;
|
|
1641
|
+
data: {
|
|
1642
|
+
/** Danh sách thành viên được cấp quyền truy cập ở cấp tài khoản cá nhân. */
|
|
1643
|
+
personalGrantedAccessMembers: Array<ZaloAdsGrantedMemberItemDto>;
|
|
1644
|
+
/** Thông tin đơn vị Agency quản lý tài khoản (nếu tài khoản là Agency hoặc thuộc Agency). */
|
|
1645
|
+
agencyInfo?: ZaloAdsAccountAgencyInfoDto;
|
|
1646
|
+
/** Danh sách nhân sự/thành viên thuộc Agency được cấp quyền truy cập. */
|
|
1647
|
+
agencyGrantedAccessMembers: Array<ZaloAdsGrantedMemberItemDto>;
|
|
1648
|
+
};
|
|
1406
1649
|
};
|
|
1407
1650
|
/** Lấy danh sách nguồn hoặc sự kiện chuyển đổi đã cấu hình. Đây là entry tool thuộc lane zalo-ads-conversion; dùng khi chọn conversion để đo lường hoặc tối ưu chiến dịch. */
|
|
1408
1651
|
type ZaloAdsGetApiConversionAllRequest = Record<string, never>;
|
|
1409
1652
|
type ZaloAdsGetApiConversionAllResponse = {
|
|
1410
|
-
|
|
1653
|
+
code: number;
|
|
1654
|
+
msg?: string;
|
|
1655
|
+
data: Array<ZaloAdsConversionItemDto>;
|
|
1411
1656
|
};
|
|
1657
|
+
interface ZaloAdsStandardEventItemDto {
|
|
1658
|
+
id: number;
|
|
1659
|
+
name: string;
|
|
1660
|
+
code?: string;
|
|
1661
|
+
description?: string;
|
|
1662
|
+
}
|
|
1412
1663
|
/** Lấy danh mục sự kiện chuyển đổi chuẩn mà Zalo Ads hỗ trợ. Đây là helper tool thuộc lane zalo-ads-conversion; dùng khi ánh xạ mục tiêu đo lường vào event chuẩn. */
|
|
1413
1664
|
type ZaloAdsGetApiConversionStandardEventsRequest = Record<string, never>;
|
|
1414
1665
|
type ZaloAdsGetApiConversionStandardEventsResponse = {
|
|
1415
|
-
|
|
1666
|
+
code: number;
|
|
1667
|
+
msg?: string;
|
|
1668
|
+
data: Array<ZaloAdsStandardEventItemDto>;
|
|
1416
1669
|
};
|
|
1417
1670
|
/** Lấy danh sách audience tùy chỉnh có thể dùng để nhắm chọn. Đây là entry tool thuộc lane zalo-ads-audience; dùng để chọn, kiểm tra hoặc lấy CustomAudienceId trước khi liên kết hay xóa audience. */
|
|
1418
1671
|
type ZaloAdsGetApiCustomAudienceAllRequest = {
|
|
@@ -1448,15 +1701,57 @@ type ZaloAdsGetApiCustomAudienceAllResponse = {
|
|
|
1448
1701
|
CustomAudienceId: number;
|
|
1449
1702
|
}>;
|
|
1450
1703
|
};
|
|
1704
|
+
interface ZaloAdsFileGroupItemDto {
|
|
1705
|
+
id: number;
|
|
1706
|
+
name: string;
|
|
1707
|
+
memberId?: number;
|
|
1708
|
+
created?: number;
|
|
1709
|
+
totalFiles?: number;
|
|
1710
|
+
}
|
|
1451
1711
|
/** Lấy các nhóm tệp media hiện có trong tài khoản quảng cáo. Đây là entry tool thuộc lane zalo-ads-media; dùng để tìm nơi chứa tài nguyên trước khi chọn ảnh hoặc video. */
|
|
1452
1712
|
type ZaloAdsGetApiFilegroupsRequest = Record<string, never>;
|
|
1453
1713
|
type ZaloAdsGetApiFilegroupsResponse = {
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1714
|
+
code: number;
|
|
1715
|
+
msg?: string;
|
|
1716
|
+
data: Array<ZaloAdsFileGroupItemDto>;
|
|
1717
|
+
};
|
|
1718
|
+
interface ZaloAdsLpNewsButtonDto {
|
|
1719
|
+
/** Nhãn nút (ví dụ: 'Xem thêm', 'Xem ngay', 'Quảng cáo ngay'). */
|
|
1720
|
+
label: string;
|
|
1721
|
+
/** Đường dẫn URL đích khi nhấn nút. */
|
|
1722
|
+
linkUrl: string;
|
|
1723
|
+
/** Loại điều hướng (1 = Mở tab mới, 2 = Route nội bộ). */
|
|
1724
|
+
type: number;
|
|
1725
|
+
/** Cờ bật/tắt hiển thị nút (dùng cho secondaryButton). */
|
|
1726
|
+
isDisplayed?: boolean;
|
|
1727
|
+
}
|
|
1728
|
+
interface ZaloAdsLpNewsItemDto {
|
|
1729
|
+
/** Tiêu đề tin tức/sự kiện. */
|
|
1730
|
+
title: string;
|
|
1731
|
+
/** Mô tả ngắn của tin tức/sự kiện. */
|
|
1732
|
+
description: string;
|
|
1733
|
+
/** URL hình ảnh banner của tin tức. */
|
|
1734
|
+
imageUrl: string;
|
|
1735
|
+
/** Cờ cho biết tin tức có hiển thị trên trang Tổng quan (Dashboard) hay không. */
|
|
1736
|
+
displayOnHomePage?: boolean;
|
|
1737
|
+
/** Cờ cho biết tin tức có hiển thị trên trang chủ Landing Page hay không. */
|
|
1738
|
+
displayOnLandingPage?: boolean;
|
|
1739
|
+
/** Cấu hình nút hành động chính trên Dashboard. */
|
|
1740
|
+
primaryButton?: ZaloAdsLpNewsButtonDto;
|
|
1741
|
+
/** Cấu hình nút hành động phụ trên Dashboard. */
|
|
1742
|
+
secondaryButton?: ZaloAdsLpNewsButtonDto;
|
|
1743
|
+
/** Cấu hình nút hành động hiển thị trên popup Landing Page. */
|
|
1744
|
+
landingPageButton?: ZaloAdsLpNewsButtonDto;
|
|
1745
|
+
}
|
|
1746
|
+
/** Lấy thông tin tin tức/sự kiện nổi bật hiển thị dạng popup nổi (balloon) trên trang chủ Landing Page của Zalo Ads. Đây là entry tool thuộc lane zalo-ads-content; trả về đối tượng tin tức trong data (khi code = 0) hoặc thông báo "Landing page new is empty" (khi code = 1). */
|
|
1457
1747
|
type ZaloAdsGetApiLpNewsRequest = Record<string, never>;
|
|
1458
1748
|
type ZaloAdsGetApiLpNewsResponse = {
|
|
1459
|
-
|
|
1749
|
+
/** Mã trạng thái (0 = Có tin tức trả về trong data, 1 = Không có tin tức nào đang hiển thị trên Landing Page). */
|
|
1750
|
+
code: number;
|
|
1751
|
+
/** Thông báo trạng thái (ví dụ: 'Landing page new is empty' khi code = 1). */
|
|
1752
|
+
msg?: string;
|
|
1753
|
+
/** Chi tiết bài viết/tin tức nổi bật hiển thị trên Landing Page (chỉ có mặt khi code = 0). */
|
|
1754
|
+
data?: ZaloAdsLpNewsItemDto;
|
|
1460
1755
|
};
|
|
1461
1756
|
/** Lấy danh sách ảnh, video hoặc tài nguyên media theo khoảng thời gian. Đây là entry tool thuộc lane zalo-ads-media; dùng khi cần chọn asset đã tải lên cho mẫu quảng cáo. */
|
|
1462
1757
|
type ZaloAdsGetApiMediaItemsRequest = {
|
|
@@ -1484,32 +1779,82 @@ type ZaloAdsGetApiMediaItemsResponse = {
|
|
|
1484
1779
|
CreatedBy: number;
|
|
1485
1780
|
}>;
|
|
1486
1781
|
};
|
|
1782
|
+
interface ZaloAdsMemberFileItemDto {
|
|
1783
|
+
id: number;
|
|
1784
|
+
name: string;
|
|
1785
|
+
fileUrl: string;
|
|
1786
|
+
status?: number;
|
|
1787
|
+
lineNumber?: number;
|
|
1788
|
+
created?: number;
|
|
1789
|
+
memberId?: number;
|
|
1790
|
+
}
|
|
1487
1791
|
/** Lấy các tệp do thành viên hiện tại quản lý trong tài khoản quảng cáo. Đây là entry tool thuộc lane zalo-ads-media; dùng để tra cứu asset theo quyền sở hữu hoặc trạng thái. */
|
|
1488
1792
|
type ZaloAdsGetApiMemberFilesRequest = Record<string, never>;
|
|
1489
1793
|
type ZaloAdsGetApiMemberFilesResponse = {
|
|
1490
|
-
|
|
1794
|
+
code: number;
|
|
1795
|
+
msg?: string;
|
|
1796
|
+
data: Array<ZaloAdsMemberFileItemDto>;
|
|
1491
1797
|
};
|
|
1492
|
-
|
|
1798
|
+
interface ZaloAdsNotifyHeaderItemDto {
|
|
1799
|
+
/** ID định danh của thông báo (ví dụ: 1). */
|
|
1800
|
+
id: number;
|
|
1801
|
+
/** Nội dung chi tiết của thông báo hiển thị trên đầu trang. */
|
|
1802
|
+
text: string;
|
|
1803
|
+
}
|
|
1804
|
+
/** Lấy danh sách thông báo quan trọng hiển thị trên thanh tiêu đề (header announcements) của trình quản lý Zalo Ads. Đây là helper tool thuộc lane zalo-ads-notification; dùng khi cần kiểm tra các cảnh báo hệ thống hoặc nhắc nhở quan tâm OA Hỗ trợ quảng cáo Zalo Ads. */
|
|
1493
1805
|
type ZaloAdsGetApiNotifiesHeaderRequest = Record<string, never>;
|
|
1494
1806
|
type ZaloAdsGetApiNotifiesHeaderResponse = {
|
|
1495
|
-
|
|
1807
|
+
/** Mã kết quả (0 = Thành công). */
|
|
1808
|
+
code: number;
|
|
1809
|
+
/** Thông điệp trạng thái (ví dụ: 'success'). */
|
|
1810
|
+
msg?: string;
|
|
1811
|
+
/** Danh sách các thông báo hiển thị ở đầu trang (header banner). */
|
|
1812
|
+
announcements: Array<ZaloAdsNotifyHeaderItemDto>;
|
|
1496
1813
|
};
|
|
1497
|
-
/** Lấy lịch sử
|
|
1814
|
+
/** Lấy lịch sử nạp tiền (charge/payment transaction history) của tài khoản quảng cáo Zalo Ads trong khoảng thời gian tối đa 31 ngày. Đây là entry tool thuộc lane zalo-ads-billing; dùng khi đối soát các giao dịch nạp tiền, ngân hàng, kênh nạp, trạng thái và xuất hóa đơn theo khoảng thời gian xác định. */
|
|
1498
1815
|
type ZaloAdsGetApiPaymentTransactionHistoryRequest = {
|
|
1499
|
-
/** Mốc kết thúc khoảng
|
|
1816
|
+
/** Mốc thời gian kết thúc khoảng tra cứu, định dạng Unix timestamp tính bằng giây (khoảng cách giữa from và to tối đa 31 ngày). */
|
|
1500
1817
|
to: number;
|
|
1501
|
-
/** Mốc bắt đầu khoảng
|
|
1818
|
+
/** Mốc thời gian bắt đầu khoảng tra cứu, định dạng Unix timestamp tính bằng giây (khoảng cách giữa from và to tối đa 31 ngày). */
|
|
1502
1819
|
from: number;
|
|
1503
|
-
/** ID thành viên cần
|
|
1820
|
+
/** ID tài khoản/thành viên cần tra cứu lịch sử nạp tiền. Truyền 0 để lấy theo tài khoản hiện tại đang đăng nhập hoặc truyền ID thành viên cụ thể (ví dụ: 257887336). */
|
|
1504
1821
|
memberId: number;
|
|
1505
1822
|
};
|
|
1823
|
+
interface ZaloAdsPaymentTransactionItemDto {
|
|
1824
|
+
/** Số tiền nạp (VNĐ), ví dụ: 1000000. */
|
|
1825
|
+
amount: number;
|
|
1826
|
+
/** Tên ngân hàng hoặc nguồn nạp (ví dụ: 'Ngân hàng TMCP Hàng Hải Việt Nam', 'Voucher'). */
|
|
1827
|
+
bankName: string;
|
|
1828
|
+
/** Kênh nạp tiền (ví dụ: 'Chuyển khoản', 'ZaloPay', 'Thẻ ATM', 'Voucher'). */
|
|
1829
|
+
channel: string;
|
|
1830
|
+
/** Nội dung/ghi chú giao dịch nạp tiền. */
|
|
1831
|
+
content: string;
|
|
1832
|
+
/** Thời điểm phát sinh giao dịch nạp tiền, định dạng Unix timestamp tính bằng giây. */
|
|
1833
|
+
date: number;
|
|
1834
|
+
/** ID người hoặc hệ thống thực hiện nạp tiền (ví dụ: 257887336). */
|
|
1835
|
+
createdId: number;
|
|
1836
|
+
/** Tên người hoặc hệ thống thực hiện nạp tiền (ví dụ: 'Zalo Ads'). */
|
|
1837
|
+
createdName: string;
|
|
1838
|
+
/** Tên phụ của đơn vị/người nạp hộ (nếu có). */
|
|
1839
|
+
secondaryName?: string;
|
|
1840
|
+
/** ID tài khoản quảng cáo thụ hưởng số tiền nạp. */
|
|
1841
|
+
memberId: number;
|
|
1842
|
+
/** Cờ đánh dấu giao dịch có xuất hóa đơn (true = Có, false = Không). */
|
|
1843
|
+
receipt: boolean;
|
|
1844
|
+
/** Trạng thái giao dịch nạp tiền (ví dụ: 'Thành công'). */
|
|
1845
|
+
status: string;
|
|
1846
|
+
}
|
|
1506
1847
|
type ZaloAdsGetApiPaymentTransactionHistoryResponse = {
|
|
1507
|
-
/** Mã
|
|
1848
|
+
/** Mã trạng thái phản hồi (0 = Thành công, 1 = Lỗi tham số hoặc vượt quá 31 ngày). */
|
|
1508
1849
|
code: number;
|
|
1509
|
-
/**
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1850
|
+
/** Thông báo trạng thái hoặc chi tiết lỗi từ hệ thống. */
|
|
1851
|
+
msg?: string;
|
|
1852
|
+
/** Danh sách các giao dịch nạp tiền trong khoảng thời gian đã chọn. */
|
|
1853
|
+
data: Array<ZaloAdsPaymentTransactionItemDto>;
|
|
1854
|
+
/** Thông tin bổ sung của tài khoản được tra cứu (khi xem theo memberId). */
|
|
1855
|
+
extend?: {
|
|
1856
|
+
name?: string;
|
|
1857
|
+
};
|
|
1513
1858
|
};
|
|
1514
1859
|
/** Lấy danh mục vùng miền, tỉnh thành và ID quận huyện phục vụ nhắm chọn theo vị trí. Đây là helper tool thuộc lane zalo-ads-targeting; dùng khi xây dựng điều kiện địa lý chi tiết. */
|
|
1515
1860
|
type ZaloAdsGetApiPlaceGetalldistrictsRequest = Record<string, never>;
|
|
@@ -1542,10 +1887,46 @@ type ZaloAdsGetApiPlaceGetalldistrictsResponse = {
|
|
|
1542
1887
|
};
|
|
1543
1888
|
};
|
|
1544
1889
|
};
|
|
1545
|
-
|
|
1546
|
-
|
|
1890
|
+
interface ZaloAdsSpellCheckIssueDto {
|
|
1891
|
+
/** Mã quy tắc lỗi ('111'/'278' = Lỗi chính tả, '113' = Lỗi lạm dụng kí tự, '121' = Lỗi viết hoa, '236'/'237' = Lỗi sử dụng URL/SĐT). */
|
|
1892
|
+
code?: string;
|
|
1893
|
+
/** Nhãn mô tả loại lỗi hiển thị cho người dùng. */
|
|
1894
|
+
label?: string;
|
|
1895
|
+
/** Vị trí ký tự bắt đầu của cụm từ lỗi (0-indexed). */
|
|
1896
|
+
start: number;
|
|
1897
|
+
/** Vị trí ký tự kết thúc của cụm từ lỗi. */
|
|
1898
|
+
end: number;
|
|
1899
|
+
/** Cụm từ gốc bị phát hiện lỗi trong văn bản đầu vào. */
|
|
1900
|
+
originalText: string;
|
|
1901
|
+
/** Cụm từ gợi ý thay thế (chuỗi rỗng nếu gợi ý xóa bỏ). */
|
|
1902
|
+
text: string;
|
|
1903
|
+
/** Cờ đánh dấu gợi ý là xóa bỏ cụm từ lỗi (true khi text rỗng). */
|
|
1904
|
+
isRemoval?: boolean;
|
|
1905
|
+
/** Mã phân loại diff (mặc định: 0). */
|
|
1906
|
+
type?: number;
|
|
1907
|
+
}
|
|
1908
|
+
/** Kiểm tra chính tả và quy định nội dung quảng cáo (viết hoa, lạm dụng ký tự, SĐT/URL) bằng AI cho văn bản quảng cáo (tiêu đề hoặc chú thích). Đây là helper tool thuộc lane zalo-ads-content; bắt buộc truyền query param text và trả về danh sách vị trí lỗi kèm gợi ý chỉnh sửa trong trường data.diffs. */
|
|
1909
|
+
type ZaloAdsGetApiSpellCheckV2Request = {
|
|
1910
|
+
/** Nội dung văn bản cần kiểm tra chính tả và quy chuẩn quảng cáo (ví dụ: tiêu đề hoặc chú thích mẫu quảng cáo). */
|
|
1911
|
+
text: string;
|
|
1912
|
+
};
|
|
1547
1913
|
type ZaloAdsGetApiSpellCheckV2Response = {
|
|
1548
|
-
|
|
1914
|
+
/** Mã kết quả HTTP/API (0 = Thành công). */
|
|
1915
|
+
code: number;
|
|
1916
|
+
/** Thông báo trạng thái (nếu có). */
|
|
1917
|
+
msg?: string;
|
|
1918
|
+
data: {
|
|
1919
|
+
/** UUID định danh phiên yêu cầu AI kiểm tra chính tả (dùng để gắn vào tracking request_ai_id khi lưu quảng cáo). */
|
|
1920
|
+
requestAiId: string;
|
|
1921
|
+
/** Văn bản đầu ra hoàn chỉnh sau khi AI gợi ý chỉnh sửa. */
|
|
1922
|
+
aiOutput: string;
|
|
1923
|
+
/** Thời gian xử lý của AI tính bằng mili giây (ms). */
|
|
1924
|
+
elapsedTime: number;
|
|
1925
|
+
/** Mã trạng thái dịch vụ AI (0 = SUCCESS, -1 = AI_SERVER_FAILURE, -2 = AI_REQUEST_TIMEOUT). */
|
|
1926
|
+
error: number;
|
|
1927
|
+
/** Danh sách các lỗi chính tả hoặc vi phạm quy định từ ngữ phát hiện được trong văn bản. */
|
|
1928
|
+
diffs: Array<ZaloAdsSpellCheckIssueDto>;
|
|
1929
|
+
};
|
|
1549
1930
|
};
|
|
1550
1931
|
/** Lấy thông tin tài khoản Zalo Ads hiện được xác thực, gồm ngân sách, hạn mức và các khả năng được cấp. Đây là auth-sensitive entry tool thuộc lane zalo-ads-account; dùng để xác nhận đúng ngữ cảnh tài khoản trước thao tác khác. Dữ liệu cá nhân, hợp đồng và định danh phiên chỉ được xử lý trong phạm vi được ủy quyền. */
|
|
1551
1932
|
type ZaloAdsGetApiWhoamiRequest = Record<string, never>;
|
|
@@ -1591,6 +1972,21 @@ type ZaloAdsGetApiWhoamiResponse = {
|
|
|
1591
1972
|
usedSimplifiedVersion?: boolean;
|
|
1592
1973
|
canUseMiniPageMessageAd?: boolean;
|
|
1593
1974
|
canUseOptimizeUniversalPixel?: boolean;
|
|
1975
|
+
/** Cho phép dùng kiểm tra chính tả AI (/api/spell-check/v2). */
|
|
1976
|
+
canUseSpellCheck?: boolean;
|
|
1977
|
+
/** Cho phép dùng tính năng tạo nhiều ảnh bằng AI. */
|
|
1978
|
+
canUseMultiImageAi?: boolean;
|
|
1979
|
+
/** Cho phép dùng công cụ tạo video. */
|
|
1980
|
+
canUseVideoCreationTool?: boolean;
|
|
1981
|
+
};
|
|
1982
|
+
/** Thông tin Agency quản lý tài khoản; chỉ xuất hiện khi tài khoản thuộc một Agency. */
|
|
1983
|
+
agencyInfo?: {
|
|
1984
|
+
/** ID Agency. */
|
|
1985
|
+
agencyId?: number;
|
|
1986
|
+
/** Tên Agency. */
|
|
1987
|
+
agencyName?: string;
|
|
1988
|
+
/** Cấp quyền của tài khoản trong Agency (quan sát được: 7, 9). */
|
|
1989
|
+
level?: number;
|
|
1594
1990
|
};
|
|
1595
1991
|
/** Tài khoản gốc liên quan; chứa dữ liệu cá nhân. */
|
|
1596
1992
|
rootMember?: {
|
|
@@ -1623,75 +2019,66 @@ type ZaloAdsGetReportapiV2AdsRequest = {
|
|
|
1623
2019
|
/** Bắt đầu khoảng báo cáo, Unix epoch giây. */
|
|
1624
2020
|
startDate: number;
|
|
1625
2021
|
};
|
|
2022
|
+
interface ZaloAdsAdReportItemDto {
|
|
2023
|
+
/** ID quảng cáo; dùng làm adId cho thao tác chi tiết/cập nhật. */
|
|
2024
|
+
id: number;
|
|
2025
|
+
name: string;
|
|
2026
|
+
/** Mã loại quảng cáo upstream; đã quan sát 28. */
|
|
2027
|
+
adType: number;
|
|
2028
|
+
/** Mã trạng thái. Khi lọc dùng Value chuỗi, ví dụ "3" hoặc "4", trong filter. */
|
|
2029
|
+
status: number;
|
|
2030
|
+
/** Unix epoch giây. */
|
|
2031
|
+
endDate: number;
|
|
2032
|
+
/** URL ảnh bìa. */
|
|
2033
|
+
coverUrl?: string;
|
|
2034
|
+
memberId: number;
|
|
2035
|
+
/** Unix epoch giây. */
|
|
2036
|
+
modified?: number;
|
|
2037
|
+
/** Mã read-only upstream; đã quan sát -1, không phải boolean. */
|
|
2038
|
+
readOnly?: number;
|
|
2039
|
+
viewType?: number;
|
|
2040
|
+
createdBy?: number;
|
|
2041
|
+
/** Unix epoch giây. */
|
|
2042
|
+
startDate: number;
|
|
2043
|
+
/** ID chiến dịch chứa quảng cáo. */
|
|
2044
|
+
campaignId: number;
|
|
2045
|
+
memberName?: string;
|
|
2046
|
+
/** Mã loại giá thầu upstream. */
|
|
2047
|
+
adPriceType?: number;
|
|
2048
|
+
/** Metric động; key là mã chỉ số Zalo Ads. */
|
|
2049
|
+
reportTotal: Record<string, number>;
|
|
2050
|
+
campaignName: string;
|
|
2051
|
+
campaignType?: number;
|
|
2052
|
+
conversionId?: number;
|
|
2053
|
+
reportByDate?: Record<string, Record<string, number>>;
|
|
2054
|
+
reportBySubId?: Record<string, Record<string, number>>;
|
|
2055
|
+
adtimaBookingId?: number;
|
|
2056
|
+
reportTotalByTemplate?: Record<string, Record<string, number>>;
|
|
2057
|
+
reportBySubIdThenByDate?: Record<string, Record<string, Record<string, number>>>;
|
|
2058
|
+
reportByTemplateThenByDate?: Record<string, Record<string, Record<string, number>>>;
|
|
2059
|
+
}
|
|
1626
2060
|
type ZaloAdsGetReportapiV2AdsResponse = {
|
|
1627
2061
|
msg: string;
|
|
1628
2062
|
/** 0 là thành công. */
|
|
1629
2063
|
code: number;
|
|
1630
|
-
data: Array<
|
|
1631
|
-
/** ID quảng cáo; dùng làm adId cho thao tác chi tiết/cập nhật. */
|
|
1632
|
-
id: number;
|
|
1633
|
-
name: string;
|
|
1634
|
-
/** Mã loại quảng cáo upstream; đã quan sát 28. */
|
|
1635
|
-
adType: number;
|
|
1636
|
-
/** Mã trạng thái. Khi lọc dùng Value chuỗi, ví dụ "3" hoặc "4", trong filter. */
|
|
1637
|
-
status: number;
|
|
1638
|
-
/** Unix epoch giây. */
|
|
1639
|
-
endDate: number;
|
|
1640
|
-
/** URL ảnh bìa. */
|
|
1641
|
-
coverUrl?: string;
|
|
1642
|
-
memberId: number;
|
|
1643
|
-
/** Unix epoch giây. */
|
|
1644
|
-
modified?: number;
|
|
1645
|
-
/** Mã read-only upstream; đã quan sát -1, không phải boolean. */
|
|
1646
|
-
readOnly?: number;
|
|
1647
|
-
viewType?: number;
|
|
1648
|
-
createdBy?: number;
|
|
1649
|
-
/** Unix epoch giây. */
|
|
1650
|
-
startDate: number;
|
|
1651
|
-
/** ID chiến dịch chứa quảng cáo. */
|
|
1652
|
-
campaignId: number;
|
|
1653
|
-
memberName?: string;
|
|
1654
|
-
/** Mã loại giá thầu upstream. */
|
|
1655
|
-
adPriceType?: number;
|
|
1656
|
-
/** Metric động; key là mã chỉ số Zalo Ads. */
|
|
1657
|
-
reportTotal: {
|
|
1658
|
-
[key: string]: number;
|
|
1659
|
-
};
|
|
1660
|
-
campaignName: string;
|
|
1661
|
-
campaignType?: number;
|
|
1662
|
-
conversionId?: number;
|
|
1663
|
-
reportByDate?: {
|
|
1664
|
-
[key: string]: {
|
|
1665
|
-
[key: string]: number;
|
|
1666
|
-
};
|
|
1667
|
-
};
|
|
1668
|
-
reportBySubId?: {
|
|
1669
|
-
[key: string]: {
|
|
1670
|
-
[key: string]: number;
|
|
1671
|
-
};
|
|
1672
|
-
};
|
|
1673
|
-
adtimaBookingId?: number;
|
|
1674
|
-
reportTotalByTemplate?: {
|
|
1675
|
-
[key: string]: {
|
|
1676
|
-
[key: string]: number;
|
|
1677
|
-
};
|
|
1678
|
-
};
|
|
1679
|
-
reportBySubIdThenByDate?: {
|
|
1680
|
-
[key: string]: {
|
|
1681
|
-
[key: string]: {
|
|
1682
|
-
[key: string]: number;
|
|
1683
|
-
};
|
|
1684
|
-
};
|
|
1685
|
-
};
|
|
1686
|
-
reportByTemplateThenByDate?: {
|
|
1687
|
-
[key: string]: {
|
|
1688
|
-
[key: string]: {
|
|
1689
|
-
[key: string]: number;
|
|
1690
|
-
};
|
|
1691
|
-
};
|
|
1692
|
-
};
|
|
1693
|
-
}>;
|
|
2064
|
+
data: Array<ZaloAdsAdReportItemDto>;
|
|
1694
2065
|
};
|
|
2066
|
+
interface ZaloAdsCampaignReportItemDto {
|
|
2067
|
+
id: number;
|
|
2068
|
+
name: string;
|
|
2069
|
+
status: number;
|
|
2070
|
+
endDate: number;
|
|
2071
|
+
memberId: number;
|
|
2072
|
+
readOnly: number;
|
|
2073
|
+
viewType: number;
|
|
2074
|
+
startDate: number;
|
|
2075
|
+
memberName?: string;
|
|
2076
|
+
/** Metric động; key là mã chỉ số Zalo Ads. */
|
|
2077
|
+
reportTotal: Record<string, number>;
|
|
2078
|
+
campaignType: number;
|
|
2079
|
+
adtimaCampaignId: number;
|
|
2080
|
+
reportByDate?: Record<string, Record<string, number>>;
|
|
2081
|
+
}
|
|
1695
2082
|
/** Lấy báo cáo chi tiết của một chiến dịch đã biết. Đây là detail tool thuộc lane zalo-ads-reporting; dùng khi đã có campaign ID và cần xem chỉ số hiệu quả của chiến dịch đó. */
|
|
1696
2083
|
type ZaloAdsGetReportapiV2CampaignsRequest = {
|
|
1697
2084
|
/** ID chiến dịch cần xem báo cáo. */
|
|
@@ -1702,15 +2089,33 @@ type ZaloAdsGetReportapiV2CampaignsRequest = {
|
|
|
1702
2089
|
endDate?: number;
|
|
1703
2090
|
/** Mốc làm mới truy vấn, Unix timestamp mili giây. */
|
|
1704
2091
|
refresh?: number | string;
|
|
1705
|
-
[key: string]: unknown;
|
|
1706
2092
|
};
|
|
1707
2093
|
type ZaloAdsGetReportapiV2CampaignsResponse = {
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
2094
|
+
code: number;
|
|
2095
|
+
msg?: string;
|
|
2096
|
+
data: Array<ZaloAdsCampaignReportItemDto>;
|
|
2097
|
+
};
|
|
2098
|
+
interface ZaloAdsUniqueUserReportDataDto {
|
|
2099
|
+
totalUniqueUsers: number;
|
|
2100
|
+
totalReach?: number;
|
|
2101
|
+
frequency?: number;
|
|
2102
|
+
byDate?: Record<string, number>;
|
|
2103
|
+
}
|
|
2104
|
+
/** Lấy thống kê người dùng duy nhất tiếp cận hoặc tương tác với quảng cáo / chiến dịch (GET https://ads.zalo.me/reportapi/v2/unique-user). */
|
|
2105
|
+
type ZaloAdsGetReportapiV2UniqueUserRequest = {
|
|
2106
|
+
start: number;
|
|
2107
|
+
end: number;
|
|
2108
|
+
campaignId?: number | string;
|
|
2109
|
+
adId?: number | string;
|
|
2110
|
+
};
|
|
1712
2111
|
type ZaloAdsGetReportapiV2UniqueUserResponse = {
|
|
1713
|
-
|
|
2112
|
+
code: number;
|
|
2113
|
+
msg?: string;
|
|
2114
|
+
data: number;
|
|
2115
|
+
extend?: Array<{
|
|
2116
|
+
adId: number;
|
|
2117
|
+
count: number;
|
|
2118
|
+
}>;
|
|
1714
2119
|
};
|
|
1715
2120
|
/** Lấy báo cáo hiệu quả campaign theo phiên bản dữ liệu báo cáo v3. Đây là entry tool thuộc lane zalo-ads-reporting; dùng khi cần tổng hợp hoặc so sánh chỉ số nhiều chiến dịch trong một khoảng thời gian. */
|
|
1716
2121
|
type ZaloAdsGetReportapiV3CampaignsRequest = {
|
|
@@ -1730,130 +2135,181 @@ type ZaloAdsGetReportapiV3CampaignsRequest = {
|
|
|
1730
2135
|
type ZaloAdsGetReportapiV3CampaignsResponse = {
|
|
1731
2136
|
msg: string;
|
|
1732
2137
|
code: number;
|
|
1733
|
-
data: Array<
|
|
1734
|
-
id: number;
|
|
1735
|
-
name: string;
|
|
1736
|
-
status: number;
|
|
1737
|
-
endDate: number;
|
|
1738
|
-
memberId: number;
|
|
1739
|
-
readOnly: number;
|
|
1740
|
-
viewType: number;
|
|
1741
|
-
startDate: number;
|
|
1742
|
-
memberName?: string;
|
|
1743
|
-
/** Metric động; key là mã chỉ số Zalo Ads. */
|
|
1744
|
-
reportTotal: {
|
|
1745
|
-
[key: string]: number;
|
|
1746
|
-
};
|
|
1747
|
-
campaignType: number;
|
|
1748
|
-
adtimaCampaignId: number;
|
|
1749
|
-
}>;
|
|
2138
|
+
data: Array<ZaloAdsCampaignReportItemDto>;
|
|
1750
2139
|
};
|
|
1751
|
-
|
|
2140
|
+
interface ZaloAdsZaapiCampaignReportItemDto {
|
|
2141
|
+
AdId: number;
|
|
2142
|
+
AdName: string;
|
|
2143
|
+
CampaignId: number;
|
|
2144
|
+
CampaignName: string;
|
|
2145
|
+
CampaignType: number;
|
|
2146
|
+
Date: number;
|
|
2147
|
+
Cost: number;
|
|
2148
|
+
Quantity: number;
|
|
2149
|
+
}
|
|
2150
|
+
/** Lấy báo cáo hiệu quả của campaign theo dữ liệu vận hành Zalo Ads (GET https://ads.zalo.me/zaapi/Campaign/reportCampaign). */
|
|
1752
2151
|
type ZaloAdsGetZaapiCampaignReportcampaignRequest = {
|
|
1753
|
-
campaignId
|
|
2152
|
+
campaignId: number | string;
|
|
2153
|
+
from: number;
|
|
2154
|
+
to: number;
|
|
1754
2155
|
campId?: number | string;
|
|
1755
|
-
[key: string]: unknown;
|
|
1756
2156
|
};
|
|
1757
2157
|
type ZaloAdsGetZaapiCampaignReportcampaignResponse = {
|
|
1758
|
-
|
|
2158
|
+
code: number;
|
|
2159
|
+
msg?: string;
|
|
2160
|
+
data?: Array<ZaloAdsZaapiCampaignReportItemDto>;
|
|
1759
2161
|
};
|
|
1760
2162
|
/** Kiểm tra một chiến dịch có chứa nhiều quảng cáo hay không. Đây là helper tool thuộc lane zalo-ads-campaign; dùng trước khi chọn luồng xem hoặc cập nhật quảng cáo trong campaign. */
|
|
1761
2163
|
type ZaloAdsGetZaapiCheckcamphasmanyadsRequest = {
|
|
1762
2164
|
campaignId?: number | string;
|
|
1763
2165
|
campId?: number | string;
|
|
1764
|
-
[key: string]: unknown;
|
|
1765
2166
|
};
|
|
1766
2167
|
type ZaloAdsGetZaapiCheckcamphasmanyadsResponse = {
|
|
1767
|
-
|
|
2168
|
+
code: number;
|
|
2169
|
+
msg?: string;
|
|
2170
|
+
data: boolean | number;
|
|
1768
2171
|
};
|
|
1769
2172
|
/** Lấy danh sách quảng cáo thuộc một chiến dịch. Đây là entry tool thuộc lane zalo-ads-ad; dùng khi đã có campaign ID và cần chọn quảng cáo để xem hoặc chỉnh sửa. */
|
|
1770
2173
|
type ZaloAdsGetZaapiGetadsfromcampaignidRequest = {
|
|
1771
2174
|
campaignId?: number | string;
|
|
1772
2175
|
campId?: number | string;
|
|
1773
|
-
[key: string]: unknown;
|
|
1774
2176
|
};
|
|
1775
2177
|
type ZaloAdsGetZaapiGetadsfromcampaignidResponse = {
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
2178
|
+
code: number;
|
|
2179
|
+
msg?: string;
|
|
2180
|
+
data: Array<ZaloAdsAdUpdatePayloadDto>;
|
|
2181
|
+
};
|
|
2182
|
+
interface ZaloAdsPageConfigDto {
|
|
2183
|
+
/** Hạng tài khoản OA (ví dụ: 0 = Phổ thông, 1 = Xác thực/Nâng cao). */
|
|
2184
|
+
tier?: number;
|
|
2185
|
+
viewStatus?: number;
|
|
2186
|
+
isVerified?: boolean;
|
|
2187
|
+
allowMessage?: boolean;
|
|
2188
|
+
}
|
|
2189
|
+
/** Một địa điểm trong `extraInfo.locations` của OA (quan sát trên 67 địa điểm của 64 OA). */
|
|
2190
|
+
interface ZaloAdsOwnedPageLocationDto {
|
|
2191
|
+
/** Địa chỉ đầy đủ. */
|
|
2192
|
+
address: string;
|
|
2193
|
+
/** Mã tỉnh/thành. */
|
|
2194
|
+
provinceId: number;
|
|
2195
|
+
/** Mã quận/huyện; chỉ có ở 64/67 địa điểm quan sát được. */
|
|
2196
|
+
districtId?: number;
|
|
2197
|
+
/** Vĩ độ. */
|
|
2198
|
+
lat: number;
|
|
2199
|
+
/** Kinh độ. */
|
|
2200
|
+
lng: number;
|
|
2201
|
+
}
|
|
2202
|
+
/** Cấu trúc của chuỗi JSON `extraInfo` sau khi `JSON.parse`. Dữ liệu cá nhân, chỉ xử lý trong phạm vi được ủy quyền. */
|
|
2203
|
+
interface ZaloAdsOwnedPageExtraInfoDto {
|
|
2204
|
+
website: string | null;
|
|
2205
|
+
contactName: string;
|
|
2206
|
+
hotline: string | null;
|
|
2207
|
+
workingTime: string | null;
|
|
2208
|
+
/** Số điện thoại liên hệ dạng quốc tế, ví dụ "84384473007". */
|
|
2209
|
+
contactPhone: string;
|
|
2210
|
+
locations: Array<ZaloAdsOwnedPageLocationDto>;
|
|
2211
|
+
}
|
|
2212
|
+
interface ZaloAdsOwnedPageItemDto {
|
|
2213
|
+
/** ID nội bộ page/OA (trùng với pageId, ví dụ: 429753475). */
|
|
2214
|
+
id: number;
|
|
2215
|
+
/** Tên danh mục ngành nghề, khi có. */
|
|
2216
|
+
cate?: string;
|
|
2217
|
+
/** Tên page/OA. */
|
|
2218
|
+
name: string;
|
|
2219
|
+
/** Loại page/OA (ví dụ: 2 = Doanh nghiệp/Cửa hàng). */
|
|
2220
|
+
type: number;
|
|
2221
|
+
/** Cờ store (0 hoặc 1). */
|
|
2222
|
+
store?: number;
|
|
2223
|
+
/** Cấu hình phân hạng page/OA thay đổi theo loại. */
|
|
2224
|
+
config?: ZaloAdsPageConfigDto;
|
|
2225
|
+
/** ID nội bộ của page/OA dùng trong các API Zalo Ads như tạo chiến dịch (/zaapi/addNewCamp) hoặc lấy danh sách bài viết (/zaapi/getOwnedArticles). */
|
|
2226
|
+
pageId: number;
|
|
2227
|
+
/** Trạng thái hoạt động page/OA (ví dụ: 1 = Đang hoạt động). */
|
|
2228
|
+
status: number;
|
|
2229
|
+
/** Các ID danh mục ngành nghề (ví dụ: [10018]). */
|
|
2230
|
+
cateIds?: Array<number>;
|
|
2231
|
+
/** ID chủ sở hữu, chỉ xử lý trong phạm vi được ủy quyền. */
|
|
2232
|
+
ownerId?: number;
|
|
2233
|
+
configAd?: {
|
|
2234
|
+
/** Trạng thái hiển thị quảng cáo (ví dụ: 1 = Cho phép). */
|
|
2235
|
+
viewStatus?: number;
|
|
2236
|
+
};
|
|
2237
|
+
/** URL ảnh bìa, khi có. */
|
|
2238
|
+
coverUrl?: string;
|
|
2239
|
+
/** Mã định danh OA làm nhiễu dạng chuỗi số dài (trùng với pageIdNoised). */
|
|
2240
|
+
noisedId?: string;
|
|
2241
|
+
/** Tên hiển thị page/OA. */
|
|
2242
|
+
pageName: string;
|
|
2243
|
+
/** URL ảnh đại diện, khi có. */
|
|
2244
|
+
avatarUrl?: string;
|
|
2245
|
+
/** Cho biết OA đã chứng thực tích vàng (true) hay chưa (false). */
|
|
2246
|
+
certified?: boolean;
|
|
2247
|
+
/** Chuỗi JSON chứa thông tin liên hệ (website, contactName, hotline, contactPhone, workingTime) và danh sách vị trí (locations), khi có. */
|
|
2248
|
+
extraInfo?: string;
|
|
2249
|
+
/** Trạng thái vận hành page/OA (ví dụ: 1 = Hoạt động bình thường). */
|
|
2250
|
+
pageStatus: number;
|
|
2251
|
+
/** Thời điểm tạo dạng Unix timestamp mili giây. */
|
|
2252
|
+
createdTime?: number;
|
|
2253
|
+
/** Mô tả page/OA, khi có. */
|
|
2254
|
+
description?: string;
|
|
2255
|
+
/** Thời điểm cập nhật dạng Unix timestamp mili giây. */
|
|
2256
|
+
updatedTime?: number;
|
|
2257
|
+
/** Mã định danh OA công khai/làm nhiễu dạng chuỗi số dài (ví dụ: '305001418732969574'), dùng làm oaId trong các API Instant Pages, Zalo Forms và Message Flows. */
|
|
2258
|
+
pageIdNoised?: string;
|
|
2259
|
+
}
|
|
2260
|
+
/** Lấy danh sách tất cả Zalo Official Account hoặc trang có thể sử dụng. Đây là entry tool thuộc lane zalo-ads-page; dùng khi cần chọn page/OA trước khi tạo chiến dịch hoặc lấy bài viết OA. */
|
|
1779
2261
|
type ZaloAdsGetZaapiGetallpagesRequest = Record<string, never>;
|
|
1780
2262
|
type ZaloAdsGetZaapiGetallpagesResponse = {
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
2263
|
+
code: number;
|
|
2264
|
+
msg?: string;
|
|
2265
|
+
data: Array<ZaloAdsOwnedPageItemDto>;
|
|
2266
|
+
};
|
|
2267
|
+
interface ZaloAdsOwnedArticleItemDto {
|
|
2268
|
+
/** Mã định danh nội bộ của bài viết (ví dụ: 17050656), dùng để truyền vào trường articleId khi tạo chiến dịch Quảng cáo Bài viết (campaignType = 4) hoặc ZaloFeedId khi cập nhật quảng cáo. */
|
|
2269
|
+
articleId: number;
|
|
2270
|
+
/** ID nội bộ của trang Zalo Official Account sở hữu bài viết (ví dụ: 429753475). */
|
|
2271
|
+
pageId: number;
|
|
2272
|
+
/** Tiêu đề của bài viết. */
|
|
2273
|
+
title: string;
|
|
2274
|
+
/** Đoạn mô tả tóm tắt (sapo) của bài viết. */
|
|
2275
|
+
description?: string;
|
|
2276
|
+
/** Đường dẫn URL công khai để xem bài viết trên Zalo OA (ví dụ: 'https://post.oa.zalo.me/d?id=...&pageId=...'). */
|
|
2277
|
+
viewUrl: string;
|
|
2278
|
+
/** URL ảnh đại diện thu nhỏ (thumbnail) của bài viết. */
|
|
2279
|
+
thumbnail?: string;
|
|
2280
|
+
/** Tổng số lượt xem bài viết. */
|
|
2281
|
+
numViews?: number;
|
|
2282
|
+
/** Tổng số lượt chia sẻ bài viết. */
|
|
2283
|
+
numShares?: number;
|
|
2284
|
+
/** Cờ đánh dấu bài viết định dạng video (true) hay bài viết thông thường (false). */
|
|
2285
|
+
isVideoArticle: boolean;
|
|
2286
|
+
}
|
|
2287
|
+
/** Lấy danh sách các bài viết đã xuất bản thuộc một trang Zalo Official Account (OA) cụ thể theo mã pageId nội bộ. Đây là entry tool thuộc lane zalo-ads-content / zalo-ads-article; dùng khi chọn bài viết nguồn cho quảng cáo bài viết (campaignType = 4). */
|
|
1784
2288
|
type ZaloAdsGetZaapiGetownedarticlesRequest = {
|
|
1785
|
-
pageId
|
|
1786
|
-
|
|
1787
|
-
[key: string]: unknown;
|
|
2289
|
+
/** ID nội bộ của trang Zalo Official Account (trường pageId hoặc id kiểu số nguyên lấy từ getZaapiGetownedpages / getZaapiGetallpages, ví dụ: 429753475). Không truyền pageIdNoised. */
|
|
2290
|
+
pageId: number | string;
|
|
1788
2291
|
};
|
|
1789
2292
|
type ZaloAdsGetZaapiGetownedarticlesResponse = {
|
|
1790
|
-
|
|
2293
|
+
code: number;
|
|
2294
|
+
msg?: string;
|
|
2295
|
+
data: Array<ZaloAdsOwnedArticleItemDto>;
|
|
1791
2296
|
};
|
|
1792
|
-
/** Lấy các OA do tài khoản hiện tại sở hữu hoặc quản lý. Đây là entry tool thuộc lane zalo-ads-page; dùng để lấy page ID hợp lệ trước khi cấu hình campaign. */
|
|
2297
|
+
/** Lấy các OA do tài khoản hiện tại sở hữu hoặc quản lý. Đây là entry tool thuộc lane zalo-ads-page; dùng để lấy page ID hợp lệ trước khi cấu hình campaign hoặc lấy bài viết OA. */
|
|
1793
2298
|
type ZaloAdsGetZaapiGetownedpagesRequest = Record<string, never>;
|
|
1794
2299
|
type ZaloAdsGetZaapiGetownedpagesResponse = {
|
|
1795
2300
|
/** Mã kết quả; 0 biểu thị thành công trong phản hồi đã quan sát. */
|
|
1796
2301
|
code: number;
|
|
1797
2302
|
/** Danh sách page/OA. */
|
|
1798
|
-
data: Array<
|
|
1799
|
-
/** ID nội bộ page/OA. */
|
|
1800
|
-
id: number;
|
|
1801
|
-
/** Tên danh mục, khi có. */
|
|
1802
|
-
cate?: string;
|
|
1803
|
-
/** Tên page/OA. */
|
|
1804
|
-
name: string;
|
|
1805
|
-
/** Loại page/OA. */
|
|
1806
|
-
type: number;
|
|
1807
|
-
/** Cờ store. */
|
|
1808
|
-
store?: number;
|
|
1809
|
-
/** Cấu hình page/OA thay đổi theo loại. */
|
|
1810
|
-
config?: {
|
|
1811
|
-
[key: string]: unknown;
|
|
1812
|
-
};
|
|
1813
|
-
/** ID page/OA dùng trong các API Zalo Ads. */
|
|
1814
|
-
pageId: number;
|
|
1815
|
-
/** Trạng thái page/OA. */
|
|
1816
|
-
status: number;
|
|
1817
|
-
/** Các ID danh mục. */
|
|
1818
|
-
cateIds?: Array<number>;
|
|
1819
|
-
/** ID chủ sở hữu, chỉ xử lý trong phạm vi được ủy quyền. */
|
|
1820
|
-
ownerId?: number;
|
|
1821
|
-
configAd?: {
|
|
1822
|
-
/** Trạng thái hiển thị quảng cáo. */
|
|
1823
|
-
viewStatus?: number;
|
|
1824
|
-
};
|
|
1825
|
-
/** URL ảnh bìa, khi có. */
|
|
1826
|
-
coverUrl?: string;
|
|
1827
|
-
/** ID làm nhiễu, khi API trả về. */
|
|
1828
|
-
noisedId?: string;
|
|
1829
|
-
/** Tên hiển thị page/OA. */
|
|
1830
|
-
pageName: string;
|
|
1831
|
-
/** URL ảnh đại diện, khi có. */
|
|
1832
|
-
avatarUrl?: string;
|
|
1833
|
-
/** Cho biết OA đã chứng thực hay chưa. */
|
|
1834
|
-
certified?: boolean;
|
|
1835
|
-
/** Chuỗi JSON chứa thông tin liên hệ và vị trí, khi có; có thể là dữ liệu cá nhân. */
|
|
1836
|
-
extraInfo?: string;
|
|
1837
|
-
/** Trạng thái vận hành page/OA. */
|
|
1838
|
-
pageStatus: number;
|
|
1839
|
-
/** Thời điểm tạo dạng Unix timestamp mili giây. */
|
|
1840
|
-
createdTime?: number;
|
|
1841
|
-
/** Mô tả page/OA, khi có. */
|
|
1842
|
-
description?: string;
|
|
1843
|
-
/** Thời điểm cập nhật dạng Unix timestamp mili giây. */
|
|
1844
|
-
updatedTime?: number;
|
|
1845
|
-
/** ID làm nhiễu của page/OA, khi API trả về. */
|
|
1846
|
-
pageIdNoised?: string;
|
|
1847
|
-
}>;
|
|
2303
|
+
data: Array<ZaloAdsOwnedPageItemDto>;
|
|
1848
2304
|
};
|
|
1849
2305
|
/** Lấy khách hàng thuộc agency cùng ngân sách, hạn mức và trạng thái truy cập. Đây là auth-sensitive entry tool thuộc lane zalo-ads-agency; dùng khi cần đối soát danh sách khách hàng hoặc hạn mức theo agency. Dữ liệu định danh và số điện thoại thành viên chỉ được xử lý trong phạm vi được ủy quyền. */
|
|
1850
2306
|
type ZaloAdsListAgencyCustomersWithBudgetRequest = {
|
|
1851
|
-
/** Số khách hàng tối đa mỗi lần lấy. */
|
|
1852
|
-
limit
|
|
1853
|
-
/** Vị trí bắt đầu để phân trang, gốc 0. */
|
|
1854
|
-
offset
|
|
1855
|
-
/** Sắp xếp ngày tham gia tăng dần khi là true. */
|
|
1856
|
-
joinDateAsc
|
|
2307
|
+
/** Số khách hàng tối đa mỗi lần lấy (mặc định: 15). */
|
|
2308
|
+
limit?: number;
|
|
2309
|
+
/** Vị trí bắt đầu để phân trang, gốc 0 (mặc định: 0). */
|
|
2310
|
+
offset?: number;
|
|
2311
|
+
/** Sắp xếp ngày tham gia tăng dần khi là true (mặc định: true). */
|
|
2312
|
+
joinDateAsc?: boolean;
|
|
1857
2313
|
};
|
|
1858
2314
|
type ZaloAdsListAgencyCustomersWithBudgetResponse = {
|
|
1859
2315
|
/** Thông điệp kết quả. */
|
|
@@ -1968,9 +2424,7 @@ type ZaloAdsListFormsByOfficialAccountResponse = {
|
|
|
1968
2424
|
/** Trạng thái mở rộng section. */
|
|
1969
2425
|
expand: boolean;
|
|
1970
2426
|
/** Nội dung section thay đổi theo type, ví dụ images, videos hoặc table. */
|
|
1971
|
-
content:
|
|
1972
|
-
[key: string]: unknown;
|
|
1973
|
-
};
|
|
2427
|
+
content: ZaloAdsFormSectionContentDto;
|
|
1974
2428
|
/** Cho biết section bị vô hiệu hóa hay không. */
|
|
1975
2429
|
disable: boolean;
|
|
1976
2430
|
}>;
|
|
@@ -2004,7 +2458,9 @@ type ZaloAdsListFormsByOfficialAccountResponse = {
|
|
|
2004
2458
|
updatedAt?: number;
|
|
2005
2459
|
/** Các điều kiện bổ sung, khi có. */
|
|
2006
2460
|
conditions?: Array<{
|
|
2007
|
-
|
|
2461
|
+
field?: string;
|
|
2462
|
+
operator?: string;
|
|
2463
|
+
value?: string | number;
|
|
2008
2464
|
}>;
|
|
2009
2465
|
/** URL ảnh bìa, khi có. */
|
|
2010
2466
|
coverPhoto?: string;
|
|
@@ -2018,7 +2474,8 @@ type ZaloAdsListFormsByOfficialAccountResponse = {
|
|
|
2018
2474
|
gotoActionType?: number;
|
|
2019
2475
|
/** Nhóm câu hỏi, khi có. */
|
|
2020
2476
|
groupQuestions?: Array<{
|
|
2021
|
-
|
|
2477
|
+
groupIdx?: number;
|
|
2478
|
+
title?: string;
|
|
2022
2479
|
}>;
|
|
2023
2480
|
/** Cờ widget đồng ý OA. */
|
|
2024
2481
|
oaConsentWidget?: boolean;
|
|
@@ -2117,34 +2574,50 @@ type ZaloAdsPostApiAdEstimateaudienceResponse = {
|
|
|
2117
2574
|
};
|
|
2118
2575
|
};
|
|
2119
2576
|
};
|
|
2577
|
+
interface ZaloAdsMediaSaveSettingsDto {
|
|
2578
|
+
Url: string;
|
|
2579
|
+
Width: number;
|
|
2580
|
+
Height: number;
|
|
2581
|
+
Duration?: number;
|
|
2582
|
+
ThumbUrl?: string;
|
|
2583
|
+
}
|
|
2584
|
+
interface ZaloAdsMediaSavePayloadDto {
|
|
2585
|
+
Name: string;
|
|
2586
|
+
Type: number;
|
|
2587
|
+
Settings: ZaloAdsMediaSaveSettingsDto;
|
|
2588
|
+
}
|
|
2120
2589
|
/** Lưu tài nguyên media vào thư viện Zalo Ads sau khi đã có URL ảnh hoặc video và metadata kích thước. Đây là mutation tool thuộc lane zalo-ads-media; dùng sau bước upload để nhận MediaId cho cấu hình quảng cáo. */
|
|
2121
2590
|
type ZaloAdsPostApiMediaSaveRequest = {
|
|
2122
|
-
/** Chuỗi JSON media gồm Name (tên), Type (loại) và Settings với Url, Width, Height. Form-urlencoded field name là data. */
|
|
2123
|
-
data: string;
|
|
2591
|
+
/** Chuỗi JSON hoặc object media gồm Name (tên), Type (loại) và Settings với Url, Width, Height. Form-urlencoded field name là data. */
|
|
2592
|
+
data: ZaloAdsMediaSavePayloadDto | string;
|
|
2124
2593
|
};
|
|
2125
2594
|
type ZaloAdsPostApiMediaSaveResponse = {
|
|
2126
2595
|
code: number;
|
|
2127
2596
|
/** ID media vừa được lưu. */
|
|
2128
2597
|
data: number;
|
|
2129
2598
|
};
|
|
2130
|
-
/** Tải ảnh lên kho media của tài khoản quảng cáo. Đây là mutation tool thuộc lane zalo-ads-media; dùng khi cần tạo asset ảnh trước bước cấu hình quảng cáo.
|
|
2599
|
+
/** Tải ảnh lên kho media của tài khoản quảng cáo (`POST /api/member/upload-image`). Đây là mutation tool thuộc lane zalo-ads-media; dùng khi cần tạo asset ảnh trước bước cấu hình quảng cáo. Đã xác minh thực tế trên Zalo Ads sử dụng trường multipart `File` (chữ hoa). */
|
|
2131
2600
|
type ZaloAdsPostApiMemberUploadImageRequest = {
|
|
2132
|
-
/** Tệp ảnh cần tải lên
|
|
2133
|
-
|
|
2601
|
+
/** Tệp ảnh cần tải lên (URL HTTP/HTTPS, đường dẫn file local trong Node.js, hoặc Blob/Uint8Array). */
|
|
2602
|
+
File?: FileInput;
|
|
2603
|
+
/** Alias tương thích ngược cho `File` (service tự ánh xạ sang `File`). */
|
|
2604
|
+
file?: FileInput;
|
|
2134
2605
|
};
|
|
2135
2606
|
type ZaloAdsPostApiMemberUploadImageResponse = {
|
|
2136
2607
|
/** Mã kết quả; 0 biểu thị thành công trong phản hồi đã quan sát. */
|
|
2137
2608
|
code: number;
|
|
2138
2609
|
/** URL ảnh do Zalo Ads trả về. */
|
|
2139
2610
|
data: string;
|
|
2611
|
+
msg?: string;
|
|
2140
2612
|
};
|
|
2141
2613
|
/** Xóa hoặc gỡ một quảng cáo đã chọn khỏi Zalo Ads. Đây là mutation tool thuộc lane zalo-ads-ad; chỉ dùng khi đã xác nhận đúng quảng cáo cần xóa. */
|
|
2142
2614
|
type ZaloAdsPostZaapiDeleteadRequest = {
|
|
2143
2615
|
adId?: number | string;
|
|
2144
|
-
[key: string]: unknown;
|
|
2145
2616
|
};
|
|
2146
2617
|
type ZaloAdsPostZaapiDeleteadResponse = {
|
|
2147
|
-
|
|
2618
|
+
code: number;
|
|
2619
|
+
msg: string;
|
|
2620
|
+
data?: number | boolean;
|
|
2148
2621
|
};
|
|
2149
2622
|
/** Đổi tên hiển thị của một chiến dịch Zalo Ads đã tồn tại. Đây là mutation tool thuộc lane quản lý chiến dịch; dùng khi chỉ cần thay tên mà không thay đổi ngân sách, lịch chạy hoặc quảng cáo bên trong. Kết quả chỉ xác nhận thao tác thành công hoặc trả lỗi từ Zalo Ads. */
|
|
2150
2623
|
type ZaloAdsRenameCampaignRequest = {
|
|
@@ -2164,26 +2637,26 @@ type ZaloAdsUpdateEcommerceAdRequest = {
|
|
|
2164
2637
|
est?: string;
|
|
2165
2638
|
stt?: number | string;
|
|
2166
2639
|
/** Payload cập nhật quảng cáo E-commerce / Commerce (object hoặc chuỗi JSON). */
|
|
2167
|
-
data:
|
|
2640
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2168
2641
|
isBoostAd?: number | string;
|
|
2169
2642
|
};
|
|
2170
2643
|
type ZaloAdsUpdateEcommerceAdResponse = {
|
|
2171
2644
|
msg: string;
|
|
2172
2645
|
code: number;
|
|
2173
|
-
data?:
|
|
2646
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2174
2647
|
};
|
|
2175
2648
|
/** Cập nhật quảng cáo biểu mẫu (Form) đang có trên Zalo Ads (Type = 18). */
|
|
2176
2649
|
type ZaloAdsUpdateFormAdRequest = {
|
|
2177
2650
|
est?: string;
|
|
2178
2651
|
stt?: number | string;
|
|
2179
2652
|
/** Payload cập nhật quảng cáo biểu mẫu (object hoặc chuỗi JSON). */
|
|
2180
|
-
data:
|
|
2653
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2181
2654
|
isBoostAd?: number | string;
|
|
2182
2655
|
};
|
|
2183
2656
|
type ZaloAdsUpdateFormAdResponse = {
|
|
2184
2657
|
msg: string;
|
|
2185
2658
|
code: number;
|
|
2186
|
-
data?:
|
|
2659
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2187
2660
|
};
|
|
2188
2661
|
/** Cấu hình đầy đủ của quảng cáo Tin nhắn. Giữ lại các trường hệ thống lấy từ getAdById khi cập nhật. */
|
|
2189
2662
|
declare class ZaloAdsMessageAdUpdateDataDto {
|
|
@@ -2195,23 +2668,7 @@ declare class ZaloAdsMessageAdUpdateDataDto {
|
|
|
2195
2668
|
AdName: string;
|
|
2196
2669
|
/** 20 (hoặc 19) là quảng cáo Tin nhắn. */
|
|
2197
2670
|
Type: number;
|
|
2198
|
-
Settings:
|
|
2199
|
-
Image: Record<string, unknown>;
|
|
2200
|
-
Price: {
|
|
2201
|
-
Bid: number;
|
|
2202
|
-
Type: number;
|
|
2203
|
-
Limit: number;
|
|
2204
|
-
LimitType: number;
|
|
2205
|
-
SpendingMethod: number;
|
|
2206
|
-
};
|
|
2207
|
-
AdInfo: Record<string, unknown>;
|
|
2208
|
-
AppInfo: Record<string, unknown>;
|
|
2209
|
-
Targeting: Record<string, unknown>;
|
|
2210
|
-
Rating?: number;
|
|
2211
|
-
NewFeatures?: unknown[];
|
|
2212
|
-
CreatedClientVersion?: number;
|
|
2213
|
-
[key: string]: unknown;
|
|
2214
|
-
};
|
|
2671
|
+
Settings: ZaloAdsAdSettingsDto;
|
|
2215
2672
|
Status: number;
|
|
2216
2673
|
StartDate: number;
|
|
2217
2674
|
EndDate: number;
|
|
@@ -2221,12 +2678,11 @@ declare class ZaloAdsMessageAdUpdateDataDto {
|
|
|
2221
2678
|
ZaloFormId?: string;
|
|
2222
2679
|
ConversionId?: number;
|
|
2223
2680
|
Report?: Record<string, number>;
|
|
2224
|
-
[key: string]: unknown;
|
|
2225
2681
|
}
|
|
2226
2682
|
/** Cập nhật quảng cáo Tin nhắn. Service tự JSON.stringify data rồi gửi form-urlencoded. */
|
|
2227
2683
|
declare class ZaloAdsUpdateMessageAdRequest {
|
|
2228
2684
|
/** Payload quảng cáo đầy đủ (object hoặc chuỗi JSON); service tự tuần tự hóa thành field form data. */
|
|
2229
|
-
data: ZaloAdsMessageAdUpdateDataDto |
|
|
2685
|
+
data: ZaloAdsMessageAdUpdateDataDto | ZaloAdsAdUpdatePayloadDto | string;
|
|
2230
2686
|
/** Tham số UI phụ trợ; capture Zalo Ads có giá trị literal "undefined". */
|
|
2231
2687
|
est?: string;
|
|
2232
2688
|
/** 0 là quảng cáo thông thường, 1 là boost ad. */
|
|
@@ -2237,7 +2693,7 @@ declare class ZaloAdsUpdateMessageAdRequest {
|
|
|
2237
2693
|
declare class ZaloAdsUpdateMessageAdResponse {
|
|
2238
2694
|
msg: string;
|
|
2239
2695
|
code: number;
|
|
2240
|
-
data?:
|
|
2696
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2241
2697
|
}
|
|
2242
2698
|
/** Tải ảnh và thiết lập vùng crop để tạo asset dùng cho quảng cáo Zalo Ads (`POST /zaapi/UploadCrop`). Đây là mutation tool thuộc lane zalo-ads-media; dùng trước khi đưa URL asset kết quả vào quảng cáo Display. Cần có URL ảnh nguồn và đầy đủ x, y, width, height, scale; dùng toàn bộ 0 cùng scale 1 khi không crop. */
|
|
2243
2699
|
type ZaloAdsUpdateNewAdsRequest = {
|
|
@@ -2255,41 +2711,40 @@ type ZaloAdsUpdateNewAdsRequest = {
|
|
|
2255
2711
|
scale: number;
|
|
2256
2712
|
};
|
|
2257
2713
|
type ZaloAdsUpdateNewAdsResponse = {
|
|
2258
|
-
code
|
|
2714
|
+
code: number;
|
|
2259
2715
|
msg?: string;
|
|
2260
|
-
data?:
|
|
2261
|
-
[key: string]: unknown;
|
|
2716
|
+
data?: string;
|
|
2262
2717
|
};
|
|
2263
2718
|
/** Cập nhật quảng cáo Zalo Official Account hiện có (Type = 2 hoặc 10). */
|
|
2264
2719
|
type ZaloAdsUpdateOfficialAccountAdRequest = {
|
|
2265
2720
|
est?: string;
|
|
2266
2721
|
stt?: number | string;
|
|
2267
2722
|
/** Payload cập nhật quảng cáo Official Account (object hoặc chuỗi JSON). */
|
|
2268
|
-
data:
|
|
2723
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2269
2724
|
isBoostAd?: number | string;
|
|
2270
2725
|
};
|
|
2271
2726
|
type ZaloAdsUpdateOfficialAccountAdResponse = {
|
|
2272
2727
|
msg: string;
|
|
2273
2728
|
code: number;
|
|
2274
|
-
data?:
|
|
2729
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2275
2730
|
};
|
|
2276
2731
|
/** Cập nhật quảng cáo Bài viết hiện có trên Zalo Ads (Type = 3 hoặc 12). */
|
|
2277
2732
|
type ZaloAdsUpdatePostAdRequest = {
|
|
2278
2733
|
est?: string;
|
|
2279
2734
|
stt?: number | string;
|
|
2280
2735
|
/** Payload cập nhật quảng cáo Bài viết (object hoặc chuỗi JSON). */
|
|
2281
|
-
data:
|
|
2736
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2282
2737
|
isBoostAd?: number | string;
|
|
2283
2738
|
};
|
|
2284
2739
|
type ZaloAdsUpdatePostAdResponse = {
|
|
2285
2740
|
msg: string;
|
|
2286
2741
|
code: number;
|
|
2287
|
-
data?:
|
|
2742
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2288
2743
|
};
|
|
2289
2744
|
/** Tạo chiến dịch quảng cáo Website trên Zalo Ads (campaignType = 1, Type = 9). */
|
|
2290
2745
|
type ZaloAdsCreateWebsiteCampaignRequest = {
|
|
2291
2746
|
/** Cấu hình chiến dịch Website (object hoặc chuỗi JSON): { name, campaignType: 1, pageId, productId: -1, targetUrl, adtype: -1, budgetType: 0, budgetlimit, limitType: 0, campaignObjective: 0, campaignId: 0, adId: 0 }. */
|
|
2292
|
-
data:
|
|
2747
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
2293
2748
|
};
|
|
2294
2749
|
type ZaloAdsCreateWebsiteCampaignResponse = {
|
|
2295
2750
|
code: number;
|
|
@@ -2304,18 +2759,18 @@ type ZaloAdsUpdateWebsiteAdRequest = {
|
|
|
2304
2759
|
est?: string;
|
|
2305
2760
|
stt?: number | string;
|
|
2306
2761
|
/** Payload cập nhật quảng cáo Website (object hoặc chuỗi JSON). */
|
|
2307
|
-
data:
|
|
2762
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2308
2763
|
isBoostAd?: number | string;
|
|
2309
2764
|
};
|
|
2310
2765
|
type ZaloAdsUpdateWebsiteAdResponse = {
|
|
2311
2766
|
code: number;
|
|
2312
2767
|
msg: string;
|
|
2313
|
-
data?:
|
|
2768
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2314
2769
|
};
|
|
2315
2770
|
/** Tạo chiến dịch quảng cáo Display trên Zalo Ads (campaignType = 1, Type = 2). */
|
|
2316
2771
|
type ZaloAdsCreateDisplayCampaignRequest = {
|
|
2317
2772
|
/** Cấu hình chiến dịch Display (object hoặc chuỗi JSON): { name, campaignType: 1, pageId: -1, productId: -1, targetUrl, adtype: 2, budgetType: 1, budgetlimit, limitType: 1, campaignObjective: 0, campaignId: 0, adId: 0 }. */
|
|
2318
|
-
data:
|
|
2773
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
2319
2774
|
};
|
|
2320
2775
|
type ZaloAdsCreateDisplayCampaignResponse = {
|
|
2321
2776
|
code: number;
|
|
@@ -2330,18 +2785,18 @@ type ZaloAdsUpdateDisplayAdRequest = {
|
|
|
2330
2785
|
est?: string;
|
|
2331
2786
|
stt?: number | string;
|
|
2332
2787
|
/** Payload cập nhật quảng cáo Display (object hoặc chuỗi JSON). */
|
|
2333
|
-
data:
|
|
2788
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2334
2789
|
isBoostAd?: number | string;
|
|
2335
2790
|
};
|
|
2336
2791
|
type ZaloAdsUpdateDisplayAdResponse = {
|
|
2337
2792
|
code: number;
|
|
2338
2793
|
msg: string;
|
|
2339
|
-
data?:
|
|
2794
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2340
2795
|
};
|
|
2341
2796
|
/** Tạo chiến dịch quảng cáo Video trên Zalo Ads (campaignType = 3, Type = 11). */
|
|
2342
2797
|
type ZaloAdsCreateVideoCampaignRequest = {
|
|
2343
2798
|
/** Cấu hình chiến dịch Video (object hoặc chuỗi JSON): { name, campaignType: 3, pageId: -1, productId: -1, targetUrl, adtype: -1, budgetType: 1, budgetlimit, limitType: 1, campaignObjective: 0, campaignId: 0, adId: 0 }. */
|
|
2344
|
-
data:
|
|
2799
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
2345
2800
|
};
|
|
2346
2801
|
type ZaloAdsCreateVideoCampaignResponse = {
|
|
2347
2802
|
code: number;
|
|
@@ -2364,6 +2819,34 @@ type ZaloAdsDeleteCampaignResponse = {
|
|
|
2364
2819
|
/** Thông báo kết quả: "Xóa chiến dịch thành công." */
|
|
2365
2820
|
msg: string;
|
|
2366
2821
|
};
|
|
2822
|
+
interface ZaloAdsAutomatedRuleActionDto {
|
|
2823
|
+
/** Mã loại hành động thực thi khi thỏa mãn điều kiện (ví dụ: 5). */
|
|
2824
|
+
type: number;
|
|
2825
|
+
/** Mã trường mục tiêu mà hành động tác động (ví dụ: 1). */
|
|
2826
|
+
field: number;
|
|
2827
|
+
/** Giới hạn trần hoặc sàn của hành động điều chỉnh (ví dụ: 1000000). */
|
|
2828
|
+
limit: number;
|
|
2829
|
+
/** Mảng giá trị tham số của hành động (ví dụ: [5] tương ứng mức thay đổi 5%). */
|
|
2830
|
+
values: Array<number>;
|
|
2831
|
+
}
|
|
2832
|
+
interface ZaloAdsAutomatedRuleConditionDto {
|
|
2833
|
+
/** Mã loại điều kiện đánh giá (ví dụ: 1). */
|
|
2834
|
+
type: number;
|
|
2835
|
+
/** Mã chỉ số đo lường dùng làm điều kiện (ví dụ: 11). */
|
|
2836
|
+
field: number;
|
|
2837
|
+
/** Giá trị ngưỡng so sánh của điều kiện (ví dụ: [1000]). */
|
|
2838
|
+
values: Array<number>;
|
|
2839
|
+
/** Mã toán tử so sánh của điều kiện (ví dụ: 1). */
|
|
2840
|
+
operator: number;
|
|
2841
|
+
/** Mã khoảng thời gian lấy dữ liệu đối chiếu điều kiện (ví dụ: 2). */
|
|
2842
|
+
timeRange: number;
|
|
2843
|
+
}
|
|
2844
|
+
interface ZaloAdsAutomatedRuleScheduleDto {
|
|
2845
|
+
type?: number;
|
|
2846
|
+
frequency?: number;
|
|
2847
|
+
hours?: Array<number>;
|
|
2848
|
+
daysOfWeek?: Array<number>;
|
|
2849
|
+
}
|
|
2367
2850
|
/** Tìm kiếm và lấy danh sách quy tắc tự động (Automated Rules) trên Zalo Ads. */
|
|
2368
2851
|
type ZaloAdsListAutomatedRulesRequest = {
|
|
2369
2852
|
/** Từ khóa lọc theo tên quy tắc tự động (truyền "" để lấy toàn bộ). */
|
|
@@ -2378,19 +2861,16 @@ type ZaloAdsListAutomatedRulesResponse = {
|
|
|
2378
2861
|
memberId: number;
|
|
2379
2862
|
createdBy: number;
|
|
2380
2863
|
ruleName: string;
|
|
2381
|
-
action:
|
|
2382
|
-
conditions: Array<
|
|
2383
|
-
schedule:
|
|
2864
|
+
action: ZaloAdsAutomatedRuleActionDto;
|
|
2865
|
+
conditions: Array<ZaloAdsAutomatedRuleConditionDto>;
|
|
2866
|
+
schedule: ZaloAdsAutomatedRuleScheduleDto;
|
|
2384
2867
|
status: number;
|
|
2385
2868
|
createdTime: number;
|
|
2386
2869
|
appliedTo: number;
|
|
2387
|
-
[key: string]: unknown;
|
|
2388
2870
|
};
|
|
2389
2871
|
campaignIds?: number[];
|
|
2390
2872
|
adIds?: number[];
|
|
2391
|
-
[key: string]: unknown;
|
|
2392
2873
|
}>;
|
|
2393
|
-
[key: string]: unknown;
|
|
2394
2874
|
};
|
|
2395
2875
|
/** Tạo mới một quy tắc tự động (Automated Rule) trên Zalo Ads với phạm vi áp dụng, hành động thực thi, bộ điều kiện kích hoạt và tần suất kiểm tra. Đây là mutation tool thuộc lane zalo-ads-automation. */
|
|
2396
2876
|
type ZaloAdsCreateAutomatedRuleRequest = {
|
|
@@ -2399,41 +2879,18 @@ type ZaloAdsCreateAutomatedRuleRequest = {
|
|
|
2399
2879
|
/** Tên quy tắc tự động cần tạo. */
|
|
2400
2880
|
ruleName: string;
|
|
2401
2881
|
/** Cấu hình hành động tự động thực thi khi các điều kiện được thỏa mãn. */
|
|
2402
|
-
action:
|
|
2403
|
-
/** Mã loại hành động thực thi khi thỏa mãn điều kiện (ví dụ: 5). */
|
|
2404
|
-
type: number;
|
|
2405
|
-
/** Mã trường mục tiêu mà hành động tác động (ví dụ: 1). */
|
|
2406
|
-
field: number;
|
|
2407
|
-
/** Giới hạn trần hoặc sàn của hành động điều chỉnh (ví dụ: 1000000). */
|
|
2408
|
-
limit: number;
|
|
2409
|
-
/** Mảng giá trị tham số của hành động (ví dụ: [5] tương ứng mức thay đổi 5%). */
|
|
2410
|
-
values: Array<number>;
|
|
2411
|
-
[key: string]: unknown;
|
|
2412
|
-
} | Record<string, unknown>;
|
|
2882
|
+
action: ZaloAdsAutomatedRuleActionDto;
|
|
2413
2883
|
/** Danh sách các điều kiện kích hoạt quy tắc tự động. */
|
|
2414
|
-
conditions: Array<
|
|
2415
|
-
/** Mã loại điều kiện đánh giá (ví dụ: 1). */
|
|
2416
|
-
type: number;
|
|
2417
|
-
/** Mã chỉ số đo lường dùng làm điều kiện (ví dụ: 11). */
|
|
2418
|
-
field: number;
|
|
2419
|
-
/** Giá trị ngưỡng so sánh của điều kiện (ví dụ: [1000]). */
|
|
2420
|
-
values: Array<number>;
|
|
2421
|
-
/** Mã toán tử so sánh của điều kiện (ví dụ: 1). */
|
|
2422
|
-
operator: number;
|
|
2423
|
-
/** Mã khoảng thời gian lấy dữ liệu đối chiếu điều kiện (ví dụ: 2). */
|
|
2424
|
-
timeRange: number;
|
|
2425
|
-
[key: string]: unknown;
|
|
2426
|
-
} | Record<string, unknown>>;
|
|
2884
|
+
conditions: Array<ZaloAdsAutomatedRuleConditionDto>;
|
|
2427
2885
|
/** Tần suất hệ thống chạy kiểm tra quy tắc (ví dụ: 12). */
|
|
2428
2886
|
frequency?: number;
|
|
2429
2887
|
/** Danh sách ID chiến dịch hoặc quảng cáo cụ thể áp dụng quy tắc; truyền mảng rỗng [] nếu áp dụng theo toàn bộ scope. */
|
|
2430
2888
|
appliedIds?: Array<number>;
|
|
2431
2889
|
/** Trường tương thích ngược với cấu trúc cũ. */
|
|
2432
2890
|
appliedTo?: number;
|
|
2433
|
-
schedule?:
|
|
2891
|
+
schedule?: ZaloAdsAutomatedRuleScheduleDto;
|
|
2434
2892
|
campaignIds?: number[];
|
|
2435
2893
|
adIds?: number[];
|
|
2436
|
-
[key: string]: unknown;
|
|
2437
2894
|
};
|
|
2438
2895
|
type ZaloAdsCreateAutomatedRuleResponse = {
|
|
2439
2896
|
/** Mã kết quả phản hồi từ Zalo Ads (0 là tạo quy tắc thành công). */
|
|
@@ -2441,8 +2898,7 @@ type ZaloAdsCreateAutomatedRuleResponse = {
|
|
|
2441
2898
|
/** Thông điệp kết quả xử lý (ví dụ: 'Quy tắc của bạn đã được tạo thành công.'). */
|
|
2442
2899
|
msg?: string;
|
|
2443
2900
|
/** ID quy tắc tự động vừa tạo hoặc cờ kết quả trả về từ hệ thống (ví dụ: 1). */
|
|
2444
|
-
data?: number
|
|
2445
|
-
[key: string]: unknown;
|
|
2901
|
+
data?: number;
|
|
2446
2902
|
};
|
|
2447
2903
|
/** Cập nhật quy tắc tự động (Automated Rule) trên Zalo Ads. */
|
|
2448
2904
|
type ZaloAdsUpdateAutomatedRuleRequest = {
|
|
@@ -2450,18 +2906,16 @@ type ZaloAdsUpdateAutomatedRuleRequest = {
|
|
|
2450
2906
|
rowVersion: number;
|
|
2451
2907
|
appliedTo: number;
|
|
2452
2908
|
ruleName: string;
|
|
2453
|
-
action:
|
|
2454
|
-
conditions: Array<
|
|
2455
|
-
schedule:
|
|
2909
|
+
action: ZaloAdsAutomatedRuleActionDto;
|
|
2910
|
+
conditions: Array<ZaloAdsAutomatedRuleConditionDto>;
|
|
2911
|
+
schedule: ZaloAdsAutomatedRuleScheduleDto;
|
|
2456
2912
|
campaignIds?: number[];
|
|
2457
2913
|
adIds?: number[];
|
|
2458
|
-
[key: string]: unknown;
|
|
2459
2914
|
};
|
|
2460
2915
|
type ZaloAdsUpdateAutomatedRuleResponse = {
|
|
2461
2916
|
code: number;
|
|
2462
2917
|
msg?: string;
|
|
2463
|
-
data?:
|
|
2464
|
-
[key: string]: unknown;
|
|
2918
|
+
data?: number | boolean;
|
|
2465
2919
|
};
|
|
2466
2920
|
/** Thay đổi trạng thái bật hoặc tắt (active/inactive) của một quy tắc tự động (Automated Rule) trên Zalo Ads theo ID quy tắc (`POST /api/automatedrules/change-status`). Dùng khi đã có `automatedRuleId` và cần tạm dừng (`status = 0`) hoặc kích hoạt lại (`status = 1`) quy tắc tự động. */
|
|
2467
2921
|
type ZaloAdsChangeAutomatedRuleStatusRequest = {
|
|
@@ -2477,7 +2931,7 @@ type ZaloAdsChangeAutomatedRuleStatusResponse = {
|
|
|
2477
2931
|
code: number;
|
|
2478
2932
|
/** Thông điệp kết quả thay đổi trạng thái quy tắc tự động (ví dụ: 'Thay đổi trạng thái thành công.'). */
|
|
2479
2933
|
msg?: string;
|
|
2480
|
-
data?:
|
|
2934
|
+
data?: number | boolean;
|
|
2481
2935
|
};
|
|
2482
2936
|
/** Tra cứu lịch sử thực thi (executeHistory) và lịch sử chỉnh sửa (editHistory) của một quy tắc tự động (Automated Rule) trên Zalo Ads theo ID quy tắc (`GET /api/automatedrules/history/{automatedRuleId}`). */
|
|
2483
2937
|
type ZaloAdsGetAutomatedRuleHistoryRequest = {
|
|
@@ -2499,7 +2953,6 @@ type ZaloAdsGetAutomatedRuleHistoryResponse = {
|
|
|
2499
2953
|
content: Array<string>;
|
|
2500
2954
|
/** Thời điểm thực hiện chỉnh sửa (Unix timestamp tính bằng giây). */
|
|
2501
2955
|
created: number;
|
|
2502
|
-
[key: string]: unknown;
|
|
2503
2956
|
}>;
|
|
2504
2957
|
/** Danh sách lịch sử các lần hệ thống tự động kích hoạt và thực thi quy tắc. */
|
|
2505
2958
|
executeHistory: Array<{
|
|
@@ -2507,11 +2960,8 @@ type ZaloAdsGetAutomatedRuleHistoryResponse = {
|
|
|
2507
2960
|
content?: Array<string>;
|
|
2508
2961
|
/** Thời điểm hệ thống thực thi quy tắc (Unix timestamp tính bằng giây). */
|
|
2509
2962
|
created?: number;
|
|
2510
|
-
[key: string]: unknown;
|
|
2511
2963
|
}>;
|
|
2512
|
-
[key: string]: unknown;
|
|
2513
2964
|
};
|
|
2514
|
-
[key: string]: unknown;
|
|
2515
2965
|
};
|
|
2516
2966
|
/** Xóa quy tắc tự động trên Zalo Ads. */
|
|
2517
2967
|
type ZaloAdsDeleteAutomatedRuleRequest = {
|
|
@@ -2520,7 +2970,7 @@ type ZaloAdsDeleteAutomatedRuleRequest = {
|
|
|
2520
2970
|
type ZaloAdsDeleteAutomatedRuleResponse = {
|
|
2521
2971
|
code: number;
|
|
2522
2972
|
msg?: string;
|
|
2523
|
-
data?:
|
|
2973
|
+
data?: number | boolean;
|
|
2524
2974
|
};
|
|
2525
2975
|
/** Tải tệp danh sách số điện thoại để tạo hoặc bổ sung nguồn audience tùy chỉnh trong Zalo Ads. Đây là mutation tool thuộc lane zalo-ads-audience; chỉ dùng khi đã có quyền xử lý dữ liệu cá nhân, tệp hợp lệ và xác nhận phạm vi upload. Không đưa số điện thoại hoặc URL tệp có dữ liệu cá nhân vào mô tả, example hay log. */
|
|
2526
2976
|
type ZaloAdsUploadCustomAudiencePhoneListRequest = {
|
|
@@ -2545,12 +2995,15 @@ type ZaloAdsUploadCustomAudiencePhoneListResponse = {
|
|
|
2545
2995
|
/** Tải video lên kho media của tài khoản quảng cáo. Đây là mutation tool thuộc lane zalo-ads-media; dùng khi cần tạo asset video trước bước cấu hình quảng cáo. */
|
|
2546
2996
|
type ZaloAdsUploadVideoRequest = {
|
|
2547
2997
|
/** Tệp video tải lên. Capture đã quan sát field File (chữ hoa) với MIME video/mp4. */
|
|
2548
|
-
File
|
|
2998
|
+
File?: FileInput;
|
|
2999
|
+
/** Alias tương thích chữ thường cho File. */
|
|
3000
|
+
file?: FileInput;
|
|
2549
3001
|
};
|
|
2550
3002
|
type ZaloAdsUploadVideoResponse = {
|
|
2551
3003
|
code: number;
|
|
2552
3004
|
/** URL video do Zalo Ads trả về. */
|
|
2553
3005
|
data: string;
|
|
3006
|
+
msg?: string;
|
|
2554
3007
|
};
|
|
2555
3008
|
/** Tạo mới hoặc cập nhật cấu hình báo cáo tùy chỉnh với tên, cờ mặc định và danh sách chỉ số. Đây là mutation tool thuộc lane zalo-ads-reporting; dùng khi đã xác định bộ cột báo cáo cần lưu. */
|
|
2556
3009
|
type ZaloAdsUpsertCustomReportRequest = {
|
|
@@ -2586,97 +3039,844 @@ type ZaloAdsCreateOaCampaignResponse = ZaloAdsCreateOfficialAccountCampaignRespo
|
|
|
2586
3039
|
/** Thiết lập và lưu cấu hình chi tiết cho mẫu Quảng cáo Zalo Official Account (`Type = 2`, `Action = 6`) trên Zalo Ads. Alias chuẩn theo tool `zalo_ads_update_oa_ad` trong Project Schema Zalo ADS. */
|
|
2587
3040
|
type ZaloAdsUpdateOaAdRequest = ZaloAdsUpdateOfficialAccountAdRequest;
|
|
2588
3041
|
type ZaloAdsUpdateOaAdResponse = ZaloAdsUpdateOfficialAccountAdResponse;
|
|
3042
|
+
/** Tạo mới 'Nhóm đối tượng đã lưu' (`caType = 1` - `DEFAULT`) trên Zalo Ads (`POST /api/ad/audience`). */
|
|
3043
|
+
type ZaloAdsCreateSavedAudienceRequest = {
|
|
3044
|
+
/** Tên nhóm đối tượng đã lưu (từ 2 đến 255 ký tự). */
|
|
3045
|
+
name: string;
|
|
3046
|
+
/** Mã loại nhóm đối tượng (cố định `1` = DEFAULT cho Nhóm đối tượng đã lưu). */
|
|
3047
|
+
caType?: 1;
|
|
3048
|
+
/** Chuỗi JSON (`JSON.stringify`) hoặc Object cấu hình nhắm chọn (`NewAgeRanges`, `Gender`, `Os`, `Location`, `AdvanceTargeting`, `IncludedAudiences`, `ExcludedAudiences`). */
|
|
3049
|
+
targeting: string | Record<string, unknown>;
|
|
3050
|
+
};
|
|
3051
|
+
type ZaloAdsCreateSavedAudienceResponse = ZaloAdsCreateCustomAudienceResponse;
|
|
3052
|
+
/** Lấy danh sách tài khoản Zalo Official Account (OA) có dữ liệu chuyển đổi (Lead Signal) của nhà quảng cáo (`GET /api/ad/audience/leadSignal/oas`). */
|
|
3053
|
+
type ZaloAdsLeadSignalOaItem = {
|
|
3054
|
+
/** ID số của Official Account. */
|
|
3055
|
+
id: number;
|
|
3056
|
+
/** ID mã hóa chuỗi của Official Account. */
|
|
3057
|
+
noisedId?: string;
|
|
3058
|
+
/** Tên hiển thị của Official Account. */
|
|
3059
|
+
name: string;
|
|
3060
|
+
/** URL ảnh đại diện của Official Account. */
|
|
3061
|
+
avatarUrl?: string;
|
|
3062
|
+
};
|
|
3063
|
+
type ZaloAdsListLeadSignalOasResponse = {
|
|
3064
|
+
code: number;
|
|
3065
|
+
msg: string;
|
|
3066
|
+
data: Array<ZaloAdsLeadSignalOaItem>;
|
|
3067
|
+
};
|
|
3068
|
+
interface ZaloAdsConversionNameItemDto {
|
|
3069
|
+
/** Mã định danh duy nhất của sự kiện chuyển đổi (Conversion ID). */
|
|
3070
|
+
id: number;
|
|
3071
|
+
/** Tên sự kiện chuyển đổi (Conversion Name, duy nhất trong phạm vi tài khoản quảng cáo). */
|
|
3072
|
+
name: string;
|
|
3073
|
+
}
|
|
3074
|
+
/** Lấy danh sách rút gọn gồm ID và tên của toàn bộ các sự kiện chuyển đổi (Conversion) đã tạo trên tài khoản quảng cáo Zalo Ads (`GET /api/conversion/names`). */
|
|
3075
|
+
type ZaloAdsListConversionNamesRequest = Record<string, never>;
|
|
3076
|
+
type ZaloAdsListConversionNamesResponse = {
|
|
3077
|
+
/** Mã kết quả phản hồi từ Zalo Ads (`0` = Thành công). */
|
|
3078
|
+
code: number;
|
|
3079
|
+
/** Thông điệp kết quả phản hồi (ví dụ: `'success'`). */
|
|
3080
|
+
msg?: string;
|
|
3081
|
+
/** Mảng danh sách rút gọn `{ id, name }` các sự kiện chuyển đổi hiện có. */
|
|
3082
|
+
data: Array<ZaloAdsConversionNameItemDto>;
|
|
3083
|
+
};
|
|
3084
|
+
/** Cấu hình targeting cho Nhóm đối tượng SĐT (`caType = 3`). */
|
|
3085
|
+
interface ZaloAdsPhoneAudienceTargetingDto {
|
|
3086
|
+
/** Tên file .txt đã tải lên (ví dụ: 'example.txt'). */
|
|
3087
|
+
Name: string;
|
|
3088
|
+
/** Đường dẫn URL công khai của file .txt sau khi upload. */
|
|
3089
|
+
Path: string;
|
|
3090
|
+
/** Tổng số lượng SĐT hợp lệ trong tệp. */
|
|
3091
|
+
Total: number;
|
|
3092
|
+
/** Mã định danh tệp SĐT do Zalo cấp. */
|
|
3093
|
+
ZaloId: number;
|
|
3094
|
+
/** Cờ đánh dấu SĐT đã được người dùng tự mã hóa SHA256 (bắt đầu bằng 84) trước khi tải lên. */
|
|
3095
|
+
IsHashedByUser?: boolean;
|
|
3096
|
+
/** Mặc định là 0. */
|
|
3097
|
+
OriginAudience?: number;
|
|
3098
|
+
}
|
|
3099
|
+
/** Tạo mới Nhóm đối tượng từ danh sách Số điện thoại (`caType = 3` - `PHONE_LIST`). */
|
|
3100
|
+
type ZaloAdsCreatePhoneAudienceRequest = {
|
|
3101
|
+
name: string;
|
|
3102
|
+
caType?: 3;
|
|
3103
|
+
targeting: string | ZaloAdsPhoneAudienceTargetingDto;
|
|
3104
|
+
};
|
|
3105
|
+
type ZaloAdsCreatePhoneAudienceResponse = ZaloAdsCreateCustomAudienceResponse;
|
|
3106
|
+
/** Cấu hình targeting cho Nhóm đối tượng tương tự (`caType = 6`). */
|
|
3107
|
+
interface ZaloAdsLookalikeAudienceTargetingDto {
|
|
3108
|
+
/** ID của nhóm đối tượng SĐT gốc (`caType = 3`). Bắt buộc nhóm gốc phải có từ 1.000 đến 10.000 SĐT! */
|
|
3109
|
+
OriginAudience: number;
|
|
3110
|
+
/** Quy mô nhóm đối tượng mở rộng: 1.000.000, 1.500.000 hoặc 2.000.000. */
|
|
3111
|
+
Total: 1000000 | 1500000 | 2000000 | number;
|
|
3112
|
+
/** Tên nhóm đối tượng SĐT gốc. */
|
|
3113
|
+
Name: string;
|
|
3114
|
+
/** Đường dẫn file nhóm gốc (chuỗi rỗng hoặc URL). */
|
|
3115
|
+
Path?: string;
|
|
3116
|
+
}
|
|
3117
|
+
/** Tạo mới Nhóm đối tượng tương tự Lookalike (`caType = 6` - `LOOKALIKE`). */
|
|
3118
|
+
type ZaloAdsCreateLookalikeAudienceRequest = {
|
|
3119
|
+
name: string;
|
|
3120
|
+
caType?: 6;
|
|
3121
|
+
targeting: string | ZaloAdsLookalikeAudienceTargetingDto;
|
|
3122
|
+
};
|
|
3123
|
+
type ZaloAdsCreateLookalikeAudienceResponse = ZaloAdsCreateCustomAudienceResponse;
|
|
3124
|
+
/** Cấu hình targeting cho Nhóm đối tượng sự kiện Form (`caType = 12`). */
|
|
3125
|
+
interface ZaloAdsFormEventAudienceTargetingDto {
|
|
3126
|
+
/** 1: Đã xem Form nhưng chưa submit, 2: Đã xem Form và submit, 3: Đã xem Form, 4: Mở chat OA từ Form. */
|
|
3127
|
+
EventType: 1 | 2 | 3 | 4 | number;
|
|
3128
|
+
/** ID mã hóa chuỗi (noisedId) của tài khoản OA. */
|
|
3129
|
+
OaId: string;
|
|
3130
|
+
/** Khoảng thời gian lưu vết người dùng (1 đến 90 ngày; gợi ý: 7, 14, 30, 60, 90). */
|
|
3131
|
+
NumDays: number;
|
|
3132
|
+
/** Danh sách ID biểu mẫu Zalo Form. */
|
|
3133
|
+
FormIds: string[];
|
|
3134
|
+
}
|
|
3135
|
+
/** Tạo mới Nhóm đối tượng phát sinh sự kiện trên Zalo Form (`caType = 12` - `FORM_EVENT_AUDIENCE`). */
|
|
3136
|
+
type ZaloAdsCreateFormEventAudienceRequest = {
|
|
3137
|
+
name: string;
|
|
3138
|
+
caType?: 12;
|
|
3139
|
+
targeting: string | ZaloAdsFormEventAudienceTargetingDto;
|
|
3140
|
+
};
|
|
3141
|
+
type ZaloAdsCreateFormEventAudienceResponse = ZaloAdsCreateCustomAudienceResponse;
|
|
3142
|
+
/** Cấu hình targeting cho Nhóm đối tượng sự kiện Tin nhắn OA (`caType = 11`). */
|
|
3143
|
+
interface ZaloAdsMessageOaEventAudienceTargetingDto {
|
|
3144
|
+
/** 1: Liên hệ sau khi xem quảng cáo tin nhắn. */
|
|
3145
|
+
EventId: 1 | number;
|
|
3146
|
+
/** ID mã hóa chuỗi (noisedId) của tài khoản OA xác thực. */
|
|
3147
|
+
OaId: string;
|
|
3148
|
+
/** Khoảng thời gian lưu vết người dùng (1 đến 90 ngày). */
|
|
3149
|
+
NumDays: number;
|
|
3150
|
+
}
|
|
3151
|
+
/** Tạo mới Nhóm đối tượng phát sinh sự kiện trên Kịch bản Tin nhắn OA (`caType = 11` - `MESSAGE_AUDIENCE`). */
|
|
3152
|
+
type ZaloAdsCreateMessageOaEventAudienceRequest = {
|
|
3153
|
+
name: string;
|
|
3154
|
+
caType?: 11;
|
|
3155
|
+
targeting: string | ZaloAdsMessageOaEventAudienceTargetingDto;
|
|
3156
|
+
};
|
|
3157
|
+
type ZaloAdsCreateMessageOaEventAudienceResponse = ZaloAdsCreateCustomAudienceResponse;
|
|
3158
|
+
/** Cấu hình targeting cho Nhóm đối tượng sự kiện Tin nhắn cá nhân (`caType = 14`). */
|
|
3159
|
+
interface ZaloAdsMessagePersonalEventAudienceTargetingDto {
|
|
3160
|
+
/** 1: Đã liên hệ, 2: Đã xem nội dung nhưng không liên hệ, 3: Dành thời gian xem ảnh và video ở carousel nhưng không liên hệ. */
|
|
3161
|
+
EventType: 1 | 2 | 3 | number;
|
|
3162
|
+
/** Khoảng thời gian lưu vết người dùng (1 đến 90 ngày). */
|
|
3163
|
+
NumDays: number;
|
|
3164
|
+
/** Danh sách publicId của các Mini Page template Tin nhắn. */
|
|
3165
|
+
PageIds: string[];
|
|
3166
|
+
}
|
|
3167
|
+
/** Tạo mới Nhóm đối tượng phát sinh sự kiện trên Kịch bản Tin nhắn cá nhân (`caType = 14` - `MESSAGE_PERSONAL_EVENT_AUDIENCE`). */
|
|
3168
|
+
type ZaloAdsCreateMessagePersonalEventAudienceRequest = {
|
|
3169
|
+
name: string;
|
|
3170
|
+
caType?: 14;
|
|
3171
|
+
targeting: string | ZaloAdsMessagePersonalEventAudienceTargetingDto;
|
|
3172
|
+
};
|
|
3173
|
+
type ZaloAdsCreateMessagePersonalEventAudienceResponse = ZaloAdsCreateCustomAudienceResponse;
|
|
3174
|
+
/** Cấu hình targeting cho Nhóm đối tượng Trung tâm Lead - Zalo Form (`caType = 10`). */
|
|
3175
|
+
interface ZaloAdsFormLeadAudienceTargetingDto {
|
|
3176
|
+
Name: string;
|
|
3177
|
+
FormAudienceId: string | number;
|
|
3178
|
+
Total: number;
|
|
3179
|
+
IsCommerce?: false;
|
|
3180
|
+
}
|
|
3181
|
+
/** Tạo mới Nhóm đối tượng từ Trung tâm Lead - Zalo Form (`caType = 10` - `FORM_AUDIENCE`). */
|
|
3182
|
+
type ZaloAdsCreateFormLeadAudienceRequest = {
|
|
3183
|
+
name: string;
|
|
3184
|
+
caType?: 10;
|
|
3185
|
+
targeting: string | ZaloAdsFormLeadAudienceTargetingDto;
|
|
3186
|
+
};
|
|
3187
|
+
type ZaloAdsCreateFormLeadAudienceResponse = ZaloAdsCreateCustomAudienceResponse;
|
|
3188
|
+
/** Cấu hình targeting cho Nhóm đối tượng Trung tâm Lead - Commerce Form (`caType = 15`). */
|
|
3189
|
+
interface ZaloAdsCommerceFormAudienceTargetingDto {
|
|
3190
|
+
Name: string;
|
|
3191
|
+
FormAudienceId: string | number;
|
|
3192
|
+
Total: number;
|
|
3193
|
+
IsCommerce: true;
|
|
3194
|
+
}
|
|
3195
|
+
/** Tạo mới Nhóm đối tượng từ Trung tâm Lead - Commerce Form (`caType = 15` - `COMMERCE_FORM_AUDIENCE`). */
|
|
3196
|
+
type ZaloAdsCreateCommerceFormAudienceRequest = {
|
|
3197
|
+
name: string;
|
|
3198
|
+
caType?: 15;
|
|
3199
|
+
targeting: string | ZaloAdsCommerceFormAudienceTargetingDto;
|
|
3200
|
+
};
|
|
3201
|
+
type ZaloAdsCreateCommerceFormAudienceResponse = ZaloAdsCreateCustomAudienceResponse;
|
|
3202
|
+
/** Cấu hình targeting cho Nhóm đối tượng Trung tâm Lead - Kịch bản Tin nhắn OA (`caType = 13`). */
|
|
3203
|
+
interface ZaloAdsMessageOaLeadAudienceTargetingDto {
|
|
3204
|
+
Name: string;
|
|
3205
|
+
MessageOAAudienceId: string | number;
|
|
3206
|
+
Total: number;
|
|
3207
|
+
}
|
|
3208
|
+
/** Tạo mới Nhóm đối tượng từ Trung tâm Lead - Kịch bản Tin nhắn OA (`caType = 13` - `MESSAGE_OA_AUDIENCE`). */
|
|
3209
|
+
type ZaloAdsCreateMessageOaLeadAudienceRequest = {
|
|
3210
|
+
name: string;
|
|
3211
|
+
caType?: 13;
|
|
3212
|
+
targeting: string | ZaloAdsMessageOaLeadAudienceTargetingDto;
|
|
3213
|
+
};
|
|
3214
|
+
type ZaloAdsCreateMessageOaLeadAudienceResponse = ZaloAdsCreateCustomAudienceResponse;
|
|
3215
|
+
/** Cấu hình targeting cho Nhóm đối tượng Dữ liệu chuyển đổi Lead Signal (`caType = 16`). */
|
|
3216
|
+
interface ZaloAdsLeadSignalAudienceTargetingDto {
|
|
3217
|
+
/** ID số của Official Account có dữ liệu chuyển đổi. */
|
|
3218
|
+
OaId: number;
|
|
3219
|
+
/** Tên nhãn sự kiện chuyển đổi. */
|
|
3220
|
+
Label: string;
|
|
3221
|
+
/** Mức điều chỉnh độ rộng đối tượng từ 1 đến 20 (mặc định: 5). */
|
|
3222
|
+
SegmentCount: number;
|
|
3223
|
+
/** Ước tính số người tiếp cận (Math.round(A30 / 20 * SegmentCount)). */
|
|
3224
|
+
Total: number;
|
|
3225
|
+
}
|
|
3226
|
+
/** Tạo mới Nhóm đối tượng từ Dữ liệu chuyển đổi Lead Signal (`caType = 16` - `LEAD_SIGNAL_AUDIENCE`). */
|
|
3227
|
+
type ZaloAdsCreateLeadSignalAudienceRequest = {
|
|
3228
|
+
name: string;
|
|
3229
|
+
caType?: 16;
|
|
3230
|
+
targeting: string | ZaloAdsLeadSignalAudienceTargetingDto;
|
|
3231
|
+
};
|
|
3232
|
+
type ZaloAdsCreateLeadSignalAudienceResponse = ZaloAdsCreateCustomAudienceResponse;
|
|
3233
|
+
/** Lấy số liệu báo cáo tổng quan Dashboard (GET https://ads.zalo.me/reportapi/report/overview). */
|
|
3234
|
+
type ZaloAdsGetReportOverviewRequest = {
|
|
3235
|
+
/** Chuỗi JSON mã hóa URL, ví dụ: '{"StartDate":1768755600,"EndDate":1768928399}' */
|
|
3236
|
+
data: string;
|
|
3237
|
+
};
|
|
3238
|
+
type ZaloAdsGetReportOverviewResponse = {
|
|
3239
|
+
code: number;
|
|
3240
|
+
data: Record<string, Record<string, number>>;
|
|
3241
|
+
extend?: {
|
|
3242
|
+
totalUniqueUser?: number;
|
|
3243
|
+
};
|
|
3244
|
+
};
|
|
3245
|
+
/** Lấy báo cáo nhân khẩu học của chiến dịch hoặc quảng cáo (GET https://ads.zalo.me/api/demographics/report). */
|
|
3246
|
+
type ZaloAdsGetDemographicsReportRequest = {
|
|
3247
|
+
campaignId: number;
|
|
3248
|
+
adId: number;
|
|
3249
|
+
startDate: number;
|
|
3250
|
+
endDate: number;
|
|
3251
|
+
agencyId?: number;
|
|
3252
|
+
from?: number;
|
|
3253
|
+
to?: number;
|
|
3254
|
+
};
|
|
3255
|
+
type ZaloAdsGetDemographicsReportResponse = {
|
|
3256
|
+
cAgeGender?: Record<string, number>;
|
|
3257
|
+
iAgeGender?: Record<string, number>;
|
|
3258
|
+
location?: Record<string, unknown>;
|
|
3259
|
+
};
|
|
3260
|
+
/** Xóa cấu hình báo cáo tùy chỉnh theo ID (POST https://ads.zalo.me/reportapi/custom-report/delete/{id}). */
|
|
3261
|
+
type ZaloAdsDeleteCustomReportRequest = {
|
|
3262
|
+
id: number | string;
|
|
3263
|
+
};
|
|
3264
|
+
type ZaloAdsDeleteCustomReportResponse = {
|
|
3265
|
+
code?: number;
|
|
3266
|
+
msg?: string;
|
|
3267
|
+
data?: unknown;
|
|
3268
|
+
};
|
|
3269
|
+
/** Lấy danh sách các bộ lọc báo cáo đã lưu (GET https://ads.zalo.me/reportapi/api/filter/list). */
|
|
3270
|
+
type ZaloAdsListReportFiltersRequest = {
|
|
3271
|
+
/** 0: all/chung, 1: campaign, 2: ad */
|
|
3272
|
+
model: number | string;
|
|
3273
|
+
};
|
|
3274
|
+
type ZaloAdsListReportFiltersResponse = Array<{
|
|
3275
|
+
id: number;
|
|
3276
|
+
name: string;
|
|
3277
|
+
content: string;
|
|
3278
|
+
model: number;
|
|
3279
|
+
}>;
|
|
3280
|
+
|
|
3281
|
+
/**
|
|
3282
|
+
* Tham số đầu vào cho method tiện ích `uploadAndSaveImage`
|
|
3283
|
+
* (Tự động thực hiện 2 bước: upload lên CDN rồi lưu vào Thư viện Media Zalo Ads).
|
|
3284
|
+
*/
|
|
3285
|
+
interface ZaloUploadAndSaveImageRequest {
|
|
3286
|
+
/**
|
|
3287
|
+
* Tệp ảnh cần tải lên:
|
|
3288
|
+
* - Buffer / Uint8Array / ArrayBuffer (ví dụ: `req.file.buffer` từ Multer trong NestJS/Express)
|
|
3289
|
+
* - Web Blob / File
|
|
3290
|
+
* - URL công khai trên Internet (http/https hoặc data URI)
|
|
3291
|
+
*
|
|
3292
|
+
* (Lưu ý: Không hỗ trợ đường dẫn tệp cục bộ trên ổ cứng).
|
|
3293
|
+
*/
|
|
3294
|
+
file: FileInput;
|
|
3295
|
+
/**
|
|
3296
|
+
* Tên hiển thị của ảnh khi lưu vào Thư viện Media.
|
|
3297
|
+
* Nếu bỏ trống, SDK sẽ tự động trích xuất từ tên file hoặc tự sinh tên dựa trên timestamp.
|
|
3298
|
+
*/
|
|
3299
|
+
fileName?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* Chiều rộng ảnh (pixels).
|
|
3302
|
+
* Tùy chọn; nếu không truyền và là file local/buffer, SDK sẽ tự động đọc header ảnh JPEG/PNG.
|
|
3303
|
+
*/
|
|
3304
|
+
width?: number;
|
|
3305
|
+
/**
|
|
3306
|
+
* Chiều cao ảnh (pixels).
|
|
3307
|
+
* Tùy chọn; nếu không truyền và là file local/buffer, SDK sẽ tự động đọc header ảnh JPEG/PNG.
|
|
3308
|
+
*/
|
|
3309
|
+
height?: number;
|
|
3310
|
+
/**
|
|
3311
|
+
* Loại tài nguyên media: 1 = Ảnh (mặc định là 1).
|
|
3312
|
+
*/
|
|
3313
|
+
type?: number;
|
|
3314
|
+
/**
|
|
3315
|
+
* URL ảnh thu nhỏ (thumbnail) nếu có.
|
|
3316
|
+
*/
|
|
3317
|
+
thumbUrl?: string;
|
|
3318
|
+
}
|
|
3319
|
+
/**
|
|
3320
|
+
* Kết quả trả về từ method `uploadAndSaveImage`.
|
|
3321
|
+
*/
|
|
3322
|
+
interface ZaloUploadAndSaveImageResult {
|
|
3323
|
+
/** Mã kết quả xử lý từ Zalo Ads (0 = thành công). */
|
|
3324
|
+
code: number;
|
|
3325
|
+
/** ID của media vừa được tạo trong Thư viện Zalo Ads (dùng để gán vào Creative/Banner). */
|
|
3326
|
+
mediaId: number;
|
|
3327
|
+
/** URL CDN trực tiếp của ảnh trên máy chủ Zalo (https://adtima-media.zascdn.me/...). */
|
|
3328
|
+
cdnUrl: string;
|
|
3329
|
+
/** Tên tệp đã lưu trong thư viện. */
|
|
3330
|
+
name: string;
|
|
3331
|
+
/** Chiều rộng ảnh (pixels). */
|
|
3332
|
+
width: number;
|
|
3333
|
+
/** Chiều cao ảnh (pixels). */
|
|
3334
|
+
height: number;
|
|
3335
|
+
/** Loại media (1 = Ảnh). */
|
|
3336
|
+
type: number;
|
|
3337
|
+
/** Chi tiết phản hồi từ API upload ảnh (/api/member/upload-image). */
|
|
3338
|
+
rawUploadResponse: ZaloAdsPostApiMemberUploadImageResponse;
|
|
3339
|
+
/** Chi tiết phản hồi từ API lưu media (/api/media/save). */
|
|
3340
|
+
rawSaveResponse: ZaloAdsPostApiMediaSaveResponse;
|
|
3341
|
+
}
|
|
3342
|
+
/**
|
|
3343
|
+
* Tham số đầu vào cho method tiện ích `uploadAndSaveVideo`.
|
|
3344
|
+
*/
|
|
3345
|
+
interface ZaloUploadAndSaveVideoRequest {
|
|
3346
|
+
/**
|
|
3347
|
+
* Tệp video cần tải lên (Buffer, Uint8Array, Blob, File hoặc URL công khai .mp4).
|
|
3348
|
+
* Lưu ý: Không hỗ trợ đường dẫn tệp cục bộ trên ổ cứng.
|
|
3349
|
+
*/
|
|
3350
|
+
file: FileInput;
|
|
3351
|
+
/** Tên hiển thị của video trong Thư viện Media. */
|
|
3352
|
+
fileName?: string;
|
|
3353
|
+
/** Chiều rộng video (pixels). Mặc định 1920 hoặc tự truyền. */
|
|
3354
|
+
width?: number;
|
|
3355
|
+
/** Chiều cao video (pixels). Mặc định 1080 hoặc tự truyền. */
|
|
3356
|
+
height?: number;
|
|
3357
|
+
/** Thời lượng video tính bằng giây (tối đa 60s). */
|
|
3358
|
+
duration?: number;
|
|
3359
|
+
/** URL ảnh thu nhỏ (thumbnail poster) của video. */
|
|
3360
|
+
thumbUrl?: string;
|
|
3361
|
+
}
|
|
3362
|
+
/**
|
|
3363
|
+
* Kết quả trả về từ method `uploadAndSaveVideo`.
|
|
3364
|
+
*/
|
|
3365
|
+
interface ZaloUploadAndSaveVideoResult {
|
|
3366
|
+
code: number;
|
|
3367
|
+
mediaId: number;
|
|
3368
|
+
cdnUrl: string;
|
|
3369
|
+
name: string;
|
|
3370
|
+
width: number;
|
|
3371
|
+
height: number;
|
|
3372
|
+
duration?: number;
|
|
3373
|
+
type: number;
|
|
3374
|
+
rawUploadResponse: ZaloAdsUploadVideoResponse;
|
|
3375
|
+
rawSaveResponse: ZaloAdsPostApiMediaSaveResponse;
|
|
3376
|
+
}
|
|
3377
|
+
/**
|
|
3378
|
+
* Kết quả kiểm tra tính hợp lệ của tài nguyên media (Ảnh hoặc Video).
|
|
3379
|
+
*/
|
|
3380
|
+
interface MediaValidationResult {
|
|
3381
|
+
/** Trạng thái hợp lệ (true nếu vượt qua toàn bộ quy chuẩn, false nếu có lỗi). */
|
|
3382
|
+
isValid: boolean;
|
|
3383
|
+
/** Mã trạng thái: 'VALID' | 'INVALID'. */
|
|
3384
|
+
status: "VALID" | "INVALID";
|
|
3385
|
+
/** Danh sách các thông báo lỗi nếu vi phạm tiêu chí kỹ thuật. Rỗng khi isValid = true. */
|
|
3386
|
+
errors: string[];
|
|
3387
|
+
/** Tóm tắt metadata đã phân tích được từ tệp. */
|
|
3388
|
+
metadata: {
|
|
3389
|
+
fileDetected: boolean;
|
|
3390
|
+
sizeBytes?: number;
|
|
3391
|
+
width?: number;
|
|
3392
|
+
height?: number;
|
|
3393
|
+
durationSeconds?: number;
|
|
3394
|
+
format?: string;
|
|
3395
|
+
aspectRatio?: string;
|
|
3396
|
+
};
|
|
3397
|
+
}
|
|
3398
|
+
/**
|
|
3399
|
+
* Dữ liệu đầu vào để kiểm tra tính hợp lệ của Ảnh.
|
|
3400
|
+
* Hỗ trợ nhận trực tiếp tệp (Buffer, Blob, path) hoặc metadata do backend (multer/busboy) trích xuất sẵn.
|
|
3401
|
+
*
|
|
3402
|
+
* Tiêu chuẩn quy định:
|
|
3403
|
+
* - "No file chosen": Bắt buộc phải có tệp.
|
|
3404
|
+
* - Dung lượng: Tối đa 2MB (2,097,152 bytes).
|
|
3405
|
+
* - Kích thước tối thiểu: 150x150 pixels.
|
|
3406
|
+
* - Định dạng: .JPG, .JPEG, .PNG.
|
|
3407
|
+
*/
|
|
3408
|
+
interface ValidateImageInput {
|
|
3409
|
+
/** Tệp ảnh (Buffer, Blob, Uint8Array, đường dẫn file local trong Node.js, hoặc đối tượng có trường size). */
|
|
3410
|
+
file?: FileInput | {
|
|
3411
|
+
size?: number;
|
|
3412
|
+
buffer?: Uint8Array;
|
|
3413
|
+
mimetype?: string;
|
|
3414
|
+
originalname?: string;
|
|
3415
|
+
} | null;
|
|
3416
|
+
/** Dung lượng file tính bằng bytes (nếu truyền từ backend multipart/multer). */
|
|
3417
|
+
sizeBytes?: number;
|
|
3418
|
+
/** Chiều rộng ảnh tính bằng pixels (nếu đã phân tích sẵn). */
|
|
3419
|
+
width?: number;
|
|
3420
|
+
/** Chiều cao ảnh tính bằng pixels (nếu đã phân tích sẵn). */
|
|
3421
|
+
height?: number;
|
|
3422
|
+
/** Định dạng tệp / MIME type (ví dụ: 'image/jpeg', 'image/png', '.jpg', '.png'). */
|
|
3423
|
+
format?: string;
|
|
3424
|
+
/** Tên tệp gốc (ví dụ: 'banner.png'). */
|
|
3425
|
+
fileName?: string;
|
|
3426
|
+
}
|
|
3427
|
+
/**
|
|
3428
|
+
* Dữ liệu đầu vào để kiểm tra tính hợp lệ của Video.
|
|
3429
|
+
* Hỗ trợ nhận trực tiếp tệp hoặc metadata do backend trích xuất sẵn.
|
|
3430
|
+
*
|
|
3431
|
+
* Tiêu chuẩn quy định:
|
|
3432
|
+
* - "No file chosen": Bắt buộc phải có tệp.
|
|
3433
|
+
* - Định dạng: .MP4 H.264.
|
|
3434
|
+
* - Dung lượng: Tối đa 150MB (157,286,400 bytes).
|
|
3435
|
+
* - Thời lượng: Tối đa 60 giây.
|
|
3436
|
+
* - Tỉ lệ khung hình: 16:9, 9:16 hoặc 1:1.
|
|
3437
|
+
*/
|
|
3438
|
+
interface ValidateVideoInput {
|
|
3439
|
+
/** Tệp video (Buffer, Blob, Uint8Array, đường dẫn file local, hoặc multer file object). */
|
|
3440
|
+
file?: FileInput | {
|
|
3441
|
+
size?: number;
|
|
3442
|
+
buffer?: Uint8Array;
|
|
3443
|
+
mimetype?: string;
|
|
3444
|
+
originalname?: string;
|
|
3445
|
+
} | null;
|
|
3446
|
+
/** Dung lượng video tính bằng bytes. */
|
|
3447
|
+
sizeBytes?: number;
|
|
3448
|
+
/** Thời lượng video tính bằng giây (tối đa 60 giây). */
|
|
3449
|
+
durationSeconds?: number;
|
|
3450
|
+
/** Chiều rộng video tính bằng pixels (dùng để tính tỉ lệ khung hình). */
|
|
3451
|
+
width?: number;
|
|
3452
|
+
/** Chiều cao video tính bằng pixels (dùng để tính tỉ lệ khung hình). */
|
|
3453
|
+
height?: number;
|
|
3454
|
+
/** Định dạng tệp hoặc codec (ví dụ: '.mp4', 'video/mp4', 'h264'). */
|
|
3455
|
+
format?: string;
|
|
3456
|
+
/** Tên tệp video gốc (ví dụ: 'promo.mp4'). */
|
|
3457
|
+
fileName?: string;
|
|
3458
|
+
}
|
|
3459
|
+
|
|
3460
|
+
/**
|
|
3461
|
+
* Dịch vụ Quản lý Chiến dịch & Quảng cáo Zalo Ads (Tạo chiến dịch, đổi trạng thái, cập nhật quảng cáo các định dạng).
|
|
3462
|
+
*/
|
|
3463
|
+
|
|
3464
|
+
declare class ZaloCampaignsService {
|
|
3465
|
+
protected readonly client: ZaloSdkHttpClient;
|
|
3466
|
+
constructor(client: ZaloSdkHttpClient);
|
|
3467
|
+
updateVideoAd(request: ZaloAdsUpdateVideoAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateVideoAdResponse>;
|
|
3468
|
+
changeCampaignStatus(request: ZaloAdsChangeCampaignStatusRequest, options?: RequestOptions): Promise<ZaloAdsChangeCampaignStatusResponse>;
|
|
3469
|
+
deleteCampaign(request: ZaloAdsDeleteCampaignRequest, options?: RequestOptions): Promise<ZaloAdsDeleteCampaignResponse>;
|
|
3470
|
+
createWebsiteCampaign(request: ZaloAdsCreateWebsiteCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateWebsiteCampaignResponse>;
|
|
3471
|
+
updateWebsiteAd(request: ZaloAdsUpdateWebsiteAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateWebsiteAdResponse>;
|
|
3472
|
+
createDisplayCampaign(request: ZaloAdsCreateDisplayCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateDisplayCampaignResponse>;
|
|
3473
|
+
updateDisplayAd(request: ZaloAdsUpdateDisplayAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateDisplayAdResponse>;
|
|
3474
|
+
createVideoCampaign(request: ZaloAdsCreateVideoCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateVideoCampaignResponse>;
|
|
3475
|
+
createEcommerceCampaign(request: ZaloAdsCreateEcommerceCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateEcommerceCampaignResponse>;
|
|
3476
|
+
/** Alias theo tên tool chuẩn `zalo_ads_create_commerce_campaign` trong Project Schema Zalo ADS (`campaignType = 22`). */
|
|
3477
|
+
createCommerceCampaign(request: ZaloAdsCreateCommerceCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateCommerceCampaignResponse>;
|
|
3478
|
+
createForm(request: ZaloAdsCreateFormRequest, options?: RequestOptions): Promise<ZaloAdsCreateFormResponse>;
|
|
3479
|
+
createFormCampaign(request: ZaloAdsCreateFormCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateFormCampaignResponse>;
|
|
3480
|
+
createMessageCampaign(request: ZaloAdsCreateMessageCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateMessageCampaignResponse>;
|
|
3481
|
+
createOfficialAccountCampaign(request: ZaloAdsCreateOfficialAccountCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateOfficialAccountCampaignResponse>;
|
|
3482
|
+
/** Alias theo tên tool chuẩn `zalo_ads_create_oa_campaign` trong Project Schema Zalo ADS (`campaignType = 3`). */
|
|
3483
|
+
createOaCampaign(request: ZaloAdsCreateOaCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateOaCampaignResponse>;
|
|
3484
|
+
createPostCampaign(request: ZaloAdsCreatePostCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreatePostCampaignResponse>;
|
|
3485
|
+
/** Alias theo tên tool chuẩn `zalo_ads_create_article_campaign` trong Project Schema Zalo ADS (`campaignType = 4`). */
|
|
3486
|
+
createArticleCampaign(request: ZaloAdsCreateArticleCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateArticleCampaignResponse>;
|
|
3487
|
+
getAdById(request?: ZaloAdsGetAdByIdRequest, options?: RequestOptions): Promise<ZaloAdsGetAdByIdResponse>;
|
|
3488
|
+
getAdChangeLog(request: ZaloAdsGetAdChangeLogRequest, options?: RequestOptions): Promise<ZaloAdsGetAdChangeLogResponse>;
|
|
3489
|
+
getApiPlaceGetalldistricts(request?: ZaloAdsGetApiPlaceGetalldistrictsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiPlaceGetalldistrictsResponse>;
|
|
3490
|
+
getApiSpellCheckV2(request: ZaloAdsGetApiSpellCheckV2Request, options?: RequestOptions): Promise<ZaloAdsGetApiSpellCheckV2Response>;
|
|
3491
|
+
getZaapiCheckcamphasmanyads(request?: ZaloAdsGetZaapiCheckcamphasmanyadsRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiCheckcamphasmanyadsResponse>;
|
|
3492
|
+
getZaapiGetadsfromcampaignid(request?: ZaloAdsGetZaapiGetadsfromcampaignidRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetadsfromcampaignidResponse>;
|
|
3493
|
+
getZaapiGetallpages(request?: ZaloAdsGetZaapiGetallpagesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetallpagesResponse>;
|
|
3494
|
+
getAllPages(request?: ZaloAdsGetZaapiGetallpagesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetallpagesResponse>;
|
|
3495
|
+
getZaapiGetownedarticles(request: ZaloAdsGetZaapiGetownedarticlesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetownedarticlesResponse>;
|
|
3496
|
+
getOwnedArticles(request: ZaloAdsGetZaapiGetownedarticlesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetownedarticlesResponse>;
|
|
3497
|
+
getZaapiGetownedpages(request?: ZaloAdsGetZaapiGetownedpagesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetownedpagesResponse>;
|
|
3498
|
+
getOwnedPages(request?: ZaloAdsGetZaapiGetownedpagesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetownedpagesResponse>;
|
|
3499
|
+
listFormsByOfficialAccount(request: ZaloAdsListFormsByOfficialAccountRequest, options?: RequestOptions): Promise<ZaloAdsListFormsByOfficialAccountResponse>;
|
|
3500
|
+
listMiniPagesByTemplate(request: ZaloAdsListMiniPagesByTemplateRequest, options?: RequestOptions): Promise<ZaloAdsListMiniPagesByTemplateResponse>;
|
|
3501
|
+
postZaapiDeletead(request?: ZaloAdsPostZaapiDeleteadRequest, options?: RequestOptions): Promise<ZaloAdsPostZaapiDeleteadResponse>;
|
|
3502
|
+
renameCampaign(request: ZaloAdsRenameCampaignRequest, options?: RequestOptions): Promise<ZaloAdsRenameCampaignResponse>;
|
|
3503
|
+
updateEcommerceAd(request: ZaloAdsUpdateEcommerceAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateEcommerceAdResponse>;
|
|
3504
|
+
/** Alias theo tên tool chuẩn `zalo_ads_update_commerce_ad` trong Project Schema Zalo ADS (`Type = 23`, gắn `MiniPageId`). */
|
|
3505
|
+
updateCommerceAd(request: ZaloAdsUpdateCommerceAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateCommerceAdResponse>;
|
|
3506
|
+
updateFormAd(request: ZaloAdsUpdateFormAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateFormAdResponse>;
|
|
3507
|
+
updateMessageAd(request: ZaloAdsUpdateMessageAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateMessageAdResponse>;
|
|
3508
|
+
updateNewAds(request: ZaloAdsUpdateNewAdsRequest, options?: RequestOptions): Promise<ZaloAdsUpdateNewAdsResponse>;
|
|
3509
|
+
updateOfficialAccountAd(request: ZaloAdsUpdateOfficialAccountAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateOfficialAccountAdResponse>;
|
|
3510
|
+
/** Alias theo tên tool chuẩn `zalo_ads_update_oa_ad` trong Project Schema Zalo ADS (`Type = 2`, `Action = 6`). */
|
|
3511
|
+
updateOaAd(request: ZaloAdsUpdateOaAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateOaAdResponse>;
|
|
3512
|
+
updatePostAd(request: ZaloAdsUpdatePostAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdatePostAdResponse>;
|
|
3513
|
+
/** Alias theo tên tool chuẩn `zalo_ads_update_article_ad` trong Project Schema Zalo ADS (`Type = 3`, gắn `ZaloFeedId`). */
|
|
3514
|
+
updateArticleAd(request: ZaloAdsUpdateArticleAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateArticleAdResponse>;
|
|
3515
|
+
/** Xóa quảng cáo */
|
|
3516
|
+
deleteAd(...args: Parameters<this["postZaapiDeletead"]>): ReturnType<this["postZaapiDeletead"]>;
|
|
3517
|
+
/** Danh sách quận/huyện để nhắm mục tiêu */
|
|
3518
|
+
getAllDistricts(...args: Parameters<this["getApiPlaceGetalldistricts"]>): ReturnType<this["getApiPlaceGetalldistricts"]>;
|
|
3519
|
+
/** Kiểm tra chính tả văn bản quảng cáo */
|
|
3520
|
+
getSpellCheckV2(...args: Parameters<this["getApiSpellCheckV2"]>): ReturnType<this["getApiSpellCheckV2"]>;
|
|
3521
|
+
}
|
|
3522
|
+
|
|
3523
|
+
/**
|
|
3524
|
+
* Dịch vụ Quản lý Tài khoản & Thanh toán Zalo Ads (whoami, transactions, BA accessors, agency).
|
|
3525
|
+
*/
|
|
3526
|
+
|
|
3527
|
+
declare class ZaloAccountService {
|
|
3528
|
+
protected readonly client: ZaloSdkHttpClient;
|
|
3529
|
+
constructor(client: ZaloSdkHttpClient);
|
|
3530
|
+
getApiWhoami(request?: ZaloAdsGetApiWhoamiRequest, options?: RequestOptions): Promise<ZaloAdsGetApiWhoamiResponse>;
|
|
3531
|
+
getApiPaymentTransactionHistory(request: ZaloAdsGetApiPaymentTransactionHistoryRequest, options?: RequestOptions): Promise<ZaloAdsGetApiPaymentTransactionHistoryResponse>;
|
|
3532
|
+
getApiBaAccountAllaccessors(request?: ZaloAdsGetApiBaAccountAllaccessorsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiBaAccountAllaccessorsResponse>;
|
|
3533
|
+
getApiBaAccountAllgrantedmembers(request?: ZaloAdsGetApiBaAccountAllgrantedmembersRequest, options?: RequestOptions): Promise<ZaloAdsGetApiBaAccountAllgrantedmembersResponse>;
|
|
3534
|
+
listAgencyCustomersWithBudget(request?: ZaloAdsListAgencyCustomersWithBudgetRequest, options?: RequestOptions): Promise<ZaloAdsListAgencyCustomersWithBudgetResponse>;
|
|
3535
|
+
getApiNotifiesHeader(request?: ZaloAdsGetApiNotifiesHeaderRequest, options?: RequestOptions): Promise<ZaloAdsGetApiNotifiesHeaderResponse>;
|
|
3536
|
+
getApiLpNews(request?: ZaloAdsGetApiLpNewsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiLpNewsResponse>;
|
|
3537
|
+
/** Lấy thông tin tài khoản đang đăng nhập */
|
|
3538
|
+
getWhoami(...args: Parameters<this["getApiWhoami"]>): ReturnType<this["getApiWhoami"]>;
|
|
3539
|
+
/** Lịch sử giao dịch thanh toán */
|
|
3540
|
+
getPaymentTransactionHistory(...args: Parameters<this["getApiPaymentTransactionHistory"]>): ReturnType<this["getApiPaymentTransactionHistory"]>;
|
|
3541
|
+
/** Danh sách accessor tài khoản BA */
|
|
3542
|
+
getBaAccountAllAccessors(...args: Parameters<this["getApiBaAccountAllaccessors"]>): ReturnType<this["getApiBaAccountAllaccessors"]>;
|
|
3543
|
+
/** Danh sách thành viên được cấp quyền BA */
|
|
3544
|
+
getBaAccountAllGrantedMembers(...args: Parameters<this["getApiBaAccountAllgrantedmembers"]>): ReturnType<this["getApiBaAccountAllgrantedmembers"]>;
|
|
3545
|
+
/** Thông báo trên thanh tiêu đề */
|
|
3546
|
+
getNotifiesHeader(...args: Parameters<this["getApiNotifiesHeader"]>): ReturnType<this["getApiNotifiesHeader"]>;
|
|
3547
|
+
/** Tin tức landing page / bảng tin */
|
|
3548
|
+
getLpNews(...args: Parameters<this["getApiLpNews"]>): ReturnType<this["getApiLpNews"]>;
|
|
3549
|
+
}
|
|
3550
|
+
|
|
3551
|
+
/**
|
|
3552
|
+
* Dịch vụ Quản lý Đối tượng Tùy chỉnh & Ước tính Tiếp cận (Custom Audiences, Phone List, Lookalike, Event Audiences).
|
|
3553
|
+
*/
|
|
3554
|
+
|
|
3555
|
+
declare class ZaloAudiencesService {
|
|
3556
|
+
protected readonly client: ZaloSdkHttpClient;
|
|
3557
|
+
constructor(client: ZaloSdkHttpClient);
|
|
3558
|
+
postApiAdEstimateaudience(request: ZaloAdsPostApiAdEstimateaudienceRequest, options?: RequestOptions): Promise<ZaloAdsPostApiAdEstimateaudienceResponse>;
|
|
3559
|
+
getApiAdGetlistadadvancetargeting(request?: ZaloAdsGetApiAdGetlistadadvancetargetingRequest, options?: RequestOptions): Promise<ZaloAdsGetApiAdGetlistadadvancetargetingResponse>;
|
|
3560
|
+
getApiCustomAudienceAll(request?: ZaloAdsGetApiCustomAudienceAllRequest, options?: RequestOptions): Promise<ZaloAdsGetApiCustomAudienceAllResponse>;
|
|
3561
|
+
createCustomAudience(request: ZaloAdsCreateCustomAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateCustomAudienceResponse>;
|
|
3562
|
+
deleteCustomAudience(request: ZaloAdsDeleteCustomAudienceRequest, options?: RequestOptions): Promise<ZaloAdsDeleteCustomAudienceResponse>;
|
|
3563
|
+
uploadCustomAudiencePhoneList(request: ZaloAdsUploadCustomAudiencePhoneListRequest, options?: RequestOptions): Promise<ZaloAdsUploadCustomAudiencePhoneListResponse>;
|
|
3564
|
+
/** Tạo mới 'Nhóm đối tượng đã lưu' (`caType = 1` - `DEFAULT`) trên Zalo Ads (`POST /api/ad/audience`). */
|
|
3565
|
+
createSavedAudience(request: ZaloAdsCreateSavedAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateSavedAudienceResponse>;
|
|
3566
|
+
/** Tạo mới Nhóm đối tượng từ danh sách Số điện thoại (`caType = 3` - `PHONE_LIST`). */
|
|
3567
|
+
createPhoneAudience(request: ZaloAdsCreatePhoneAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreatePhoneAudienceResponse>;
|
|
3568
|
+
/** Tạo mới Nhóm đối tượng tương tự Lookalike (`caType = 6` - `LOOKALIKE`). */
|
|
3569
|
+
createLookalikeAudience(request: ZaloAdsCreateLookalikeAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateLookalikeAudienceResponse>;
|
|
3570
|
+
/** Tạo mới Nhóm đối tượng phát sinh sự kiện trên Zalo Form (`caType = 12` - `FORM_EVENT_AUDIENCE`). */
|
|
3571
|
+
createFormEventAudience(request: ZaloAdsCreateFormEventAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateFormEventAudienceResponse>;
|
|
3572
|
+
/** Tạo mới Nhóm đối tượng phát sinh sự kiện trên Kịch bản Tin nhắn OA (`caType = 11` - `MESSAGE_AUDIENCE`). */
|
|
3573
|
+
createMessageOaEventAudience(request: ZaloAdsCreateMessageOaEventAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateMessageOaEventAudienceResponse>;
|
|
3574
|
+
/** Tạo mới Nhóm đối tượng phát sinh sự kiện trên Kịch bản Tin nhắn cá nhân (`caType = 14` - `MESSAGE_PERSONAL_EVENT_AUDIENCE`). */
|
|
3575
|
+
createMessagePersonalEventAudience(request: ZaloAdsCreateMessagePersonalEventAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateMessagePersonalEventAudienceResponse>;
|
|
3576
|
+
/** Tạo mới Nhóm đối tượng từ Trung tâm Lead - Zalo Form (`caType = 10` - `FORM_AUDIENCE`). */
|
|
3577
|
+
createFormLeadAudience(request: ZaloAdsCreateFormLeadAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateFormLeadAudienceResponse>;
|
|
3578
|
+
/** Tạo mới Nhóm đối tượng từ Trung tâm Lead - Commerce Form (`caType = 15` - `COMMERCE_FORM_AUDIENCE`). */
|
|
3579
|
+
createCommerceFormAudience(request: ZaloAdsCreateCommerceFormAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateCommerceFormAudienceResponse>;
|
|
3580
|
+
/** Tạo mới Nhóm đối tượng từ Trung tâm Lead - Kịch bản Tin nhắn OA (`caType = 13` - `MESSAGE_OA_AUDIENCE`). */
|
|
3581
|
+
createMessageOaLeadAudience(request: ZaloAdsCreateMessageOaLeadAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateMessageOaLeadAudienceResponse>;
|
|
3582
|
+
/** Tạo mới Nhóm đối tượng từ Dữ liệu chuyển đổi Lead Signal (`caType = 16` - `LEAD_SIGNAL_AUDIENCE`). */
|
|
3583
|
+
createLeadSignalAudience(request: ZaloAdsCreateLeadSignalAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateLeadSignalAudienceResponse>;
|
|
3584
|
+
/** Ước tính quy mô đối tượng tiếp cận */
|
|
3585
|
+
estimateAudience(...args: Parameters<this["postApiAdEstimateaudience"]>): ReturnType<this["postApiAdEstimateaudience"]>;
|
|
3586
|
+
/** Danh sách toàn bộ nhóm đối tượng tùy chỉnh */
|
|
3587
|
+
listCustomAudiences(...args: Parameters<this["getApiCustomAudienceAll"]>): ReturnType<this["getApiCustomAudienceAll"]>;
|
|
3588
|
+
/** Danh sách cấu hình nhắm mục tiêu nâng cao */
|
|
3589
|
+
getListAdAdvanceTargeting(...args: Parameters<this["getApiAdGetlistadadvancetargeting"]>): ReturnType<this["getApiAdGetlistadadvancetargeting"]>;
|
|
3590
|
+
}
|
|
3591
|
+
|
|
3592
|
+
/**
|
|
3593
|
+
* Dịch vụ Báo cáo & Thống kê Hiệu quả Zalo Ads (Campaigns, Ads, Demographics, Overview, Custom Reports).
|
|
3594
|
+
*/
|
|
3595
|
+
|
|
3596
|
+
declare class ZaloReportsService {
|
|
3597
|
+
protected readonly client: ZaloSdkHttpClient;
|
|
3598
|
+
constructor(client: ZaloSdkHttpClient);
|
|
3599
|
+
getReportapiV2Ads(request: ZaloAdsGetReportapiV2AdsRequest, options?: RequestOptions): Promise<ZaloAdsGetReportapiV2AdsResponse>;
|
|
3600
|
+
getReportapiV2Campaigns(request?: ZaloAdsGetReportapiV2CampaignsRequest, options?: RequestOptions): Promise<ZaloAdsGetReportapiV2CampaignsResponse>;
|
|
3601
|
+
getReportapiV2UniqueUser(request: ZaloAdsGetReportapiV2UniqueUserRequest, options?: RequestOptions): Promise<ZaloAdsGetReportapiV2UniqueUserResponse>;
|
|
3602
|
+
getReportapiV3Campaigns(request: ZaloAdsGetReportapiV3CampaignsRequest, options?: RequestOptions): Promise<ZaloAdsGetReportapiV3CampaignsResponse>;
|
|
3603
|
+
getReportOverview(request: ZaloAdsGetReportOverviewRequest, options?: RequestOptions): Promise<ZaloAdsGetReportOverviewResponse>;
|
|
3604
|
+
getDemographicsReport(request: ZaloAdsGetDemographicsReportRequest, options?: RequestOptions): Promise<ZaloAdsGetDemographicsReportResponse>;
|
|
3605
|
+
getZaapiCampaignReportcampaign(request: ZaloAdsGetZaapiCampaignReportcampaignRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiCampaignReportcampaignResponse>;
|
|
3606
|
+
listCustomReports(request?: ZaloAdsListCustomReportsRequest, options?: RequestOptions): Promise<ZaloAdsListCustomReportsResponse>;
|
|
3607
|
+
upsertCustomReport(request: ZaloAdsUpsertCustomReportRequest, options?: RequestOptions): Promise<ZaloAdsUpsertCustomReportResponse>;
|
|
3608
|
+
deleteCustomReport(request: ZaloAdsDeleteCustomReportRequest, options?: RequestOptions): Promise<ZaloAdsDeleteCustomReportResponse>;
|
|
3609
|
+
listReportFilters(request: ZaloAdsListReportFiltersRequest, options?: RequestOptions): Promise<ZaloAdsListReportFiltersResponse>;
|
|
3610
|
+
/** Báo cáo hiệu quả chiến dịch (API V3 - Khuyên dùng) */
|
|
3611
|
+
getCampaignReportV3(...args: Parameters<this["getReportapiV3Campaigns"]>): ReturnType<this["getReportapiV3Campaigns"]>;
|
|
3612
|
+
/** Báo cáo hiệu quả chiến dịch (API V2) */
|
|
3613
|
+
getCampaignReportV2(...args: Parameters<this["getReportapiV2Campaigns"]>): ReturnType<this["getReportapiV2Campaigns"]>;
|
|
3614
|
+
/** Báo cáo hiệu quả quảng cáo (API V2) */
|
|
3615
|
+
getAdsReportV2(...args: Parameters<this["getReportapiV2Ads"]>): ReturnType<this["getReportapiV2Ads"]>;
|
|
3616
|
+
/** Báo cáo người dùng tiếp cận duy nhất (Unique Reach) */
|
|
3617
|
+
getUniqueUserReport(...args: Parameters<this["getReportapiV2UniqueUser"]>): ReturnType<this["getReportapiV2UniqueUser"]>;
|
|
3618
|
+
/** Báo cáo chiến dịch theo ngày/tháng (Legacy ZAAPI) */
|
|
3619
|
+
getCampaignReportLegacy(...args: Parameters<this["getZaapiCampaignReportcampaign"]>): ReturnType<this["getZaapiCampaignReportcampaign"]>;
|
|
3620
|
+
}
|
|
3621
|
+
|
|
3622
|
+
/**
|
|
3623
|
+
* Dịch vụ Quản lý Chuyển đổi & Zalo Pixel (Conversions, Standard Events, Lead Signals, Pixel Labels).
|
|
3624
|
+
*/
|
|
3625
|
+
|
|
3626
|
+
declare class ZaloConversionsService {
|
|
3627
|
+
protected readonly client: ZaloSdkHttpClient;
|
|
3628
|
+
constructor(client: ZaloSdkHttpClient);
|
|
3629
|
+
createConversion(request: ZaloAdsCreateConversionRequest, options?: RequestOptions): Promise<ZaloAdsCreateConversionResponse>;
|
|
3630
|
+
deleteConversion(request: ZaloAdsDeleteConversionRequest, options?: RequestOptions): Promise<ZaloAdsDeleteConversionResponse>;
|
|
3631
|
+
getApiConversionAll(request?: ZaloAdsGetApiConversionAllRequest, options?: RequestOptions): Promise<ZaloAdsGetApiConversionAllResponse>;
|
|
3632
|
+
getApiConversionStandardEvents(request?: ZaloAdsGetApiConversionStandardEventsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiConversionStandardEventsResponse>;
|
|
3633
|
+
listPersonalPixelLabels(request?: ZaloAdsListPersonalPixelLabelsRequest, options?: RequestOptions): Promise<ZaloAdsListPersonalPixelLabelsResponse>;
|
|
3634
|
+
/** Lấy danh sách tài khoản Zalo Official Account (OA) có dữ liệu chuyển đổi (Lead Signal) (`GET /api/ad/audience/leadSignal/oas`). */
|
|
3635
|
+
listLeadSignalOas(options?: RequestOptions): Promise<ZaloAdsListLeadSignalOasResponse>;
|
|
3636
|
+
/** Lấy danh sách rút gọn gồm ID và tên của toàn bộ các sự kiện chuyển đổi (Conversion) đã tạo trên tài khoản quảng cáo Zalo Ads (`GET /api/conversion/names`). */
|
|
3637
|
+
listConversionNames(request?: ZaloAdsListConversionNamesRequest, options?: RequestOptions): Promise<ZaloAdsListConversionNamesResponse>;
|
|
3638
|
+
/** Alias cho `listConversionNames` (`GET /api/conversion/names`). */
|
|
3639
|
+
getApiConversionNames(request?: ZaloAdsListConversionNamesRequest, options?: RequestOptions): Promise<ZaloAdsListConversionNamesResponse>;
|
|
3640
|
+
/** Danh sách toàn bộ sự kiện chuyển đổi */
|
|
3641
|
+
listConversions(...args: Parameters<this["getApiConversionAll"]>): ReturnType<this["getApiConversionAll"]>;
|
|
3642
|
+
/** Danh sách sự kiện chuyển đổi tiêu chuẩn */
|
|
3643
|
+
getConversionStandardEvents(...args: Parameters<this["getApiConversionStandardEvents"]>): ReturnType<this["getApiConversionStandardEvents"]>;
|
|
3644
|
+
}
|
|
2589
3645
|
|
|
2590
|
-
/**
|
|
3646
|
+
/**
|
|
3647
|
+
* Dịch vụ Quản lý Quy tắc Tự động Zalo Ads (Automated Rules CRUD, Status, History).
|
|
3648
|
+
*/
|
|
2591
3649
|
|
|
2592
|
-
declare class
|
|
2593
|
-
|
|
3650
|
+
declare class ZaloAutomatedRulesService {
|
|
3651
|
+
protected readonly client: ZaloSdkHttpClient;
|
|
2594
3652
|
constructor(client: ZaloSdkHttpClient);
|
|
2595
|
-
updateVideoAd(request: ZaloAdsUpdateVideoAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateVideoAdResponse>;
|
|
2596
|
-
createFlow(request: ZaloAdsCreateFlowRequest, options?: RequestOptions): Promise<ZaloAdsCreateFlowResponse>;
|
|
2597
|
-
updateFlow(request: ZaloAdsUpdateFlowRequest, options?: RequestOptions): Promise<ZaloAdsUpdateFlowResponse>;
|
|
2598
|
-
listFlowsByOfficialAccount(request: ZaloAdsListFlowsByOfficialAccountRequest, options?: RequestOptions): Promise<ZaloAdsListFlowsByOfficialAccountResponse>;
|
|
2599
|
-
changeCampaignStatus(request: ZaloAdsChangeCampaignStatusRequest, options?: RequestOptions): Promise<ZaloAdsChangeCampaignStatusResponse>;
|
|
2600
|
-
deleteCampaign(request: ZaloAdsDeleteCampaignRequest, options?: RequestOptions): Promise<ZaloAdsDeleteCampaignResponse>;
|
|
2601
|
-
createCustomAudience(request: ZaloAdsCreateCustomAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateCustomAudienceResponse>;
|
|
2602
|
-
createWebsiteCampaign(request: ZaloAdsCreateWebsiteCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateWebsiteCampaignResponse>;
|
|
2603
|
-
updateWebsiteAd(request: ZaloAdsUpdateWebsiteAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateWebsiteAdResponse>;
|
|
2604
|
-
createDisplayCampaign(request: ZaloAdsCreateDisplayCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateDisplayCampaignResponse>;
|
|
2605
|
-
updateDisplayAd(request: ZaloAdsUpdateDisplayAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateDisplayAdResponse>;
|
|
2606
|
-
createVideoCampaign(request: ZaloAdsCreateVideoCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateVideoCampaignResponse>;
|
|
2607
|
-
createEcommerceCampaign(request: ZaloAdsCreateEcommerceCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateEcommerceCampaignResponse>;
|
|
2608
|
-
/** Alias theo tên tool chuẩn `zalo_ads_create_commerce_campaign` trong Project Schema Zalo ADS (`campaignType = 22`). */
|
|
2609
|
-
createCommerceCampaign(request: ZaloAdsCreateCommerceCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateCommerceCampaignResponse>;
|
|
2610
|
-
createForm(request: ZaloAdsCreateFormRequest, options?: RequestOptions): Promise<ZaloAdsCreateFormResponse>;
|
|
2611
|
-
createFormCampaign(request: ZaloAdsCreateFormCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateFormCampaignResponse>;
|
|
2612
|
-
createMessageCampaign(request: ZaloAdsCreateMessageCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateMessageCampaignResponse>;
|
|
2613
|
-
createOfficialAccountCampaign(request: ZaloAdsCreateOfficialAccountCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateOfficialAccountCampaignResponse>;
|
|
2614
|
-
/** Alias theo tên tool chuẩn `zalo_ads_create_oa_campaign` trong Project Schema Zalo ADS (`campaignType = 3`). */
|
|
2615
|
-
createOaCampaign(request: ZaloAdsCreateOaCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateOaCampaignResponse>;
|
|
2616
|
-
createPostCampaign(request: ZaloAdsCreatePostCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreatePostCampaignResponse>;
|
|
2617
|
-
/** Alias theo tên tool chuẩn `zalo_ads_create_article_campaign` trong Project Schema Zalo ADS (`campaignType = 4`). */
|
|
2618
|
-
createArticleCampaign(request: ZaloAdsCreateArticleCampaignRequest, options?: RequestOptions): Promise<ZaloAdsCreateArticleCampaignResponse>;
|
|
2619
3653
|
listAutomatedRules(request?: ZaloAdsListAutomatedRulesRequest, options?: RequestOptions): Promise<ZaloAdsListAutomatedRulesResponse>;
|
|
2620
3654
|
createAutomatedRule(request: ZaloAdsCreateAutomatedRuleRequest, options?: RequestOptions): Promise<ZaloAdsCreateAutomatedRuleResponse>;
|
|
2621
3655
|
updateAutomatedRule(request: ZaloAdsUpdateAutomatedRuleRequest, options?: RequestOptions): Promise<ZaloAdsUpdateAutomatedRuleResponse>;
|
|
2622
3656
|
changeAutomatedRuleStatus(request: ZaloAdsChangeAutomatedRuleStatusRequest, options?: RequestOptions): Promise<ZaloAdsChangeAutomatedRuleStatusResponse>;
|
|
2623
3657
|
getAutomatedRuleHistory(request: ZaloAdsGetAutomatedRuleHistoryRequest, options?: RequestOptions): Promise<ZaloAdsGetAutomatedRuleHistoryResponse>;
|
|
2624
3658
|
deleteAutomatedRule(request: ZaloAdsDeleteAutomatedRuleRequest, options?: RequestOptions): Promise<ZaloAdsDeleteAutomatedRuleResponse>;
|
|
2625
|
-
|
|
2626
|
-
|
|
2627
|
-
|
|
2628
|
-
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
|
|
2632
|
-
|
|
2633
|
-
|
|
2634
|
-
|
|
2635
|
-
|
|
2636
|
-
|
|
2637
|
-
|
|
3659
|
+
}
|
|
3660
|
+
|
|
3661
|
+
/**
|
|
3662
|
+
* Dịch vụ Quản lý Kịch bản Tin nhắn OA (Message Flows get/create/update).
|
|
3663
|
+
*/
|
|
3664
|
+
|
|
3665
|
+
declare class ZaloFlowsService {
|
|
3666
|
+
protected readonly client: ZaloSdkHttpClient;
|
|
3667
|
+
constructor(client: ZaloSdkHttpClient);
|
|
3668
|
+
listFlowsByOfficialAccount(request: ZaloAdsListFlowsByOfficialAccountRequest, options?: RequestOptions): Promise<ZaloAdsListFlowsByOfficialAccountResponse>;
|
|
3669
|
+
createFlow(request: ZaloAdsCreateFlowRequest, options?: RequestOptions): Promise<ZaloAdsCreateFlowResponse>;
|
|
3670
|
+
updateFlow(request: ZaloAdsUpdateFlowRequest, options?: RequestOptions): Promise<ZaloAdsUpdateFlowResponse>;
|
|
3671
|
+
}
|
|
3672
|
+
|
|
3673
|
+
/**
|
|
3674
|
+
* Zalo Ads Media & Assets Service (`https://ads.zalo.me`).
|
|
3675
|
+
* Quản lý kho hình ảnh, video, upload CDN, lưu thư viện Media, cắt ảnh (crop)
|
|
3676
|
+
* và cung cấp các tiện ích upload+save trọn gói cùng bộ validation độc lập cho backend.
|
|
3677
|
+
*/
|
|
3678
|
+
|
|
3679
|
+
declare class ZaloMediaService {
|
|
3680
|
+
private readonly client;
|
|
3681
|
+
constructor(client: ZaloSdkHttpClient);
|
|
3682
|
+
/**
|
|
3683
|
+
* Lấy danh sách ảnh, video trong thư viện Zalo Ads theo khoảng thời gian (`GET /api/media/items`).
|
|
3684
|
+
*/
|
|
2638
3685
|
getApiMediaItems(request: ZaloAdsGetApiMediaItemsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiMediaItemsResponse>;
|
|
3686
|
+
/**
|
|
3687
|
+
* Alias cho `getApiMediaItems`.
|
|
3688
|
+
*/
|
|
3689
|
+
listMediaItems(request: ZaloAdsGetApiMediaItemsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiMediaItemsResponse>;
|
|
3690
|
+
/**
|
|
3691
|
+
* Lấy các tệp do thành viên hiện tại quản lý trong tài khoản quảng cáo (`GET /api/member/files`).
|
|
3692
|
+
*/
|
|
2639
3693
|
getApiMemberFiles(request?: ZaloAdsGetApiMemberFilesRequest, options?: RequestOptions): Promise<ZaloAdsGetApiMemberFilesResponse>;
|
|
2640
|
-
|
|
2641
|
-
|
|
2642
|
-
|
|
2643
|
-
|
|
3694
|
+
/**
|
|
3695
|
+
* Alias cho `getApiMemberFiles`.
|
|
3696
|
+
*/
|
|
3697
|
+
listMemberFiles(request?: ZaloAdsGetApiMemberFilesRequest, options?: RequestOptions): Promise<ZaloAdsGetApiMemberFilesResponse>;
|
|
3698
|
+
/**
|
|
3699
|
+
* Lấy danh sách nhóm tệp trong kho media (`GET /api/filegroups`).
|
|
3700
|
+
*/
|
|
3701
|
+
getApiFilegroups(request?: ZaloAdsGetApiFilegroupsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiFilegroupsResponse>;
|
|
3702
|
+
/**
|
|
3703
|
+
* Alias cho `getApiFilegroups`.
|
|
3704
|
+
*/
|
|
3705
|
+
listFilegroups(request?: ZaloAdsGetApiFilegroupsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiFilegroupsResponse>;
|
|
3706
|
+
/**
|
|
3707
|
+
* Lưu tài nguyên media vào thư viện Zalo Ads sau khi đã có URL ảnh/video và metadata (`POST /api/media/save`).
|
|
3708
|
+
* Phản hồi trả về `{ code: 0, data: <MediaId> }`.
|
|
3709
|
+
*/
|
|
3710
|
+
postApiMediaSave(request: ZaloAdsPostApiMediaSaveRequest, options?: RequestOptions): Promise<ZaloAdsPostApiMediaSaveResponse>;
|
|
3711
|
+
/**
|
|
3712
|
+
* Alias cho `postApiMediaSave`.
|
|
3713
|
+
*/
|
|
3714
|
+
saveMedia(request: ZaloAdsPostApiMediaSaveRequest, options?: RequestOptions): Promise<ZaloAdsPostApiMediaSaveResponse>;
|
|
3715
|
+
/**
|
|
3716
|
+
* Tải ảnh lên kho media của tài khoản quảng cáo (`POST /api/member/upload-image`).
|
|
3717
|
+
* Sử dụng multipart/form-data với trường `File` (chữ hoa). Trả về URL CDN Adtima.
|
|
3718
|
+
*/
|
|
3719
|
+
postApiMemberUploadImage(request: ZaloAdsPostApiMemberUploadImageRequest, options?: RequestOptions): Promise<ZaloAdsPostApiMemberUploadImageResponse>;
|
|
3720
|
+
/**
|
|
3721
|
+
* Alias cho `postApiMemberUploadImage`.
|
|
3722
|
+
*/
|
|
3723
|
+
uploadImage(request: ZaloAdsPostApiMemberUploadImageRequest, options?: RequestOptions): Promise<ZaloAdsPostApiMemberUploadImageResponse>;
|
|
3724
|
+
/**
|
|
3725
|
+
* Tải video lên kho media của tài khoản quảng cáo (`POST /api/member/upload-video`).
|
|
3726
|
+
* Định dạng chuẩn .MP4 (H.264), tối đa 150MB. Trả về URL video trên Adtima CDN.
|
|
3727
|
+
*/
|
|
3728
|
+
uploadVideo(request: ZaloAdsUploadVideoRequest, options?: RequestOptions): Promise<ZaloAdsUploadVideoResponse>;
|
|
3729
|
+
/**
|
|
3730
|
+
* Tải ảnh và thiết lập vùng crop tạo asset dùng cho quảng cáo Zalo Ads (`POST /zaapi/UploadCrop`).
|
|
3731
|
+
*/
|
|
3732
|
+
updateNewAds(request: ZaloAdsUpdateNewAdsRequest, options?: RequestOptions): Promise<ZaloAdsUpdateNewAdsResponse>;
|
|
3733
|
+
/**
|
|
3734
|
+
* Alias cho `updateNewAds` (`POST /zaapi/UploadCrop`).
|
|
3735
|
+
*/
|
|
3736
|
+
uploadCrop(request: ZaloAdsUpdateNewAdsRequest, options?: RequestOptions): Promise<ZaloAdsUpdateNewAdsResponse>;
|
|
3737
|
+
/**
|
|
3738
|
+
* Method tiện ích trọn gói: Tự động tải ảnh lên CDN (`/api/member/upload-image`)
|
|
3739
|
+
* VÀ lưu vào Thư viện Zalo Ads (`/api/media/save`) trong cùng 1 lời gọi duy nhất.
|
|
3740
|
+
*
|
|
3741
|
+
* Trả về MediaId, URL CDN và kích thước để gắn ngay vào Creative/Quảng cáo.
|
|
3742
|
+
*/
|
|
3743
|
+
uploadAndSaveImage(request: ZaloUploadAndSaveImageRequest, options?: RequestOptions): Promise<ZaloUploadAndSaveImageResult>;
|
|
3744
|
+
/**
|
|
3745
|
+
* Method tiện ích trọn gói cho Video: Tự động tải video lên CDN (`/api/member/upload-video`)
|
|
3746
|
+
* VÀ lưu vào Thư viện Zalo Ads (`/api/media/save`) để cấp MediaId.
|
|
3747
|
+
*/
|
|
3748
|
+
uploadAndSaveVideo(request: ZaloUploadAndSaveVideoRequest, options?: RequestOptions): Promise<ZaloUploadAndSaveVideoResult>;
|
|
3749
|
+
/**
|
|
3750
|
+
* Kiểm tra tính hợp lệ của tệp Ảnh theo quy chuẩn Zalo Ads:
|
|
3751
|
+
* - "No file chosen": Bắt buộc phải có tệp.
|
|
3752
|
+
* - Dung lượng: Tối đa 2MB (2 * 1024 * 1024 bytes).
|
|
3753
|
+
* - Kích thước: Tối thiểu 150x150 pixels.
|
|
3754
|
+
* - Định dạng: Hỗ trợ .JPG, .JPEG, .PNG.
|
|
3755
|
+
*
|
|
3756
|
+
* Trả về `{ isValid: boolean, status: 'VALID' | 'INVALID', errors: string[], metadata: {...} }`.
|
|
3757
|
+
*/
|
|
3758
|
+
validateImage(input: ValidateImageInput): MediaValidationResult;
|
|
3759
|
+
/**
|
|
3760
|
+
* Kiểm tra tính hợp lệ của tệp Video theo quy chuẩn Zalo Ads:
|
|
3761
|
+
* - "No file chosen": Bắt buộc phải có tệp.
|
|
3762
|
+
* - Định dạng: .MP4 H.264.
|
|
3763
|
+
* - Dung lượng: Tối đa 150MB (150 * 1024 * 1024 bytes).
|
|
3764
|
+
* - Thời lượng: Tối đa 60 giây.
|
|
3765
|
+
* - Tỉ lệ khung hình: 16:9, 9:16 hoặc 1:1.
|
|
3766
|
+
*
|
|
3767
|
+
* Trả về `{ isValid: boolean, status: 'VALID' | 'INVALID', errors: string[], metadata: {...} }`.
|
|
3768
|
+
*/
|
|
3769
|
+
validateVideo(input: ValidateVideoInput): MediaValidationResult;
|
|
3770
|
+
}
|
|
3771
|
+
|
|
3772
|
+
/**
|
|
3773
|
+
* Zalo Ads API facade service.
|
|
3774
|
+
* Kế thừa toàn bộ API Chiến dịch & Quảng cáo từ `ZaloCampaignsService`,
|
|
3775
|
+
* đồng thời tích hợp và điều phối các module chuyên biệt:
|
|
3776
|
+
* - `account`: Quản lý tài khoản, phân quyền BA, thanh toán (`ZaloAccountService`)
|
|
3777
|
+
* - `audiences`: Nhóm đối tượng tùy chỉnh, Lookalike, Event/Lead Audiences (`ZaloAudiencesService`)
|
|
3778
|
+
* - `reports`: Báo cáo chiến dịch, quảng cáo, nhân khẩu học, báo cáo tùy chỉnh (`ZaloReportsService`)
|
|
3779
|
+
* - `conversions`: Sự kiện chuyển đổi, Zalo Pixel (`ZaloConversionsService`)
|
|
3780
|
+
* - `automatedRules`: Quy tắc tự động (`ZaloAutomatedRulesService`)
|
|
3781
|
+
* - `flows`: Kịch bản tin nhắn OA (`ZaloFlowsService`)
|
|
3782
|
+
* - `media`: Thư viện tài nguyên & tải lên ảnh/video (`ZaloMediaService`)
|
|
3783
|
+
*/
|
|
3784
|
+
|
|
3785
|
+
declare class ZaloAdsService extends ZaloCampaignsService {
|
|
3786
|
+
readonly account: ZaloAccountService;
|
|
3787
|
+
readonly audiences: ZaloAudiencesService;
|
|
3788
|
+
readonly targeting: ZaloAudiencesService;
|
|
3789
|
+
readonly reports: ZaloReportsService;
|
|
3790
|
+
readonly conversions: ZaloConversionsService;
|
|
3791
|
+
readonly pixel: ZaloConversionsService;
|
|
3792
|
+
readonly automatedRules: ZaloAutomatedRulesService;
|
|
3793
|
+
readonly rules: ZaloAutomatedRulesService;
|
|
3794
|
+
readonly flows: ZaloFlowsService;
|
|
3795
|
+
readonly media: ZaloMediaService;
|
|
3796
|
+
readonly campaigns: ZaloCampaignsService;
|
|
3797
|
+
constructor(client: ZaloSdkHttpClient);
|
|
2644
3798
|
getApiWhoami(request?: ZaloAdsGetApiWhoamiRequest, options?: RequestOptions): Promise<ZaloAdsGetApiWhoamiResponse>;
|
|
3799
|
+
getApiPaymentTransactionHistory(request: ZaloAdsGetApiPaymentTransactionHistoryRequest, options?: RequestOptions): Promise<ZaloAdsGetApiPaymentTransactionHistoryResponse>;
|
|
3800
|
+
getApiBaAccountAllaccessors(request?: ZaloAdsGetApiBaAccountAllaccessorsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiBaAccountAllaccessorsResponse>;
|
|
3801
|
+
getApiBaAccountAllgrantedmembers(request?: ZaloAdsGetApiBaAccountAllgrantedmembersRequest, options?: RequestOptions): Promise<ZaloAdsGetApiBaAccountAllgrantedmembersResponse>;
|
|
3802
|
+
listAgencyCustomersWithBudget(request?: ZaloAdsListAgencyCustomersWithBudgetRequest, options?: RequestOptions): Promise<ZaloAdsListAgencyCustomersWithBudgetResponse>;
|
|
3803
|
+
getApiNotifiesHeader(request?: ZaloAdsGetApiNotifiesHeaderRequest, options?: RequestOptions): Promise<ZaloAdsGetApiNotifiesHeaderResponse>;
|
|
3804
|
+
getApiLpNews(request?: ZaloAdsGetApiLpNewsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiLpNewsResponse>;
|
|
3805
|
+
postApiAdEstimateaudience(request: ZaloAdsPostApiAdEstimateaudienceRequest, options?: RequestOptions): Promise<ZaloAdsPostApiAdEstimateaudienceResponse>;
|
|
3806
|
+
getApiAdGetlistadadvancetargeting(request?: ZaloAdsGetApiAdGetlistadadvancetargetingRequest, options?: RequestOptions): Promise<ZaloAdsGetApiAdGetlistadadvancetargetingResponse>;
|
|
3807
|
+
getApiCustomAudienceAll(request?: ZaloAdsGetApiCustomAudienceAllRequest, options?: RequestOptions): Promise<ZaloAdsGetApiCustomAudienceAllResponse>;
|
|
3808
|
+
createCustomAudience(request: ZaloAdsCreateCustomAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateCustomAudienceResponse>;
|
|
3809
|
+
deleteCustomAudience(request: ZaloAdsDeleteCustomAudienceRequest, options?: RequestOptions): Promise<ZaloAdsDeleteCustomAudienceResponse>;
|
|
3810
|
+
uploadCustomAudiencePhoneList(request: ZaloAdsUploadCustomAudiencePhoneListRequest, options?: RequestOptions): Promise<ZaloAdsUploadCustomAudiencePhoneListResponse>;
|
|
3811
|
+
/** Tạo mới 'Nhóm đối tượng đã lưu' (`caType = 1` - `DEFAULT`) trên Zalo Ads (`POST /api/ad/audience`). */
|
|
3812
|
+
createSavedAudience(request: ZaloAdsCreateSavedAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateSavedAudienceResponse>;
|
|
3813
|
+
/** Tạo mới Nhóm đối tượng từ danh sách Số điện thoại (`caType = 3` - `PHONE_LIST`). */
|
|
3814
|
+
createPhoneAudience(request: ZaloAdsCreatePhoneAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreatePhoneAudienceResponse>;
|
|
3815
|
+
/** Tạo mới Nhóm đối tượng tương tự Lookalike (`caType = 6` - `LOOKALIKE`). */
|
|
3816
|
+
createLookalikeAudience(request: ZaloAdsCreateLookalikeAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateLookalikeAudienceResponse>;
|
|
3817
|
+
/** Tạo mới Nhóm đối tượng phát sinh sự kiện trên Zalo Form (`caType = 12` - `FORM_EVENT_AUDIENCE`). */
|
|
3818
|
+
createFormEventAudience(request: ZaloAdsCreateFormEventAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateFormEventAudienceResponse>;
|
|
3819
|
+
/** Tạo mới Nhóm đối tượng phát sinh sự kiện trên Kịch bản Tin nhắn OA (`caType = 11` - `MESSAGE_AUDIENCE`). */
|
|
3820
|
+
createMessageOaEventAudience(request: ZaloAdsCreateMessageOaEventAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateMessageOaEventAudienceResponse>;
|
|
3821
|
+
/** Tạo mới Nhóm đối tượng phát sinh sự kiện trên Kịch bản Tin nhắn cá nhân (`caType = 14` - `MESSAGE_PERSONAL_EVENT_AUDIENCE`). */
|
|
3822
|
+
createMessagePersonalEventAudience(request: ZaloAdsCreateMessagePersonalEventAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateMessagePersonalEventAudienceResponse>;
|
|
3823
|
+
/** Tạo mới Nhóm đối tượng từ Trung tâm Lead - Zalo Form (`caType = 10` - `FORM_AUDIENCE`). */
|
|
3824
|
+
createFormLeadAudience(request: ZaloAdsCreateFormLeadAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateFormLeadAudienceResponse>;
|
|
3825
|
+
/** Tạo mới Nhóm đối tượng từ Trung tâm Lead - Commerce Form (`caType = 15` - `COMMERCE_FORM_AUDIENCE`). */
|
|
3826
|
+
createCommerceFormAudience(request: ZaloAdsCreateCommerceFormAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateCommerceFormAudienceResponse>;
|
|
3827
|
+
/** Tạo mới Nhóm đối tượng từ Trung tâm Lead - Kịch bản Tin nhắn OA (`caType = 13` - `MESSAGE_OA_AUDIENCE`). */
|
|
3828
|
+
createMessageOaLeadAudience(request: ZaloAdsCreateMessageOaLeadAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateMessageOaLeadAudienceResponse>;
|
|
3829
|
+
/** Tạo mới Nhóm đối tượng từ Dữ liệu chuyển đổi Lead Signal (`caType = 16` - `LEAD_SIGNAL_AUDIENCE`). */
|
|
3830
|
+
createLeadSignalAudience(request: ZaloAdsCreateLeadSignalAudienceRequest, options?: RequestOptions): Promise<ZaloAdsCreateLeadSignalAudienceResponse>;
|
|
2645
3831
|
getReportapiV2Ads(request: ZaloAdsGetReportapiV2AdsRequest, options?: RequestOptions): Promise<ZaloAdsGetReportapiV2AdsResponse>;
|
|
2646
3832
|
getReportapiV2Campaigns(request?: ZaloAdsGetReportapiV2CampaignsRequest, options?: RequestOptions): Promise<ZaloAdsGetReportapiV2CampaignsResponse>;
|
|
2647
|
-
getReportapiV2UniqueUser(request
|
|
3833
|
+
getReportapiV2UniqueUser(request: ZaloAdsGetReportapiV2UniqueUserRequest, options?: RequestOptions): Promise<ZaloAdsGetReportapiV2UniqueUserResponse>;
|
|
2648
3834
|
getReportapiV3Campaigns(request: ZaloAdsGetReportapiV3CampaignsRequest, options?: RequestOptions): Promise<ZaloAdsGetReportapiV3CampaignsResponse>;
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
|
|
2652
|
-
getZaapiGetallpages(request?: ZaloAdsGetZaapiGetallpagesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetallpagesResponse>;
|
|
2653
|
-
getZaapiGetownedarticles(request?: ZaloAdsGetZaapiGetownedarticlesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetownedarticlesResponse>;
|
|
2654
|
-
getZaapiGetownedpages(request?: ZaloAdsGetZaapiGetownedpagesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetownedpagesResponse>;
|
|
2655
|
-
listAgencyCustomersWithBudget(request: ZaloAdsListAgencyCustomersWithBudgetRequest, options?: RequestOptions): Promise<ZaloAdsListAgencyCustomersWithBudgetResponse>;
|
|
3835
|
+
getReportOverview(request: ZaloAdsGetReportOverviewRequest, options?: RequestOptions): Promise<ZaloAdsGetReportOverviewResponse>;
|
|
3836
|
+
getDemographicsReport(request: ZaloAdsGetDemographicsReportRequest, options?: RequestOptions): Promise<ZaloAdsGetDemographicsReportResponse>;
|
|
3837
|
+
getZaapiCampaignReportcampaign(request: ZaloAdsGetZaapiCampaignReportcampaignRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiCampaignReportcampaignResponse>;
|
|
2656
3838
|
listCustomReports(request?: ZaloAdsListCustomReportsRequest, options?: RequestOptions): Promise<ZaloAdsListCustomReportsResponse>;
|
|
2657
|
-
|
|
2658
|
-
|
|
3839
|
+
upsertCustomReport(request: ZaloAdsUpsertCustomReportRequest, options?: RequestOptions): Promise<ZaloAdsUpsertCustomReportResponse>;
|
|
3840
|
+
deleteCustomReport(request: ZaloAdsDeleteCustomReportRequest, options?: RequestOptions): Promise<ZaloAdsDeleteCustomReportResponse>;
|
|
3841
|
+
listReportFilters(request: ZaloAdsListReportFiltersRequest, options?: RequestOptions): Promise<ZaloAdsListReportFiltersResponse>;
|
|
3842
|
+
createConversion(request: ZaloAdsCreateConversionRequest, options?: RequestOptions): Promise<ZaloAdsCreateConversionResponse>;
|
|
3843
|
+
deleteConversion(request: ZaloAdsDeleteConversionRequest, options?: RequestOptions): Promise<ZaloAdsDeleteConversionResponse>;
|
|
3844
|
+
getApiConversionAll(request?: ZaloAdsGetApiConversionAllRequest, options?: RequestOptions): Promise<ZaloAdsGetApiConversionAllResponse>;
|
|
3845
|
+
getApiConversionStandardEvents(request?: ZaloAdsGetApiConversionStandardEventsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiConversionStandardEventsResponse>;
|
|
2659
3846
|
listPersonalPixelLabels(request?: ZaloAdsListPersonalPixelLabelsRequest, options?: RequestOptions): Promise<ZaloAdsListPersonalPixelLabelsResponse>;
|
|
2660
|
-
|
|
3847
|
+
/** Lấy danh sách tài khoản Zalo Official Account (OA) có dữ liệu chuyển đổi (Lead Signal) (`GET /api/ad/audience/leadSignal/oas`). */
|
|
3848
|
+
listLeadSignalOas(options?: RequestOptions): Promise<ZaloAdsListLeadSignalOasResponse>;
|
|
3849
|
+
/** Lấy danh sách rút gọn gồm ID và tên của toàn bộ các sự kiện chuyển đổi (Conversion) đã tạo trên tài khoản quảng cáo Zalo Ads (`GET /api/conversion/names`). */
|
|
3850
|
+
listConversionNames(request?: ZaloAdsListConversionNamesRequest, options?: RequestOptions): Promise<ZaloAdsListConversionNamesResponse>;
|
|
3851
|
+
/** Alias cho `listConversionNames` (`GET /api/conversion/names`). */
|
|
3852
|
+
getApiConversionNames(request?: ZaloAdsListConversionNamesRequest, options?: RequestOptions): Promise<ZaloAdsListConversionNamesResponse>;
|
|
3853
|
+
listAutomatedRules(request?: ZaloAdsListAutomatedRulesRequest, options?: RequestOptions): Promise<ZaloAdsListAutomatedRulesResponse>;
|
|
3854
|
+
createAutomatedRule(request: ZaloAdsCreateAutomatedRuleRequest, options?: RequestOptions): Promise<ZaloAdsCreateAutomatedRuleResponse>;
|
|
3855
|
+
updateAutomatedRule(request: ZaloAdsUpdateAutomatedRuleRequest, options?: RequestOptions): Promise<ZaloAdsUpdateAutomatedRuleResponse>;
|
|
3856
|
+
changeAutomatedRuleStatus(request: ZaloAdsChangeAutomatedRuleStatusRequest, options?: RequestOptions): Promise<ZaloAdsChangeAutomatedRuleStatusResponse>;
|
|
3857
|
+
getAutomatedRuleHistory(request: ZaloAdsGetAutomatedRuleHistoryRequest, options?: RequestOptions): Promise<ZaloAdsGetAutomatedRuleHistoryResponse>;
|
|
3858
|
+
deleteAutomatedRule(request: ZaloAdsDeleteAutomatedRuleRequest, options?: RequestOptions): Promise<ZaloAdsDeleteAutomatedRuleResponse>;
|
|
3859
|
+
listFlowsByOfficialAccount(request: ZaloAdsListFlowsByOfficialAccountRequest, options?: RequestOptions): Promise<ZaloAdsListFlowsByOfficialAccountResponse>;
|
|
3860
|
+
createFlow(request: ZaloAdsCreateFlowRequest, options?: RequestOptions): Promise<ZaloAdsCreateFlowResponse>;
|
|
3861
|
+
updateFlow(request: ZaloAdsUpdateFlowRequest, options?: RequestOptions): Promise<ZaloAdsUpdateFlowResponse>;
|
|
3862
|
+
getApiFilegroups(request?: ZaloAdsGetApiFilegroupsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiFilegroupsResponse>;
|
|
3863
|
+
getApiMediaItems(request: ZaloAdsGetApiMediaItemsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiMediaItemsResponse>;
|
|
3864
|
+
getApiMemberFiles(request?: ZaloAdsGetApiMemberFilesRequest, options?: RequestOptions): Promise<ZaloAdsGetApiMemberFilesResponse>;
|
|
2661
3865
|
postApiMediaSave(request: ZaloAdsPostApiMediaSaveRequest, options?: RequestOptions): Promise<ZaloAdsPostApiMediaSaveResponse>;
|
|
2662
3866
|
postApiMemberUploadImage(request: ZaloAdsPostApiMemberUploadImageRequest, options?: RequestOptions): Promise<ZaloAdsPostApiMemberUploadImageResponse>;
|
|
2663
|
-
|
|
2664
|
-
|
|
2665
|
-
updateEcommerceAd(request: ZaloAdsUpdateEcommerceAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateEcommerceAdResponse>;
|
|
2666
|
-
/** Alias theo tên tool chuẩn `zalo_ads_update_commerce_ad` trong Project Schema Zalo ADS (`Type = 23`, gắn `MiniPageId`). */
|
|
2667
|
-
updateCommerceAd(request: ZaloAdsUpdateCommerceAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateCommerceAdResponse>;
|
|
2668
|
-
updateFormAd(request: ZaloAdsUpdateFormAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateFormAdResponse>;
|
|
2669
|
-
updateMessageAd(request: ZaloAdsUpdateMessageAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateMessageAdResponse>;
|
|
2670
|
-
updateNewAds(request: ZaloAdsUpdateNewAdsRequest, options?: RequestOptions): Promise<ZaloAdsUpdateNewAdsResponse>;
|
|
2671
|
-
updateOfficialAccountAd(request: ZaloAdsUpdateOfficialAccountAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateOfficialAccountAdResponse>;
|
|
2672
|
-
/** Alias theo tên tool chuẩn `zalo_ads_update_oa_ad` trong Project Schema Zalo ADS (`Type = 2`, `Action = 6`). */
|
|
2673
|
-
updateOaAd(request: ZaloAdsUpdateOaAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateOaAdResponse>;
|
|
2674
|
-
updatePostAd(request: ZaloAdsUpdatePostAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdatePostAdResponse>;
|
|
2675
|
-
/** Alias theo tên tool chuẩn `zalo_ads_update_article_ad` trong Project Schema Zalo ADS (`Type = 3`, gắn `ZaloFeedId`). */
|
|
2676
|
-
updateArticleAd(request: ZaloAdsUpdateArticleAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateArticleAdResponse>;
|
|
2677
|
-
uploadCustomAudiencePhoneList(request: ZaloAdsUploadCustomAudiencePhoneListRequest, options?: RequestOptions): Promise<ZaloAdsUploadCustomAudiencePhoneListResponse>;
|
|
3867
|
+
/** Alias tiện lợi cho `postApiMemberUploadImage` (`POST /api/member/upload-image`). */
|
|
3868
|
+
uploadImage(request: ZaloAdsPostApiMemberUploadImageRequest, options?: RequestOptions): Promise<ZaloAdsPostApiMemberUploadImageResponse>;
|
|
2678
3869
|
uploadVideo(request: ZaloAdsUploadVideoRequest, options?: RequestOptions): Promise<ZaloAdsUploadVideoResponse>;
|
|
2679
|
-
|
|
3870
|
+
/**
|
|
3871
|
+
* Kiểm tra tính hợp lệ của tệp Ảnh theo quy chuẩn Zalo Ads (độc lập cho backend).
|
|
3872
|
+
* Tiêu chí: Có file, Dung lượng tối đa 2MB, Kích thước tối thiểu 150x150, Định dạng JPG/PNG.
|
|
3873
|
+
*/
|
|
3874
|
+
validateImage(input: ValidateImageInput): MediaValidationResult;
|
|
3875
|
+
/**
|
|
3876
|
+
* Kiểm tra tính hợp lệ của tệp Video theo quy chuẩn Zalo Ads (độc lập cho backend).
|
|
3877
|
+
* Tiêu chí: Có file, Định dạng .MP4 H.264, Dung lượng tối đa 150MB, Thời lượng tối đa 60s, Tỉ lệ 16:9, 9:16 hoặc 1:1.
|
|
3878
|
+
*/
|
|
3879
|
+
validateVideo(input: ValidateVideoInput): MediaValidationResult;
|
|
2680
3880
|
}
|
|
2681
3881
|
|
|
2682
3882
|
/** Lấy cấu hình kết nối chat widget của Zalo Official Account, gồm loại đăng nhập và các endpoint dịch vụ. Đây là auth-sensitive detail tool thuộc lane zalo-ads-chat; dùng khi đã có OA ID và cần cấu hình kết nối chat hợp lệ. Dữ liệu khóa đăng nhập dạng opaque trong phản hồi không được hiển thị hoặc lưu trữ ngoài luồng bảo mật. */
|
|
@@ -2780,15 +3980,23 @@ type ZaloFormsExportFormLeadReportResponse = {
|
|
|
2780
3980
|
/** Tên tệp .xlsx lấy từ Content-Disposition, nếu executor cung cấp. */
|
|
2781
3981
|
fileName?: string;
|
|
2782
3982
|
contentType?: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
|
|
2783
|
-
[key: string]: unknown;
|
|
2784
3983
|
};
|
|
2785
|
-
/** Lấy dữ liệu audience targeting có thể dùng để loại trừ cho một Official Account. Đây là helper tool thuộc lane zalo-ads-form; dùng trước khi cấu hình loại trừ đối tượng nếu giao diện form cần danh sách lựa chọn nguồn.
|
|
3984
|
+
/** Lấy dữ liệu audience targeting có thể dùng để loại trừ cho một Official Account. Đây là helper tool thuộc lane zalo-ads-form; dùng trước khi cấu hình loại trừ đối tượng nếu giao diện form cần danh sách lựa chọn nguồn. */
|
|
2786
3985
|
type ZaloFormsListAudienceExclusionTargetingRequest = {
|
|
2787
3986
|
/** ID Official Account cần lấy lựa chọn audience loại trừ. */
|
|
2788
3987
|
oaId: string;
|
|
2789
3988
|
};
|
|
3989
|
+
type ZaloFormsAudienceExclusionTargetingItem = {
|
|
3990
|
+
id: string;
|
|
3991
|
+
name: string;
|
|
3992
|
+
oaId: string;
|
|
3993
|
+
totalLeads?: number;
|
|
3994
|
+
createdTime?: number;
|
|
3995
|
+
};
|
|
2790
3996
|
type ZaloFormsListAudienceExclusionTargetingResponse = {
|
|
2791
|
-
|
|
3997
|
+
msg: string;
|
|
3998
|
+
code: number;
|
|
3999
|
+
data: Array<ZaloFormsAudienceExclusionTargetingItem>;
|
|
2792
4000
|
};
|
|
2793
4001
|
/** Lấy lead phát sinh từ hội thoại theo OA, scene, trạng thái, thời gian và phân trang. Đây là entry tool thuộc lane zalo-ads-conversation-leads; dùng khi nguồn lead là hội thoại thay vì Zalo Form. Phân biệt với lead form: dùng sceneIds, không dùng formIds. */
|
|
2794
4002
|
type ZaloFormsListConversationLeadsRequest = {
|
|
@@ -2811,8 +4019,26 @@ type ZaloFormsListConversationLeadsRequest = {
|
|
|
2811
4019
|
/** Danh sách scene ID phân cách dấu phẩy, có thể bỏ trống. */
|
|
2812
4020
|
sceneIds?: string;
|
|
2813
4021
|
};
|
|
4022
|
+
type ZaloFormsConversationLeadItem = {
|
|
4023
|
+
id: string;
|
|
4024
|
+
oaId: string;
|
|
4025
|
+
userId: string;
|
|
4026
|
+
userName: string;
|
|
4027
|
+
userAvatar?: string;
|
|
4028
|
+
phone?: string;
|
|
4029
|
+
status: number;
|
|
4030
|
+
sceneId?: string;
|
|
4031
|
+
sceneName?: string;
|
|
4032
|
+
labelIds?: Array<string>;
|
|
4033
|
+
note?: string;
|
|
4034
|
+
createdTime: number;
|
|
4035
|
+
updatedTime?: number;
|
|
4036
|
+
};
|
|
2814
4037
|
type ZaloFormsListConversationLeadsResponse = {
|
|
2815
|
-
|
|
4038
|
+
msg: string;
|
|
4039
|
+
code: number;
|
|
4040
|
+
total: number;
|
|
4041
|
+
data: Array<ZaloFormsConversationLeadItem>;
|
|
2816
4042
|
};
|
|
2817
4043
|
/** Lấy lead được gửi từ Zalo Form theo OA, form, trạng thái, thời gian và phân trang. Đây là entry tool thuộc lane zalo-ads-form-leads; dùng khi cần tra cứu hoặc xử lý lead form. Truyền formIds là chuỗi ID form phân cách bằng dấu phẩy từ tool danh sách form; để trống để không lọc theo form. */
|
|
2818
4044
|
type ZaloFormsListFormLeadsRequest = {
|
|
@@ -2839,15 +4065,33 @@ type ZaloFormsListFormLeadsRequest = {
|
|
|
2839
4065
|
/** Chế độ commerce. */
|
|
2840
4066
|
isCommerce: boolean;
|
|
2841
4067
|
};
|
|
4068
|
+
type ZaloFormsLeadAnswerItem = {
|
|
4069
|
+
questionId: string;
|
|
4070
|
+
title: string;
|
|
4071
|
+
value: string;
|
|
4072
|
+
};
|
|
4073
|
+
type ZaloFormsLeadItem = {
|
|
4074
|
+
id: string;
|
|
4075
|
+
formId: string;
|
|
4076
|
+
formName?: string;
|
|
4077
|
+
oaId: string;
|
|
4078
|
+
userId?: string;
|
|
4079
|
+
userName?: string;
|
|
4080
|
+
phone?: string;
|
|
4081
|
+
status: number;
|
|
4082
|
+
labelIds?: Array<string>;
|
|
4083
|
+
note?: string;
|
|
4084
|
+
createdTime: number;
|
|
4085
|
+
updatedTime?: number;
|
|
4086
|
+
answers?: Array<ZaloFormsLeadAnswerItem>;
|
|
4087
|
+
};
|
|
2842
4088
|
type ZaloFormsListFormLeadsResponse = {
|
|
2843
4089
|
msg: string;
|
|
2844
4090
|
/** 0 là thành công. */
|
|
2845
4091
|
code: number;
|
|
2846
|
-
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
}>;
|
|
2850
|
-
[key: string]: unknown;
|
|
4092
|
+
total?: number;
|
|
4093
|
+
/** Danh sách bản ghi lead thu từ Zalo Form. */
|
|
4094
|
+
data: Array<ZaloFormsLeadItem>;
|
|
2851
4095
|
};
|
|
2852
4096
|
/** Lấy danh sách Zalo Form quản trị theo Official Account và khoảng thời gian, kèm trạng thái cùng các chỉ số xem/gửi. Dùng oaId để tra cứu, không thay bằng formId; lấy data[].id trả về làm formId cho các thao tác Form management tiếp theo. data[].status: 1 = Tạo mới, 2 = Không chạy - Form chờ duyệt, 3 = Đang mở, 4 = Không chạy - Form bị từ chối. */
|
|
2853
4097
|
type ZaloFormsListManagedFormsByOfficialAccountRequest = {
|
|
@@ -2903,23 +4147,21 @@ type ZaloFormsListManagedFormsByOfficialAccountResponse = {
|
|
|
2903
4147
|
totalGetForm: string;
|
|
2904
4148
|
/** Cờ upstream với đúng chữ hoa/thường, cho biết yêu cầu mỗi người trả lời chỉ gửi một phản hồi duy nhất. */
|
|
2905
4149
|
RequiresUniqueResponse: boolean;
|
|
2906
|
-
[key: string]: unknown;
|
|
2907
4150
|
}>;
|
|
2908
4151
|
/** Tổng số form khớp với OA và khoảng thời gian. */
|
|
2909
4152
|
total: number;
|
|
2910
|
-
[key: string]: unknown;
|
|
2911
4153
|
};
|
|
2912
|
-
/** Lấy danh sách
|
|
4154
|
+
/** Lấy danh sách biểu mẫu (Zalo Form hoặc Commerce Form) của một Official Account theo khoảng thời gian, loại form (`type`) và chế độ thương mại (`isCommerce`). Phân loại: (1) Zalo Form: `type=1, isCommerce=false`; (2) Commerce Form: `type=5, isCommerce=true`. */
|
|
2913
4155
|
type ZaloFormsListSimpleFormsByOfficialAccountRequest = {
|
|
2914
|
-
/** ID Official Account
|
|
4156
|
+
/** ID Official Account dạng mã hóa chuỗi trên form.ads.zalo.me (ví dụ: "J4UB9MRE497YDQKKK"). */
|
|
2915
4157
|
oaId: string;
|
|
2916
|
-
/** Mã
|
|
2917
|
-
type: number;
|
|
4158
|
+
/** Mã phân loại biểu mẫu: 1 = Zalo Form (isCommerce=false), 5 = Commerce Form (isCommerce=true). */
|
|
4159
|
+
type: 1 | 5 | number;
|
|
2918
4160
|
/** Unix epoch giây, cuối khoảng. */
|
|
2919
4161
|
toTime: number;
|
|
2920
|
-
/** Unix epoch giây, đầu khoảng. */
|
|
4162
|
+
/** Unix epoch giây, đầu khoảng (mặc định: 1588266000). */
|
|
2921
4163
|
fromTime: number;
|
|
2922
|
-
/** Chế độ lọc commerce. */
|
|
4164
|
+
/** Chế độ lọc commerce: false cho Zalo Form (type=1), true cho Commerce Form (type=5). */
|
|
2923
4165
|
isCommerce: boolean;
|
|
2924
4166
|
};
|
|
2925
4167
|
type ZaloFormsListSimpleFormsByOfficialAccountResponse = {
|
|
@@ -2927,7 +4169,7 @@ type ZaloFormsListSimpleFormsByOfficialAccountResponse = {
|
|
|
2927
4169
|
/** 0 là thành công. */
|
|
2928
4170
|
code: number;
|
|
2929
4171
|
data: Array<{
|
|
2930
|
-
/** ID form, dùng làm formIds khi lọc lead form. */
|
|
4172
|
+
/** ID form, dùng làm formIds khi lọc lead form hoặc tạo nhóm đối tượng. */
|
|
2931
4173
|
id: string;
|
|
2932
4174
|
/** ID Official Account. */
|
|
2933
4175
|
oaId: string;
|
|
@@ -2942,25 +4184,50 @@ type ZaloFormsListSimpleFormsByOfficialAccountResponse = {
|
|
|
2942
4184
|
createAt: number;
|
|
2943
4185
|
formName: string;
|
|
2944
4186
|
oaAvatar: string;
|
|
2945
|
-
/**
|
|
4187
|
+
/** Cờ cấu hình xét duyệt của biểu mẫu (mặc định là 0). */
|
|
2946
4188
|
admission: number;
|
|
2947
|
-
/** Chuỗi
|
|
4189
|
+
/** Chuỗi số tổng lượt xem. */
|
|
2948
4190
|
totalView: string;
|
|
2949
4191
|
/** Unix epoch giây. */
|
|
2950
4192
|
updatedAt: number;
|
|
2951
4193
|
coverPhoto: string;
|
|
2952
4194
|
description: string;
|
|
2953
4195
|
isAnonymous: boolean;
|
|
2954
|
-
/** Chuỗi
|
|
4196
|
+
/** Chuỗi số tổng lượt gửi. */
|
|
2955
4197
|
totalSubmit: string;
|
|
2956
|
-
/** Chuỗi
|
|
4198
|
+
/** Chuỗi số tổng lượt nhận form. */
|
|
2957
4199
|
totalGetForm: string;
|
|
2958
4200
|
/** Giữ nguyên chữ hoa/thường của upstream. */
|
|
2959
4201
|
RequiresUniqueResponse: boolean;
|
|
2960
|
-
|
|
4202
|
+
/** Mã loại giao diện mẫu đối với Commerce Form (isCommerce=true, ví dụ: 7). */
|
|
4203
|
+
templateType?: number;
|
|
4204
|
+
/** Thời điểm gửi form gần nhất (Unix epoch giây). */
|
|
4205
|
+
lastSubmitTime?: number;
|
|
2961
4206
|
}>;
|
|
2962
4207
|
total: number;
|
|
2963
|
-
|
|
4208
|
+
};
|
|
4209
|
+
/** Lấy danh sách kịch bản tin nhắn hội thoại (Conversation Scenarios) của một Official Account (`oaId`) trên hệ thống Lead Center (`form.ads.zalo.me`). */
|
|
4210
|
+
type ZaloFormsListScenariosByOfficialAccountRequest = {
|
|
4211
|
+
/** ID Official Account dạng mã hóa chuỗi trên form.ads.zalo.me (ví dụ: "J4UB9MRE497YDQKKK"). */
|
|
4212
|
+
oaId: string;
|
|
4213
|
+
};
|
|
4214
|
+
type ZaloFormsScenarioItem = {
|
|
4215
|
+
/** ID định danh kịch bản tin nhắn (ví dụ: "bf34d907e142081c5153"). Dùng làm sceneIds khi lọc lead hội thoại. */
|
|
4216
|
+
id: string;
|
|
4217
|
+
/** ID Official Account sở hữu kịch bản. */
|
|
4218
|
+
oaId: string;
|
|
4219
|
+
/** Tên kịch bản tin nhắn hiển thị trên giao diện (ví dụ: "Kịch bản chào hỏi"). */
|
|
4220
|
+
scenarioName: string;
|
|
4221
|
+
/** Thời điểm tạo kịch bản (Unix epoch giây). */
|
|
4222
|
+
createAt: number;
|
|
4223
|
+
/** Thời điểm cập nhật kịch bản gần nhất (Unix epoch giây). */
|
|
4224
|
+
updateAt: number;
|
|
4225
|
+
};
|
|
4226
|
+
type ZaloFormsListScenariosByOfficialAccountResponse = {
|
|
4227
|
+
msg: string;
|
|
4228
|
+
total?: number;
|
|
4229
|
+
code: number;
|
|
4230
|
+
data?: Array<ZaloFormsScenarioItem>;
|
|
2964
4231
|
};
|
|
2965
4232
|
/** Cập nhật chu kỳ thông báo lead cho một Zalo Form thuộc Official Account đã chọn. Đây là mutation tool thuộc lane zalo-ads-form; dùng khi cần đổi tần suất thông báo nhưng không thay đổi trạng thái bật/tắt, vì enable và disable là hai thao tác riêng. */
|
|
2966
4233
|
type ZaloFormsUpdateFormLeadNotificationIntervalRequest = {
|
|
@@ -2987,9 +4254,7 @@ type ZaloFormsUpdateFormLeadNotificationIntervalResponse = {
|
|
|
2987
4254
|
formName: string;
|
|
2988
4255
|
/** Chu kỳ thông báo hiện tại sau cập nhật. Giá trị 0 xác nhận nhận thông báo ngay khi có lead. */
|
|
2989
4256
|
interval: number;
|
|
2990
|
-
[key: string]: unknown;
|
|
2991
4257
|
};
|
|
2992
|
-
[key: string]: unknown;
|
|
2993
4258
|
};
|
|
2994
4259
|
type ZaloFormsAuthSessionOaItem = {
|
|
2995
4260
|
/** Mã vai trò trên OA (ví dụ: 1 = Admin). */
|
|
@@ -3008,7 +4273,6 @@ type ZaloFormsAuthSessionOaItem = {
|
|
|
3008
4273
|
status?: number;
|
|
3009
4274
|
apiUploadEnabled?: boolean;
|
|
3010
4275
|
adMessageEnabled?: boolean;
|
|
3011
|
-
[key: string]: unknown;
|
|
3012
4276
|
};
|
|
3013
4277
|
/** Lấy thông tin phiên đăng nhập và danh sách Official Accounts (kèm mapping giữa noisedOaId dạng số và oaId dạng mã hóa) trên form.ads.zalo.me. */
|
|
3014
4278
|
type ZaloFormsGetAuthSessionResponse = {
|
|
@@ -3020,12 +4284,10 @@ type ZaloFormsGetAuthSessionResponse = {
|
|
|
3020
4284
|
avatar: string;
|
|
3021
4285
|
token: string;
|
|
3022
4286
|
isInVN?: boolean;
|
|
3023
|
-
roleWLReview?:
|
|
4287
|
+
roleWLReview?: string[];
|
|
3024
4288
|
oaNotifyLead?: ZaloFormsAuthSessionOaItem;
|
|
3025
4289
|
oas: ZaloFormsAuthSessionOaItem[];
|
|
3026
|
-
[key: string]: unknown;
|
|
3027
4290
|
};
|
|
3028
|
-
[key: string]: unknown;
|
|
3029
4291
|
};
|
|
3030
4292
|
|
|
3031
4293
|
/** Zalo Forms API service. Each API explicitly selects its own request transport. */
|
|
@@ -3042,13 +4304,31 @@ declare class ZaloFormsService {
|
|
|
3042
4304
|
listFormLeads(request: ZaloFormsListFormLeadsRequest, options?: RequestOptions): Promise<ZaloFormsListFormLeadsResponse>;
|
|
3043
4305
|
listManagedFormsByOfficialAccount(request: ZaloFormsListManagedFormsByOfficialAccountRequest, options?: RequestOptions): Promise<ZaloFormsListManagedFormsByOfficialAccountResponse>;
|
|
3044
4306
|
listSimpleFormsByOfficialAccount(request: ZaloFormsListSimpleFormsByOfficialAccountRequest, options?: RequestOptions): Promise<ZaloFormsListSimpleFormsByOfficialAccountResponse>;
|
|
4307
|
+
listScenariosByOfficialAccount(request: ZaloFormsListScenariosByOfficialAccountRequest, options?: RequestOptions): Promise<ZaloFormsListScenariosByOfficialAccountResponse>;
|
|
3045
4308
|
updateFormLeadNotificationInterval(request: ZaloFormsUpdateFormLeadNotificationIntervalRequest, options?: RequestOptions): Promise<ZaloFormsUpdateFormLeadNotificationIntervalResponse>;
|
|
3046
4309
|
}
|
|
3047
4310
|
|
|
3048
|
-
/** Zalo Instant Pages API service. Each API explicitly selects its own request transport. */
|
|
3049
|
-
|
|
3050
4311
|
declare class ZaloInstantPagesService {
|
|
3051
4312
|
private readonly client;
|
|
4313
|
+
/**
|
|
4314
|
+
* Bộ công cụ kiểm tra tính hợp lệ dữ liệu (Standalone Validators) cho 13 API Instant Pages.
|
|
4315
|
+
* Dùng ở backend (NestJS/Express/Fastify), middleware hoặc AI Agent để verify payload trước khi gọi SDK.
|
|
4316
|
+
*/
|
|
4317
|
+
static readonly validator: {
|
|
4318
|
+
validateCloneInstantPage: typeof validateCloneInstantPageRequest;
|
|
4319
|
+
validateGetInstantPageDetail: typeof validateGetInstantPageDetailRequest;
|
|
4320
|
+
validateGetInstantPageSharedUser: typeof validateGetInstantPageSharedUserRequest;
|
|
4321
|
+
validateListInstantPageEditHistory: typeof validateListInstantPageEditHistoryRequest;
|
|
4322
|
+
validateListInstantPageFormRecords: typeof validateListInstantPageFormRecordsRequest;
|
|
4323
|
+
validateListInstantPageShares: typeof validateListInstantPageSharesRequest;
|
|
4324
|
+
validateListInstantPageUsers: typeof validateListInstantPageUsersRequest;
|
|
4325
|
+
validateListMiniPageTemplates: typeof validateListMiniPageTemplatesRequest;
|
|
4326
|
+
validateSearchInstantPages: typeof validateSearchInstantPagesRequest;
|
|
4327
|
+
validateUpdateInstantPage: typeof validateUpdateInstantPageRequest;
|
|
4328
|
+
validateListInstantPageLeads: typeof validateListInstantPageLeadsRequest;
|
|
4329
|
+
validateListOfficialAccounts: typeof validateListOfficialAccountsRequest;
|
|
4330
|
+
validateUpsertInstantPageForm: typeof validateUpsertInstantPageFormRequest;
|
|
4331
|
+
};
|
|
3052
4332
|
constructor(client: ZaloSdkHttpClient);
|
|
3053
4333
|
cloneInstantPage(request: ZaloInstantPagesCloneInstantPageRequest, options?: RequestOptions): Promise<ZaloInstantPagesCloneInstantPageResponse>;
|
|
3054
4334
|
getInstantPageDetail(request: ZaloInstantPagesGetInstantPageDetailRequest, options?: RequestOptions): Promise<ZaloInstantPagesGetInstantPageDetailResponse>;
|
|
@@ -3067,42 +4347,77 @@ declare class ZaloInstantPagesService {
|
|
|
3067
4347
|
|
|
3068
4348
|
/** DTOs for Zalo Profile Ads (`https://profile.ads.zalo.me`). Request fields are flattened; services route them automatically. */
|
|
3069
4349
|
|
|
3070
|
-
/**
|
|
4350
|
+
/**
|
|
4351
|
+
* Mã Danh mục hoạt động chi tiết (`subCategoryId` - 22 mã chuẩn trên `https://profile.ads.zalo.me/register`):
|
|
4352
|
+
* - `10043`: Bất động sản
|
|
4353
|
+
* - `10018`: Công nghệ & Thiết bị
|
|
4354
|
+
* - `10097`: Dịch vụ tiện ích
|
|
4355
|
+
* - `10020`: Du lịch & Lưu trú
|
|
4356
|
+
* - `10021`: Giáo dục & Đào tạo
|
|
4357
|
+
* - `10024`: Mua sắm & Bán lẻ
|
|
4358
|
+
* - `10019`: Mỹ phẩm & Làm đẹp
|
|
4359
|
+
* - `10014`: Nhà hàng & Quán
|
|
4360
|
+
* - `10094`: Ô tô & Xe máy
|
|
4361
|
+
* - `10098`: Sản xuất & Chế tạo
|
|
4362
|
+
* - `10044`: Tài chính & Ngân hàng
|
|
4363
|
+
* - `10099`: Thiết kế & Thi công
|
|
4364
|
+
* - `10017`: Thời trang & May mặc
|
|
4365
|
+
* - `10023`: Thực phẩm & Đồ uống
|
|
4366
|
+
* - `10016`: Truyền thông & Giải trí
|
|
4367
|
+
* - `10092`: Truyền thông nội bộ
|
|
4368
|
+
* - `10101`: Tuyển dụng & Việc làm
|
|
4369
|
+
* - `10100`: Tư vấn & Quản lý
|
|
4370
|
+
* - `10095`: Vận tải
|
|
4371
|
+
* - `10093`: Viễn thông
|
|
4372
|
+
* - `10022`: Y tế & Dược phẩm
|
|
4373
|
+
* - `10025`: Dịch vụ khác
|
|
4374
|
+
*/
|
|
4375
|
+
type ZaloProfileAdsSubCategoryId = 10043 | 10018 | 10097 | 10020 | 10021 | 10024 | 10019 | 10014 | 10094 | 10098 | 10044 | 10099 | 10017 | 10023 | 10016 | 10092 | 10101 | 10100 | 10095 | 10093 | 10022 | 10025 | (number & {});
|
|
4376
|
+
/**
|
|
4377
|
+
* Mã 34 Tỉnh/Thành phố chuẩn trên `https://profile.ads.zalo.me/ajax/get-province`:
|
|
4378
|
+
* - `1`: Thành phố Hà Nội | `79`: Thành phố Hồ Chí Minh | `48`: Thành phố Đà Nẵng | `31`: Thành phố Hải Phòng | `92`: Thành phố Cần Thơ | `46`: Thành phố Huế
|
|
4379
|
+
* - `91`: Tỉnh An Giang | `24`: Tỉnh Bắc Ninh | `96`: Tỉnh Cà Mau | `4`: Tỉnh Cao Bằng | `66`: Tỉnh Đắk Lắk | `11`: Tỉnh Điện Biên | `75`: Tỉnh Đồng Nai | `82`: Tỉnh Đồng Tháp
|
|
4380
|
+
* - `52`: Tỉnh Gia Lai | `42`: Tỉnh Hà Tĩnh | `33`: Tỉnh Hưng Yên | `56`: Tỉnh Khánh Hòa | `12`: Tỉnh Lai Châu | `20`: Tỉnh Lạng Sơn | `15`: Tỉnh Lào Cai | `68`: Tỉnh Lâm Đồng
|
|
4381
|
+
* - `40`: Tỉnh Nghệ An | `37`: Tỉnh Ninh Bình | `25`: Tỉnh Phú Thọ | `51`: Tỉnh Quảng Ngãi | `22`: Tỉnh Quảng Ninh | `44`: Tỉnh Quảng Trị | `14`: Tỉnh Sơn La | `80`: Tỉnh Tây Ninh
|
|
4382
|
+
* - `19`: Tỉnh Thái Nguyên | `38`: Tỉnh Thanh Hóa | `8`: Tỉnh Tuyên Quang | `86`: Tỉnh Vĩnh Long
|
|
4383
|
+
*/
|
|
4384
|
+
type ZaloProfileAdsProvinceId = 1 | 4 | 8 | 11 | 12 | 14 | 15 | 19 | 20 | 22 | 24 | 25 | 31 | 33 | 37 | 38 | 40 | 42 | 44 | 46 | 48 | 51 | 52 | 56 | 66 | 68 | 75 | 79 | 80 | 82 | 86 | 91 | 92 | 96 | (number & {});
|
|
4385
|
+
/** Khởi tạo mới trang Zalo Official Account (OA) / Hồ sơ quảng cáo cửa hàng hoặc doanh nghiệp trên hệ thống Zalo Ads Profile với đầy đủ danh mục, thông tin liên hệ, địa chỉ và ảnh nhận diện. Đây là mutation tool thuộc lane zalo-ads-page. Dùng sau khi đã tải lên ảnh đại diện lấy avatarId, ảnh bìa lấy coverId và xác nhận đầy đủ thông tin đăng ký trang OA. */
|
|
3071
4386
|
type ZaloProfileAdsCreateOaPageRequest = {
|
|
3072
4387
|
/** Hành động tạo mới trang Official Account, cố định là "createpage" (SDK tự gán mặc định nếu bỏ qua). */
|
|
3073
4388
|
option?: "createpage";
|
|
3074
4389
|
/** Mã CSRF token của phiên làm việc Zalo Ads Profile hiện tại (lưu ý đúng chính tả tham số upstream là `crsf-token`). Nếu sử dụng `zpsid` / `ZaloAuthManager`, SDK sẽ tự động trích xuất từ `https://profile.ads.zalo.me/` nếu bỏ qua. */
|
|
3075
4390
|
"crsf-token"?: string;
|
|
3076
|
-
/**
|
|
3077
|
-
|
|
3078
|
-
/**
|
|
4391
|
+
/** Mã loại hình tài khoản OA. Giá trị chuẩn cố định là `2` (Tài khoản OA Doanh nghiệp / Cửa hàng / Hồ sơ quảng cáo; SDK tự gán mặc định `2` nếu bỏ qua). */
|
|
4392
|
+
typeId?: number;
|
|
4393
|
+
/** Định danh chuỗi loại tài khoản OA tương ứng với `typeId = 2`. Giá trị chuẩn cố định là `"store"` (SDK tự gán mặc định `"store"` nếu bỏ qua). */
|
|
4394
|
+
typeName?: string;
|
|
4395
|
+
/** Hạng tài khoản OA khi khởi tạo: `0` = Tài khoản Phổ thông / Hồ sơ quảng cáo mới tạo (`certified: false`, mặc định `0`); `1` = Tài khoản OA Xác thực (`certified: true`). */
|
|
4396
|
+
tier?: number;
|
|
4397
|
+
/** Mã danh mục gốc (Parent Category) được Zalo hardcode cố định là `10003` cho toàn bộ Hồ sơ quảng cáo (SDK tự gán mặc định `10003` nếu bỏ qua). */
|
|
4398
|
+
categoryId?: number;
|
|
4399
|
+
/** Mã Danh mục hoạt động chi tiết (1 trong 22 mã chuẩn `ZaloProfileAdsSubCategoryId`, ví dụ: `10018` = Công nghệ & Thiết bị, `10043` = Bất động sản). */
|
|
4400
|
+
subCategoryId: ZaloProfileAdsSubCategoryId;
|
|
4401
|
+
/** Tên hiển thị của Hồ sơ quảng cáo / Trang Zalo Official Account cần tạo (tối đa 40 ký tự, chữ cái đầu viết hoa). */
|
|
3079
4402
|
oaName: string;
|
|
3080
|
-
/**
|
|
3081
|
-
|
|
3082
|
-
/** Địa chỉ chi tiết của doanh nghiệp hoặc cửa hàng. */
|
|
3083
|
-
address: string;
|
|
3084
|
-
/** Mã fileId của ảnh bìa nhận được từ công cụ tải ảnh bìa (`uploadOaCover`). */
|
|
3085
|
-
coverId: string;
|
|
3086
|
-
/** Mã fileId của ảnh đại diện nhận được từ công cụ tải ảnh đại diện (`uploadOaAvatar`). */
|
|
3087
|
-
avatarId: string;
|
|
3088
|
-
/** Mã quận/huyện/phường tương ứng (ví dụ: 9556). */
|
|
3089
|
-
district: number;
|
|
3090
|
-
/** Mã tỉnh/thành phố nơi đặt địa chỉ hoạt động (ví dụ: 1 là Thành phố Hà Nội). */
|
|
3091
|
-
province: number;
|
|
3092
|
-
/** Tên định danh loại tài khoản OA (ví dụ: 'store'). */
|
|
3093
|
-
typeName: string;
|
|
3094
|
-
/** Xác nhận đồng ý điều khoản sử dụng Zalo Official Account (luôn là true). */
|
|
3095
|
-
agreeTerm: boolean;
|
|
3096
|
-
/** Mã danh mục chính của trang OA (ví dụ: 10003). */
|
|
3097
|
-
categoryId: number;
|
|
4403
|
+
/** Thông tin giới thiệu về hoạt động hoặc các dịch vụ và sản phẩm mà hồ sơ sẽ quảng cáo (bắt buộc tối thiểu 20 ký tự, tối đa 500 ký tự). */
|
|
4404
|
+
description: string;
|
|
3098
4405
|
/** Họ và tên người liên hệ phụ trách trang OA. */
|
|
3099
4406
|
contactName: string;
|
|
3100
|
-
/**
|
|
3101
|
-
description: string;
|
|
3102
|
-
/** Số điện thoại người liên hệ (định dạng chuỗi số, ví dụ: '84383826333'). */
|
|
4407
|
+
/** Số điện thoại người liên hệ (định dạng chuỗi số, ví dụ: '84384473007'). */
|
|
3103
4408
|
contactPhone: string;
|
|
3104
|
-
/** Mã
|
|
3105
|
-
|
|
4409
|
+
/** Mã fileId của ảnh đại diện nhận được từ công cụ tải ảnh đại diện (`uploadOaAvatar`). */
|
|
4410
|
+
avatarId: string;
|
|
4411
|
+
/** Mã fileId của ảnh bìa nhận được từ công cụ tải ảnh bìa (`uploadOaCover`). */
|
|
4412
|
+
coverId: string;
|
|
4413
|
+
/** Mã Tỉnh/Thành phố nơi đặt địa chỉ hoạt động (1 trong 34 mã `ZaloProfileAdsProvinceId` lấy từ `getProvinces`, ví dụ: `1` = Thành phố Hà Nội, `79` = Thành phố Hồ Chí Minh). */
|
|
4414
|
+
province: ZaloProfileAdsProvinceId;
|
|
4415
|
+
/** Mã Phường/Xã tương ứng thuộc Tỉnh/Thành phố đã chọn (lấy từ `getDistricts({ provinceId })`, ví dụ tại Hà Nội `province=1`: `637` = Phường Đại Mỗ, `9556` = Phường Hà Đông). */
|
|
4416
|
+
district: number;
|
|
4417
|
+
/** Địa chỉ chi tiết của doanh nghiệp hoặc cửa hàng (ví dụ: 'Số 40/74 đường Hữu Hưng, Phường Đại Mỗ, Thành phố Hà Nội'). */
|
|
4418
|
+
address: string;
|
|
4419
|
+
/** Xác nhận đồng ý điều khoản sử dụng Zalo Official Account (luôn là `true`, SDK tự gán mặc định `true` nếu bỏ qua). */
|
|
4420
|
+
agreeTerm?: boolean;
|
|
3106
4421
|
};
|
|
3107
4422
|
type ZaloProfileAdsCreateOaPageResponse = {
|
|
3108
4423
|
/** Mã lỗi phản hồi từ Zalo Ads Profile (0 là tạo trang thành công). */
|
|
@@ -3115,9 +4430,7 @@ type ZaloProfileAdsCreateOaPageResponse = {
|
|
|
3115
4430
|
name: string;
|
|
3116
4431
|
/** Mã định danh Zalo Official Account ID (OA ID) vừa được khởi tạo. */
|
|
3117
4432
|
oaid: string;
|
|
3118
|
-
[key: string]: unknown;
|
|
3119
4433
|
};
|
|
3120
|
-
[key: string]: unknown;
|
|
3121
4434
|
};
|
|
3122
4435
|
/** Tải lên ảnh đại diện (avatar) cho trang Zalo Official Account trên hệ thống Zalo Ads Profile để nhận mã fileId phục vụ khởi tạo hoặc cập nhật OA. Đây là mutation tool thuộc lane zalo-ads-page. Dùng trước bước tạo mới trang OA khi đã có URL tệp ảnh đại diện hợp lệ cần tải lên. */
|
|
3123
4436
|
type ZaloProfileAdsUploadOaAvatarRequest = {
|
|
@@ -3125,7 +4438,7 @@ type ZaloProfileAdsUploadOaAvatarRequest = {
|
|
|
3125
4438
|
option?: "update";
|
|
3126
4439
|
/** Cờ xác nhận tải ảnh cho OA mới, truyền 'true' khi tạo trang OA mới (mặc định: "true"). */
|
|
3127
4440
|
"is-new"?: "true" | "false";
|
|
3128
|
-
/** URL HTTP(S), signed URL hoặc Blob/Buffer của tệp ảnh đại diện cần tải lên; hệ thống tự động tải và đính kèm dạng multipart/form-data vào trường `avatar-file`. */
|
|
4441
|
+
/** URL HTTP(S), signed URL hoặc Blob/Buffer của tệp ảnh đại diện cần tải lên (JPG/PNG, tối thiểu 150x150px, tối đa 15MB); hệ thống tự động tải và đính kèm dạng multipart/form-data vào trường `avatar-file`. */
|
|
3129
4442
|
"avatar-file": FileInput;
|
|
3130
4443
|
};
|
|
3131
4444
|
type ZaloProfileAdsUploadOaAvatarResponse = {
|
|
@@ -3135,7 +4448,6 @@ type ZaloProfileAdsUploadOaAvatarResponse = {
|
|
|
3135
4448
|
msg: string;
|
|
3136
4449
|
/** Mã định danh tệp ảnh đại diện đã tải lên, dùng để truyền vào trường `avatarId` khi tạo hoặc cập nhật OA. */
|
|
3137
4450
|
fileId: string;
|
|
3138
|
-
[key: string]: unknown;
|
|
3139
4451
|
};
|
|
3140
4452
|
/** Tải lên ảnh bìa (cover) cho trang Zalo Official Account trên hệ thống Zalo Ads Profile để nhận mã fileId phục vụ khởi tạo hoặc cập nhật OA. Đây là mutation tool thuộc lane zalo-ads-page. Dùng trước bước tạo mới trang OA khi đã có URL tệp ảnh bìa hợp lệ cần tải lên. */
|
|
3141
4453
|
type ZaloProfileAdsUploadOaCoverRequest = {
|
|
@@ -3143,7 +4455,7 @@ type ZaloProfileAdsUploadOaCoverRequest = {
|
|
|
3143
4455
|
option?: "update";
|
|
3144
4456
|
/** Cờ xác nhận tải ảnh bìa cho OA mới, truyền 'true' khi tạo trang OA mới (mặc định: "true"). */
|
|
3145
4457
|
"is-new"?: "true" | "false";
|
|
3146
|
-
/** URL HTTP(S), signed URL hoặc Blob/Buffer của tệp ảnh bìa cần tải lên; hệ thống tự động tải và đính kèm dạng multipart/form-data vào trường `cover-file`. */
|
|
4458
|
+
/** URL HTTP(S), signed URL hoặc Blob/Buffer của tệp ảnh bìa cần tải lên (JPG/PNG, tối thiểu 320x180px, tối đa 15MB); hệ thống tự động tải và đính kèm dạng multipart/form-data vào trường `cover-file`. */
|
|
3147
4459
|
"cover-file": FileInput;
|
|
3148
4460
|
};
|
|
3149
4461
|
type ZaloProfileAdsUploadOaCoverResponse = {
|
|
@@ -3153,7 +4465,36 @@ type ZaloProfileAdsUploadOaCoverResponse = {
|
|
|
3153
4465
|
msg: string;
|
|
3154
4466
|
/** Mã định danh tệp ảnh bìa đã tải lên, dùng để truyền vào trường `coverId` khi tạo hoặc cập nhật OA. */
|
|
3155
4467
|
fileId: string;
|
|
3156
|
-
|
|
4468
|
+
};
|
|
4469
|
+
/** Phần tử Tỉnh/Thành phố hoặc Phường/Xã trên Zalo Ads Profile (`https://profile.ads.zalo.me`). */
|
|
4470
|
+
type ZaloProfileAdsAdministrativeItem = {
|
|
4471
|
+
/** Mã định danh Tỉnh/Thành phố (`province`) hoặc Phường/Xã (`district`). */
|
|
4472
|
+
id: number;
|
|
4473
|
+
/** Tên hiển thị của Tỉnh/Thành phố hoặc Phường/Xã. */
|
|
4474
|
+
value: string;
|
|
4475
|
+
};
|
|
4476
|
+
/** Kết quả lấy danh sách 34 Tỉnh/Thành phố chuẩn trên Zalo Ads Profile (`GET /ajax/get-province`). */
|
|
4477
|
+
type ZaloProfileAdsGetProvincesResponse = {
|
|
4478
|
+
/** Mã lỗi phản hồi từ Zalo Ads Profile (0 là thành công). */
|
|
4479
|
+
err: number;
|
|
4480
|
+
/** Thông điệp kết quả xử lý (ví dụ: 'Lấy dữ liệu thành công.'). */
|
|
4481
|
+
msg: string;
|
|
4482
|
+
/** Danh sách 34 Tỉnh/Thành phố. */
|
|
4483
|
+
data: ZaloProfileAdsAdministrativeItem[];
|
|
4484
|
+
};
|
|
4485
|
+
/** Tham số truy vấn danh sách Phường/Xã theo Tỉnh/Thành phố trên Zalo Ads Profile (`GET /ajax/get-district?provinceId=...`). */
|
|
4486
|
+
type ZaloProfileAdsGetDistrictsRequest = {
|
|
4487
|
+
/** Mã Tỉnh/Thành phố lấy từ `getProvinces()` (ví dụ: `1` = Thành phố Hà Nội, `79` = Thành phố Hồ Chí Minh). */
|
|
4488
|
+
provinceId: ZaloProfileAdsProvinceId;
|
|
4489
|
+
};
|
|
4490
|
+
/** Kết quả lấy danh sách Phường/Xã theo Tỉnh/Thành phố trên Zalo Ads Profile (`GET /ajax/get-district?provinceId=...`). */
|
|
4491
|
+
type ZaloProfileAdsGetDistrictsResponse = {
|
|
4492
|
+
/** Mã lỗi phản hồi từ Zalo Ads Profile (0 là thành công). */
|
|
4493
|
+
err: number;
|
|
4494
|
+
/** Thông điệp kết quả xử lý (ví dụ: 'Lấy dữ liệu thành công.'). */
|
|
4495
|
+
msg: string;
|
|
4496
|
+
/** Danh sách Phường/Xã thuộc Tỉnh/Thành phố được truy vấn. */
|
|
4497
|
+
data: ZaloProfileAdsAdministrativeItem[];
|
|
3157
4498
|
};
|
|
3158
4499
|
|
|
3159
4500
|
/** Zalo Profile Ads API service (`https://profile.ads.zalo.me`). Each API explicitly selects its own request transport. */
|
|
@@ -3164,6 +4505,8 @@ declare class ZaloProfileAdsService {
|
|
|
3164
4505
|
createOaPage(request: ZaloProfileAdsCreateOaPageRequest, options?: RequestOptions): Promise<ZaloProfileAdsCreateOaPageResponse>;
|
|
3165
4506
|
uploadOaAvatar(request: ZaloProfileAdsUploadOaAvatarRequest, options?: RequestOptions): Promise<ZaloProfileAdsUploadOaAvatarResponse>;
|
|
3166
4507
|
uploadOaCover(request: ZaloProfileAdsUploadOaCoverRequest, options?: RequestOptions): Promise<ZaloProfileAdsUploadOaCoverResponse>;
|
|
4508
|
+
getProvinces(options?: RequestOptions): Promise<ZaloProfileAdsGetProvincesResponse>;
|
|
4509
|
+
getDistricts(request: ZaloProfileAdsGetDistrictsRequest, options?: RequestOptions): Promise<ZaloProfileAdsGetDistrictsResponse>;
|
|
3167
4510
|
}
|
|
3168
4511
|
|
|
3169
4512
|
/** Lấy thông tin công khai của Zalo Official Account theo OA ID, gồm tên, mô tả, ảnh đại diện và cấu trúc menu. Đây là detail tool thuộc lane zalo-ads-page; dùng khi đã có OA ID và cần xác thực hoặc hiển thị thông tin OA trước khi liên kết với luồng quảng cáo. */
|
|
@@ -3314,6 +4657,17 @@ declare class ZaloWidgetApiService {
|
|
|
3314
4657
|
declare class ZaloAdsSdk {
|
|
3315
4658
|
private readonly client;
|
|
3316
4659
|
readonly ads: ZaloAdsService;
|
|
4660
|
+
readonly campaigns: ZaloCampaignsService;
|
|
4661
|
+
readonly account: ZaloAccountService;
|
|
4662
|
+
readonly audiences: ZaloAudiencesService;
|
|
4663
|
+
readonly targeting: ZaloAudiencesService;
|
|
4664
|
+
readonly reports: ZaloReportsService;
|
|
4665
|
+
readonly conversions: ZaloConversionsService;
|
|
4666
|
+
readonly pixel: ZaloConversionsService;
|
|
4667
|
+
readonly automatedRules: ZaloAutomatedRulesService;
|
|
4668
|
+
readonly rules: ZaloAutomatedRulesService;
|
|
4669
|
+
readonly flows: ZaloFlowsService;
|
|
4670
|
+
readonly media: ZaloMediaService;
|
|
3317
4671
|
readonly forms: ZaloFormsService;
|
|
3318
4672
|
readonly instantPages: ZaloInstantPagesService;
|
|
3319
4673
|
readonly profileAds: ZaloProfileAdsService;
|
|
@@ -3474,4 +4828,51 @@ declare class ZaloAdsIntegrationManager {
|
|
|
3474
4828
|
get poolSize(): number;
|
|
3475
4829
|
}
|
|
3476
4830
|
|
|
3477
|
-
export { ALL_ZALO_ADS_DOMAINS, type BodyType, type FileDownloadResponse, type FileInput, type HttpMethod, MemoryZaloSessionStore, type MemoryZaloSessionStoreOptions, type OperationDefinition, RedisZaloSessionStore, type RedisZaloSessionStoreOptions, type RequestOptions, TieredZaloSessionStore, type TieredZaloSessionStoreOptions, ZaloAdsIntegrationManager as ZaloAdsAccountPool, type ZaloAdsChangeAutomatedRuleStatusRequest, type ZaloAdsChangeAutomatedRuleStatusResponse, type ZaloAdsChangeCampaignStatusRequest, type ZaloAdsChangeCampaignStatusResponse, type ZaloAdsClientRequest, type ZaloAdsCreateArticleCampaignRequest, type ZaloAdsCreateArticleCampaignResponse, type ZaloAdsCreateAutomatedRuleRequest, type ZaloAdsCreateAutomatedRuleResponse, type ZaloAdsCreateCommerceCampaignRequest, type ZaloAdsCreateCommerceCampaignResponse, type ZaloAdsCreateConversionRequest, type ZaloAdsCreateConversionResponse, type ZaloAdsCreateCustomAudienceRequest, type ZaloAdsCreateCustomAudienceResponse, type ZaloAdsCreateDisplayCampaignRequest, type ZaloAdsCreateDisplayCampaignResponse, type ZaloAdsCreateEcommerceCampaignRequest, type ZaloAdsCreateEcommerceCampaignResponse, ZaloAdsCreateFlowRequest, ZaloAdsCreateFlowResponse, type ZaloAdsCreateFormCampaignRequest, type ZaloAdsCreateFormCampaignResponse, type ZaloAdsCreateFormRequest, type ZaloAdsCreateFormResponse, type ZaloAdsCreateMessageCampaignRequest, type ZaloAdsCreateMessageCampaignResponse, type ZaloAdsCreateOaCampaignRequest, type ZaloAdsCreateOaCampaignResponse, type ZaloAdsCreateOfficialAccountCampaignRequest, type ZaloAdsCreateOfficialAccountCampaignResponse, ZaloAdsCreatePostCampaignRequest, ZaloAdsCreatePostCampaignResponse, type ZaloAdsCreateVideoCampaignRequest, type ZaloAdsCreateVideoCampaignResponse, type ZaloAdsCreateWebsiteCampaignRequest, type ZaloAdsCreateWebsiteCampaignResponse, type ZaloAdsDeleteAutomatedRuleRequest, type ZaloAdsDeleteAutomatedRuleResponse, type ZaloAdsDeleteCampaignRequest, type ZaloAdsDeleteCampaignResponse, type ZaloAdsDeleteConversionRequest, type ZaloAdsDeleteConversionResponse, type ZaloAdsDeleteCustomAudienceRequest, type ZaloAdsDeleteCustomAudienceResponse, type ZaloAdsDomain, ZaloAdsFlowButtonDto, ZaloAdsFlowChildMessageDto, ZaloAdsFlowMessageDto, type ZaloAdsGetAdByIdRequest, type ZaloAdsGetAdByIdResponse, type ZaloAdsGetAdChangeLogRequest, type ZaloAdsGetAdChangeLogResponse, type ZaloAdsGetApiAdGetlistadadvancetargetingRequest, type ZaloAdsGetApiAdGetlistadadvancetargetingResponse, type ZaloAdsGetApiBaAccountAllaccessorsRequest, type ZaloAdsGetApiBaAccountAllaccessorsResponse, type ZaloAdsGetApiBaAccountAllgrantedmembersRequest, type ZaloAdsGetApiBaAccountAllgrantedmembersResponse, type ZaloAdsGetApiConversionAllRequest, type ZaloAdsGetApiConversionAllResponse, type ZaloAdsGetApiConversionStandardEventsRequest, type ZaloAdsGetApiConversionStandardEventsResponse, type ZaloAdsGetApiCustomAudienceAllRequest, type ZaloAdsGetApiCustomAudienceAllResponse, type ZaloAdsGetApiFilegroupsRequest, type ZaloAdsGetApiFilegroupsResponse, type ZaloAdsGetApiLpNewsRequest, type ZaloAdsGetApiLpNewsResponse, type ZaloAdsGetApiMediaItemsRequest, type ZaloAdsGetApiMediaItemsResponse, type ZaloAdsGetApiMemberFilesRequest, type ZaloAdsGetApiMemberFilesResponse, type ZaloAdsGetApiNotifiesHeaderRequest, type ZaloAdsGetApiNotifiesHeaderResponse, type ZaloAdsGetApiPaymentTransactionHistoryRequest, type ZaloAdsGetApiPaymentTransactionHistoryResponse, type ZaloAdsGetApiPlaceGetalldistrictsRequest, type ZaloAdsGetApiPlaceGetalldistrictsResponse, type ZaloAdsGetApiSpellCheckV2Request, type ZaloAdsGetApiSpellCheckV2Response, type ZaloAdsGetApiWhoamiRequest, type ZaloAdsGetApiWhoamiResponse, type ZaloAdsGetAutomatedRuleHistoryRequest, type ZaloAdsGetAutomatedRuleHistoryResponse, type ZaloAdsGetReportapiV2AdsRequest, type ZaloAdsGetReportapiV2AdsResponse, type ZaloAdsGetReportapiV2CampaignsRequest, type ZaloAdsGetReportapiV2CampaignsResponse, type ZaloAdsGetReportapiV2UniqueUserRequest, type ZaloAdsGetReportapiV2UniqueUserResponse, type ZaloAdsGetReportapiV3CampaignsRequest, type ZaloAdsGetReportapiV3CampaignsResponse, type ZaloAdsGetZaapiCampaignReportcampaignRequest, type ZaloAdsGetZaapiCampaignReportcampaignResponse, type ZaloAdsGetZaapiCheckcamphasmanyadsRequest, type ZaloAdsGetZaapiCheckcamphasmanyadsResponse, type ZaloAdsGetZaapiGetadsfromcampaignidRequest, type ZaloAdsGetZaapiGetadsfromcampaignidResponse, type ZaloAdsGetZaapiGetallpagesRequest, type ZaloAdsGetZaapiGetallpagesResponse, type ZaloAdsGetZaapiGetownedarticlesRequest, type ZaloAdsGetZaapiGetownedarticlesResponse, type ZaloAdsGetZaapiGetownedpagesRequest, type ZaloAdsGetZaapiGetownedpagesResponse, ZaloAdsIntegrationManager, type ZaloAdsIntegrationManagerOptions, type ZaloAdsListAgencyCustomersWithBudgetRequest, type ZaloAdsListAgencyCustomersWithBudgetResponse, type ZaloAdsListAutomatedRulesRequest, type ZaloAdsListAutomatedRulesResponse, type ZaloAdsListCustomReportsRequest, type ZaloAdsListCustomReportsResponse, type ZaloAdsListFlowsByOfficialAccountRequest, type ZaloAdsListFlowsByOfficialAccountResponse, type ZaloAdsListFormsByOfficialAccountRequest, type ZaloAdsListFormsByOfficialAccountResponse, type ZaloAdsListMiniPagesByTemplateRequest, type ZaloAdsListMiniPagesByTemplateResponse, type ZaloAdsListPersonalPixelLabelsRequest, type ZaloAdsListPersonalPixelLabelsResponse, ZaloAdsMessageAdUpdateDataDto, type ZaloAdsPostApiAdEstimateaudienceRequest, type ZaloAdsPostApiAdEstimateaudienceResponse, type ZaloAdsPostApiMediaSaveRequest, type ZaloAdsPostApiMediaSaveResponse, type ZaloAdsPostApiMemberUploadImageRequest, type ZaloAdsPostApiMemberUploadImageResponse, type ZaloAdsPostZaapiDeleteadRequest, type ZaloAdsPostZaapiDeleteadResponse, type ZaloAdsRenameCampaignRequest, type ZaloAdsRenameCampaignResponse, ZaloAdsSdk, type ZaloAdsSdkOptions, ZaloAdsService, type ZaloAdsUpdateArticleAdRequest, type ZaloAdsUpdateArticleAdResponse, type ZaloAdsUpdateAutomatedRuleRequest, type ZaloAdsUpdateAutomatedRuleResponse, type ZaloAdsUpdateCommerceAdRequest, type ZaloAdsUpdateCommerceAdResponse, type ZaloAdsUpdateDisplayAdRequest, type ZaloAdsUpdateDisplayAdResponse, type ZaloAdsUpdateEcommerceAdRequest, type ZaloAdsUpdateEcommerceAdResponse, type ZaloAdsUpdateFlowRequest, type ZaloAdsUpdateFlowResponse, type ZaloAdsUpdateFormAdRequest, type ZaloAdsUpdateFormAdResponse, ZaloAdsUpdateMessageAdRequest, ZaloAdsUpdateMessageAdResponse, type ZaloAdsUpdateNewAdsRequest, type ZaloAdsUpdateNewAdsResponse, type ZaloAdsUpdateOaAdRequest, type ZaloAdsUpdateOaAdResponse, type ZaloAdsUpdateOfficialAccountAdRequest, type ZaloAdsUpdateOfficialAccountAdResponse, type ZaloAdsUpdatePostAdRequest, type ZaloAdsUpdatePostAdResponse, ZaloAdsUpdateVideoAdRequest, ZaloAdsUpdateVideoAdResponse, type ZaloAdsUpdateWebsiteAdRequest, type ZaloAdsUpdateWebsiteAdResponse, type ZaloAdsUploadCustomAudiencePhoneListRequest, type ZaloAdsUploadCustomAudiencePhoneListResponse, type ZaloAdsUploadVideoRequest, type ZaloAdsUploadVideoResponse, type ZaloAdsUpsertCustomReportRequest, type ZaloAdsUpsertCustomReportResponse, type ZaloAdsWhoamiProfile, type ZaloAuthDomain, ZaloAuthManager, type ZaloChatWidgetGetChatWidgetLoginConfigRequest, type ZaloChatWidgetGetChatWidgetLoginConfigResponse, type ZaloChatWidgetGetLoginConfigRequest, type ZaloChatWidgetGetLoginConfigResponse, ZaloChatWidgetService, type ZaloDomainSession, type ZaloFormSessionProfile, type ZaloFormsAuthSessionOaItem, type ZaloFormsDisableFormLeadNotificationRequest, type ZaloFormsDisableFormLeadNotificationResponse, type ZaloFormsEnableFormLeadNotificationRequest, type ZaloFormsEnableFormLeadNotificationResponse, type ZaloFormsExportFormLeadReportRequest, type ZaloFormsExportFormLeadReportResponse, type ZaloFormsGetAuthSessionResponse, type ZaloFormsListAudienceExclusionTargetingRequest, type ZaloFormsListAudienceExclusionTargetingResponse, type ZaloFormsListConversationLeadsRequest, type ZaloFormsListConversationLeadsResponse, type ZaloFormsListFormLeadsRequest, type ZaloFormsListFormLeadsResponse, type ZaloFormsListManagedFormsByOfficialAccountRequest, type ZaloFormsListManagedFormsByOfficialAccountResponse, type ZaloFormsListSimpleFormsByOfficialAccountRequest, type ZaloFormsListSimpleFormsByOfficialAccountResponse, ZaloFormsService, type ZaloFormsUpdateFormLeadNotificationIntervalRequest, type ZaloFormsUpdateFormLeadNotificationIntervalResponse, type ZaloInstantPagesCloneInstantPageRequest, type ZaloInstantPagesCloneInstantPageResponse, type ZaloInstantPagesGetInstantPageDetailRequest, type ZaloInstantPagesGetInstantPageDetailResponse, type ZaloInstantPagesGetInstantPageSharedUserRequest, type ZaloInstantPagesGetInstantPageSharedUserResponse, type ZaloInstantPagesListInstantPageEditHistoryRequest, type ZaloInstantPagesListInstantPageEditHistoryResponse, type ZaloInstantPagesListInstantPageFormRecordsRequest, type ZaloInstantPagesListInstantPageFormRecordsResponse, type ZaloInstantPagesListInstantPageLeadsRequest, type ZaloInstantPagesListInstantPageLeadsResponse, type ZaloInstantPagesListInstantPageSharesRequest, type ZaloInstantPagesListInstantPageSharesResponse, type ZaloInstantPagesListInstantPageUsersRequest, type ZaloInstantPagesListInstantPageUsersResponse, type ZaloInstantPagesListMiniPageTemplatesRequest, type ZaloInstantPagesListMiniPageTemplatesResponse, type ZaloInstantPagesListOfficialAccountsRequest, type ZaloInstantPagesListOfficialAccountsResponse, type ZaloInstantPagesOfficialAccountItem, type ZaloInstantPagesSearchInstantPagesRequest, type ZaloInstantPagesSearchInstantPagesResponse, ZaloInstantPagesService, type ZaloInstantPagesUpdateInstantPageRequest, type ZaloInstantPagesUpdateInstantPageResponse, type ZaloInstantPagesUpsertInstantPageFormRequest, type ZaloInstantPagesUpsertInstantPageFormResponse, type ZaloIntegrationCredentials, type ZaloIntegrationVerificationResult, type ZaloPlaySessionPayload, type ZaloProfileAdsCreateOaPageRequest, type ZaloProfileAdsCreateOaPageResponse, ZaloProfileAdsService, type ZaloProfileAdsUploadOaAvatarRequest, type ZaloProfileAdsUploadOaAvatarResponse, type ZaloProfileAdsUploadOaCoverRequest, type ZaloProfileAdsUploadOaCoverResponse, type ZaloRedisLikeClient, type ZaloSdkAuth, type ZaloSdkAuthContext, ZaloSdkError, ZaloSdkHttpClient, type ZaloSessionStore, type ZaloSsoAuthOptions, type ZaloWidgetAPIGetOfficialAccountInfoRequest, type ZaloWidgetAPIGetOfficialAccountInfoResponse, type ZaloWidgetAPIGetWidgetUserProfileRequest, type ZaloWidgetAPIGetWidgetUserProfileResponse, type ZaloWidgetAPIListStickerCategoriesRequest, type ZaloWidgetAPIListStickerCategoriesResponse, type ZaloWidgetAPIListStickersByCategoryRequest, type ZaloWidgetAPIListStickersByCategoryResponse, ZaloWidgetApiService, computeZpsidFingerprint, createZaloSsoAuth, decodePlaySessionJwt, ZaloAdsSdk as default, defaultSharedMemorySessionStore, deriveAccountKeyFromZpsid, parseZaloCookieInput };
|
|
4831
|
+
/**
|
|
4832
|
+
* Bộ kiểm tra tính hợp lệ dữ liệu (Request Validators) cho 13 API Zalo Instant Pages.
|
|
4833
|
+
* Được thiết kế để xuất ra ngoài cho backend (NestJS/Express/Fastify), middleware hoặc AI Agent
|
|
4834
|
+
* sử dụng để xác thực dữ liệu đầu vào trước khi lưu trữ hoặc gọi API Zalo Ads.
|
|
4835
|
+
*
|
|
4836
|
+
* Lưu ý: Các hàm validate này là độc lập (pure functions), KHÔNG bị nhúng cứng bên trong
|
|
4837
|
+
* các hàm gọi HTTP của ZaloInstantPagesService, giúp giữ cho Service gọn gàng và unopinionated.
|
|
4838
|
+
*/
|
|
4839
|
+
|
|
4840
|
+
/** Kết quả xác thực dữ liệu đầu vào của API. */
|
|
4841
|
+
interface ValidationResult<T = unknown> {
|
|
4842
|
+
/** True nếu dữ liệu hợp lệ và thỏa mãn quy chuẩn; False nếu có ít nhất 1 lỗi. */
|
|
4843
|
+
isValid: boolean;
|
|
4844
|
+
/** Danh sách các thông báo lỗi chi tiết. Rỗng nếu isValid = true. */
|
|
4845
|
+
errors: string[];
|
|
4846
|
+
/** Dữ liệu sau khi làm sạch và ép kiểu chuẩn (nếu hợp lệ). */
|
|
4847
|
+
data?: T;
|
|
4848
|
+
}
|
|
4849
|
+
declare function validateCloneInstantPageRequest(input: unknown): ValidationResult<ZaloInstantPagesCloneInstantPageRequest>;
|
|
4850
|
+
declare function validateGetInstantPageDetailRequest(input: unknown): ValidationResult<ZaloInstantPagesGetInstantPageDetailRequest>;
|
|
4851
|
+
declare function validateGetInstantPageSharedUserRequest(input: unknown): ValidationResult<ZaloInstantPagesGetInstantPageSharedUserRequest>;
|
|
4852
|
+
declare function validateListInstantPageEditHistoryRequest(input: unknown): ValidationResult<ZaloInstantPagesListInstantPageEditHistoryRequest>;
|
|
4853
|
+
declare function validateListInstantPageFormRecordsRequest(input: unknown): ValidationResult<ZaloInstantPagesListInstantPageFormRecordsRequest>;
|
|
4854
|
+
declare function validateListInstantPageSharesRequest(input: unknown): ValidationResult<ZaloInstantPagesListInstantPageSharesRequest>;
|
|
4855
|
+
declare function validateListInstantPageUsersRequest(input?: unknown): ValidationResult<ZaloInstantPagesListInstantPageUsersRequest>;
|
|
4856
|
+
declare function validateListMiniPageTemplatesRequest(input?: unknown): ValidationResult<ZaloInstantPagesListMiniPageTemplatesRequest>;
|
|
4857
|
+
declare function validateSearchInstantPagesRequest(input?: unknown): ValidationResult<ZaloInstantPagesSearchInstantPagesRequest>;
|
|
4858
|
+
declare function validateUpdateInstantPageRequest(input: unknown): ValidationResult<ZaloInstantPagesUpdateInstantPageRequest>;
|
|
4859
|
+
declare function validateListInstantPageLeadsRequest(input: unknown): ValidationResult<ZaloInstantPagesListInstantPageLeadsRequest>;
|
|
4860
|
+
declare function validateListOfficialAccountsRequest(input?: unknown): ValidationResult<ZaloInstantPagesListOfficialAccountsRequest>;
|
|
4861
|
+
declare function validateUpsertInstantPageFormRequest(input: unknown): ValidationResult<ZaloInstantPagesUpsertInstantPageFormRequest>;
|
|
4862
|
+
declare const ZaloInstantPagesValidator: {
|
|
4863
|
+
validateCloneInstantPage: typeof validateCloneInstantPageRequest;
|
|
4864
|
+
validateGetInstantPageDetail: typeof validateGetInstantPageDetailRequest;
|
|
4865
|
+
validateGetInstantPageSharedUser: typeof validateGetInstantPageSharedUserRequest;
|
|
4866
|
+
validateListInstantPageEditHistory: typeof validateListInstantPageEditHistoryRequest;
|
|
4867
|
+
validateListInstantPageFormRecords: typeof validateListInstantPageFormRecordsRequest;
|
|
4868
|
+
validateListInstantPageShares: typeof validateListInstantPageSharesRequest;
|
|
4869
|
+
validateListInstantPageUsers: typeof validateListInstantPageUsersRequest;
|
|
4870
|
+
validateListMiniPageTemplates: typeof validateListMiniPageTemplatesRequest;
|
|
4871
|
+
validateSearchInstantPages: typeof validateSearchInstantPagesRequest;
|
|
4872
|
+
validateUpdateInstantPage: typeof validateUpdateInstantPageRequest;
|
|
4873
|
+
validateListInstantPageLeads: typeof validateListInstantPageLeadsRequest;
|
|
4874
|
+
validateListOfficialAccounts: typeof validateListOfficialAccountsRequest;
|
|
4875
|
+
validateUpsertInstantPageForm: typeof validateUpsertInstantPageFormRequest;
|
|
4876
|
+
};
|
|
4877
|
+
|
|
4878
|
+
export { ALL_ZALO_ADS_DOMAINS, type BodyType, type FileDownloadResponse, type FileInput, type HttpMethod, type MediaValidationResult, MemoryZaloSessionStore, type MemoryZaloSessionStoreOptions, type OperationDefinition, RedisZaloSessionStore, type RedisZaloSessionStoreOptions, type RequestOptions, TieredZaloSessionStore, type TieredZaloSessionStoreOptions, type ValidateImageInput, type ValidateVideoInput, type ValidationResult, ZaloAccountService, type ZaloAdsAccessorItemDto, type ZaloAdsAccountAgencyInfoDto, ZaloAdsIntegrationManager as ZaloAdsAccountPool, type ZaloAdsAdAppInfoSettingsDto, type ZaloAdsAdImageSettingsDto, type ZaloAdsAdInfoSettingsDto, type ZaloAdsAdMultiImageItemDto, type ZaloAdsAdMutationResultDto, type ZaloAdsAdPriceSettingsDto, type ZaloAdsAdReportItemDto, type ZaloAdsAdSettingsDto, type ZaloAdsAdTargetingSettingsDto, type ZaloAdsAdUpdatePayloadDto, type ZaloAdsAdZVideoSettingsDto, type ZaloAdsAutomatedRuleActionDto, type ZaloAdsAutomatedRuleConditionDto, type ZaloAdsAutomatedRuleScheduleDto, type ZaloAdsCampaignCreatePayloadDto, type ZaloAdsCampaignReportItemDto, type ZaloAdsChangeAutomatedRuleStatusRequest, type ZaloAdsChangeAutomatedRuleStatusResponse, type ZaloAdsChangeCampaignStatusRequest, type ZaloAdsChangeCampaignStatusResponse, type ZaloAdsClientRequest, type ZaloAdsCommerceFormAudienceTargetingDto, type ZaloAdsConversionElementSelectorDto, type ZaloAdsConversionItemDto, type ZaloAdsConversionNameItemDto, type ZaloAdsCreateArticleCampaignRequest, type ZaloAdsCreateArticleCampaignResponse, type ZaloAdsCreateAutomatedRuleRequest, type ZaloAdsCreateAutomatedRuleResponse, type ZaloAdsCreateCommerceCampaignRequest, type ZaloAdsCreateCommerceCampaignResponse, type ZaloAdsCreateCommerceFormAudienceRequest, type ZaloAdsCreateCommerceFormAudienceResponse, type ZaloAdsCreateConversionRequest, type ZaloAdsCreateConversionResponse, type ZaloAdsCreateCustomAudienceRequest, type ZaloAdsCreateCustomAudienceResponse, type ZaloAdsCreateDisplayCampaignRequest, type ZaloAdsCreateDisplayCampaignResponse, type ZaloAdsCreateEcommerceCampaignRequest, type ZaloAdsCreateEcommerceCampaignResponse, ZaloAdsCreateFlowRequest, ZaloAdsCreateFlowResponse, type ZaloAdsCreateFormCampaignRequest, type ZaloAdsCreateFormCampaignResponse, type ZaloAdsCreateFormEventAudienceRequest, type ZaloAdsCreateFormEventAudienceResponse, type ZaloAdsCreateFormLeadAudienceRequest, type ZaloAdsCreateFormLeadAudienceResponse, type ZaloAdsCreateFormPayloadDto, type ZaloAdsCreateFormRequest, type ZaloAdsCreateFormResponse, type ZaloAdsCreateLeadSignalAudienceRequest, type ZaloAdsCreateLeadSignalAudienceResponse, type ZaloAdsCreateLookalikeAudienceRequest, type ZaloAdsCreateLookalikeAudienceResponse, type ZaloAdsCreateMessageCampaignRequest, type ZaloAdsCreateMessageCampaignResponse, type ZaloAdsCreateMessageOaEventAudienceRequest, type ZaloAdsCreateMessageOaEventAudienceResponse, type ZaloAdsCreateMessageOaLeadAudienceRequest, type ZaloAdsCreateMessageOaLeadAudienceResponse, type ZaloAdsCreateMessagePersonalEventAudienceRequest, type ZaloAdsCreateMessagePersonalEventAudienceResponse, type ZaloAdsCreateOaCampaignRequest, type ZaloAdsCreateOaCampaignResponse, type ZaloAdsCreateOfficialAccountCampaignRequest, type ZaloAdsCreateOfficialAccountCampaignResponse, type ZaloAdsCreatePhoneAudienceRequest, type ZaloAdsCreatePhoneAudienceResponse, ZaloAdsCreatePostCampaignRequest, ZaloAdsCreatePostCampaignResponse, type ZaloAdsCreateSavedAudienceRequest, type ZaloAdsCreateSavedAudienceResponse, type ZaloAdsCreateVideoCampaignRequest, type ZaloAdsCreateVideoCampaignResponse, type ZaloAdsCreateWebsiteCampaignRequest, type ZaloAdsCreateWebsiteCampaignResponse, type ZaloAdsDeleteAutomatedRuleRequest, type ZaloAdsDeleteAutomatedRuleResponse, type ZaloAdsDeleteCampaignRequest, type ZaloAdsDeleteCampaignResponse, type ZaloAdsDeleteConversionRequest, type ZaloAdsDeleteConversionResponse, type ZaloAdsDeleteCustomAudienceRequest, type ZaloAdsDeleteCustomAudienceResponse, type ZaloAdsDeleteCustomReportRequest, type ZaloAdsDeleteCustomReportResponse, type ZaloAdsDomain, type ZaloAdsFileGroupItemDto, ZaloAdsFlowButtonDto, ZaloAdsFlowChildMessageDto, ZaloAdsFlowMessageDto, type ZaloAdsFormAnswerDto, type ZaloAdsFormEventAudienceTargetingDto, type ZaloAdsFormLeadAudienceTargetingDto, type ZaloAdsFormQuestionDto, type ZaloAdsFormQuestionUiDto, type ZaloAdsFormSectionContentDto, type ZaloAdsFormSectionDto, type ZaloAdsFormSectionImageItemDto, type ZaloAdsFormSectionTableItemDto, type ZaloAdsGetAdByIdRequest, type ZaloAdsGetAdByIdResponse, type ZaloAdsGetAdChangeLogRequest, type ZaloAdsGetAdChangeLogResponse, type ZaloAdsGetApiAdGetlistadadvancetargetingRequest, type ZaloAdsGetApiAdGetlistadadvancetargetingResponse, type ZaloAdsGetApiBaAccountAllaccessorsRequest, type ZaloAdsGetApiBaAccountAllaccessorsResponse, type ZaloAdsGetApiBaAccountAllgrantedmembersRequest, type ZaloAdsGetApiBaAccountAllgrantedmembersResponse, type ZaloAdsGetApiConversionAllRequest, type ZaloAdsGetApiConversionAllResponse, type ZaloAdsGetApiConversionStandardEventsRequest, type ZaloAdsGetApiConversionStandardEventsResponse, type ZaloAdsGetApiCustomAudienceAllRequest, type ZaloAdsGetApiCustomAudienceAllResponse, type ZaloAdsGetApiFilegroupsRequest, type ZaloAdsGetApiFilegroupsResponse, type ZaloAdsGetApiLpNewsRequest, type ZaloAdsGetApiLpNewsResponse, type ZaloAdsGetApiMediaItemsRequest, type ZaloAdsGetApiMediaItemsResponse, type ZaloAdsGetApiMemberFilesRequest, type ZaloAdsGetApiMemberFilesResponse, type ZaloAdsGetApiNotifiesHeaderRequest, type ZaloAdsGetApiNotifiesHeaderResponse, type ZaloAdsGetApiPaymentTransactionHistoryRequest, type ZaloAdsGetApiPaymentTransactionHistoryResponse, type ZaloAdsGetApiPlaceGetalldistrictsRequest, type ZaloAdsGetApiPlaceGetalldistrictsResponse, type ZaloAdsGetApiSpellCheckV2Request, type ZaloAdsGetApiSpellCheckV2Response, type ZaloAdsGetApiWhoamiRequest, type ZaloAdsGetApiWhoamiResponse, type ZaloAdsGetAutomatedRuleHistoryRequest, type ZaloAdsGetAutomatedRuleHistoryResponse, type ZaloAdsGetDemographicsReportRequest, type ZaloAdsGetDemographicsReportResponse, type ZaloAdsGetReportOverviewRequest, type ZaloAdsGetReportOverviewResponse, type ZaloAdsGetReportapiV2AdsRequest, type ZaloAdsGetReportapiV2AdsResponse, type ZaloAdsGetReportapiV2CampaignsRequest, type ZaloAdsGetReportapiV2CampaignsResponse, type ZaloAdsGetReportapiV2UniqueUserRequest, type ZaloAdsGetReportapiV2UniqueUserResponse, type ZaloAdsGetReportapiV3CampaignsRequest, type ZaloAdsGetReportapiV3CampaignsResponse, type ZaloAdsGetZaapiCampaignReportcampaignRequest, type ZaloAdsGetZaapiCampaignReportcampaignResponse, type ZaloAdsGetZaapiCheckcamphasmanyadsRequest, type ZaloAdsGetZaapiCheckcamphasmanyadsResponse, type ZaloAdsGetZaapiGetadsfromcampaignidRequest, type ZaloAdsGetZaapiGetadsfromcampaignidResponse, type ZaloAdsGetZaapiGetallpagesRequest, type ZaloAdsGetZaapiGetallpagesResponse, type ZaloAdsGetZaapiGetownedarticlesRequest, type ZaloAdsGetZaapiGetownedarticlesResponse, type ZaloAdsGetZaapiGetownedpagesRequest, type ZaloAdsGetZaapiGetownedpagesResponse, type ZaloAdsGrantedMemberItemDto, ZaloAdsIntegrationManager, type ZaloAdsIntegrationManagerOptions, type ZaloAdsLeadSignalAudienceTargetingDto, type ZaloAdsLeadSignalOaItem, type ZaloAdsListAgencyCustomersWithBudgetRequest, type ZaloAdsListAgencyCustomersWithBudgetResponse, type ZaloAdsListAutomatedRulesRequest, type ZaloAdsListAutomatedRulesResponse, type ZaloAdsListConversionNamesRequest, type ZaloAdsListConversionNamesResponse, type ZaloAdsListCustomReportsRequest, type ZaloAdsListCustomReportsResponse, type ZaloAdsListFlowsByOfficialAccountRequest, type ZaloAdsListFlowsByOfficialAccountResponse, type ZaloAdsListFormsByOfficialAccountRequest, type ZaloAdsListFormsByOfficialAccountResponse, type ZaloAdsListLeadSignalOasResponse, type ZaloAdsListMiniPagesByTemplateRequest, type ZaloAdsListMiniPagesByTemplateResponse, type ZaloAdsListPersonalPixelLabelsRequest, type ZaloAdsListPersonalPixelLabelsResponse, type ZaloAdsListReportFiltersRequest, type ZaloAdsListReportFiltersResponse, type ZaloAdsLookalikeAudienceTargetingDto, type ZaloAdsLpNewsButtonDto, type ZaloAdsLpNewsItemDto, type ZaloAdsMediaSavePayloadDto, type ZaloAdsMediaSaveSettingsDto, type ZaloAdsMemberFileItemDto, ZaloAdsMessageAdUpdateDataDto, type ZaloAdsMessageOaEventAudienceTargetingDto, type ZaloAdsMessageOaLeadAudienceTargetingDto, type ZaloAdsMessagePersonalEventAudienceTargetingDto, type ZaloAdsNotifyHeaderItemDto, type ZaloAdsOwnedArticleItemDto, type ZaloAdsOwnedPageExtraInfoDto, type ZaloAdsOwnedPageItemDto, type ZaloAdsOwnedPageLocationDto, type ZaloAdsPageConfigDto, type ZaloAdsPaymentTransactionItemDto, type ZaloAdsPhoneAudienceTargetingDto, type ZaloAdsPostApiAdEstimateaudienceRequest, type ZaloAdsPostApiAdEstimateaudienceResponse, type ZaloAdsPostApiMediaSaveRequest, type ZaloAdsPostApiMediaSaveResponse, type ZaloAdsPostApiMemberUploadImageRequest, type ZaloAdsPostApiMemberUploadImageResponse, type ZaloAdsPostZaapiDeleteadRequest, type ZaloAdsPostZaapiDeleteadResponse, type ZaloAdsRenameCampaignRequest, type ZaloAdsRenameCampaignResponse, ZaloAdsSdk, type ZaloAdsSdkOptions, ZaloAdsService, type ZaloAdsSpellCheckIssueDto, type ZaloAdsStandardEventItemDto, type ZaloAdsUniqueUserReportDataDto, type ZaloAdsUpdateArticleAdRequest, type ZaloAdsUpdateArticleAdResponse, type ZaloAdsUpdateAutomatedRuleRequest, type ZaloAdsUpdateAutomatedRuleResponse, type ZaloAdsUpdateCommerceAdRequest, type ZaloAdsUpdateCommerceAdResponse, type ZaloAdsUpdateDisplayAdRequest, type ZaloAdsUpdateDisplayAdResponse, type ZaloAdsUpdateEcommerceAdRequest, type ZaloAdsUpdateEcommerceAdResponse, type ZaloAdsUpdateFlowRequest, type ZaloAdsUpdateFlowResponse, type ZaloAdsUpdateFormAdRequest, type ZaloAdsUpdateFormAdResponse, ZaloAdsUpdateMessageAdRequest, ZaloAdsUpdateMessageAdResponse, type ZaloAdsUpdateNewAdsRequest, type ZaloAdsUpdateNewAdsResponse, type ZaloAdsUpdateOaAdRequest, type ZaloAdsUpdateOaAdResponse, type ZaloAdsUpdateOfficialAccountAdRequest, type ZaloAdsUpdateOfficialAccountAdResponse, type ZaloAdsUpdatePostAdRequest, type ZaloAdsUpdatePostAdResponse, ZaloAdsUpdateVideoAdRequest, ZaloAdsUpdateVideoAdResponse, type ZaloAdsUpdateWebsiteAdRequest, type ZaloAdsUpdateWebsiteAdResponse, type ZaloAdsUploadCustomAudiencePhoneListRequest, type ZaloAdsUploadCustomAudiencePhoneListResponse, type ZaloAdsUploadVideoRequest, type ZaloAdsUploadVideoResponse, type ZaloAdsUpsertCustomReportRequest, type ZaloAdsUpsertCustomReportResponse, type ZaloAdsWhoamiProfile, type ZaloAdsZaapiCampaignReportItemDto, ZaloAudiencesService, type ZaloAuthDomain, ZaloAuthManager, ZaloAutomatedRulesService, ZaloCampaignsService, type ZaloChatWidgetGetChatWidgetLoginConfigRequest, type ZaloChatWidgetGetChatWidgetLoginConfigResponse, type ZaloChatWidgetGetLoginConfigRequest, type ZaloChatWidgetGetLoginConfigResponse, ZaloChatWidgetService, ZaloConversionsService, type ZaloDomainSession, ZaloFlowsService, type ZaloFormSessionProfile, type ZaloFormsAudienceExclusionTargetingItem, type ZaloFormsAuthSessionOaItem, type ZaloFormsConversationLeadItem, type ZaloFormsDisableFormLeadNotificationRequest, type ZaloFormsDisableFormLeadNotificationResponse, type ZaloFormsEnableFormLeadNotificationRequest, type ZaloFormsEnableFormLeadNotificationResponse, type ZaloFormsExportFormLeadReportRequest, type ZaloFormsExportFormLeadReportResponse, type ZaloFormsGetAuthSessionResponse, type ZaloFormsLeadAnswerItem, type ZaloFormsLeadItem, type ZaloFormsListAudienceExclusionTargetingRequest, type ZaloFormsListAudienceExclusionTargetingResponse, type ZaloFormsListConversationLeadsRequest, type ZaloFormsListConversationLeadsResponse, type ZaloFormsListFormLeadsRequest, type ZaloFormsListFormLeadsResponse, type ZaloFormsListManagedFormsByOfficialAccountRequest, type ZaloFormsListManagedFormsByOfficialAccountResponse, type ZaloFormsListScenariosByOfficialAccountRequest, type ZaloFormsListScenariosByOfficialAccountResponse, type ZaloFormsListSimpleFormsByOfficialAccountRequest, type ZaloFormsListSimpleFormsByOfficialAccountResponse, type ZaloFormsScenarioItem, ZaloFormsService, type ZaloFormsUpdateFormLeadNotificationIntervalRequest, type ZaloFormsUpdateFormLeadNotificationIntervalResponse, type ZaloInstantPageActive, ZaloInstantPageBlockType, type ZaloInstantPageStatus, type ZaloInstantPagesCloneInstantPageRequest, type ZaloInstantPagesCloneInstantPageResponse, type ZaloInstantPagesFormRecordItem, type ZaloInstantPagesGetInstantPageDetailRequest, type ZaloInstantPagesGetInstantPageDetailResponse, type ZaloInstantPagesGetInstantPageSharedUserRequest, type ZaloInstantPagesGetInstantPageSharedUserResponse, type ZaloInstantPagesListInstantPageEditHistoryRequest, type ZaloInstantPagesListInstantPageEditHistoryResponse, type ZaloInstantPagesListInstantPageFormRecordsRequest, type ZaloInstantPagesListInstantPageFormRecordsResponse, type ZaloInstantPagesListInstantPageLeadsRequest, type ZaloInstantPagesListInstantPageLeadsResponse, type ZaloInstantPagesListInstantPageSharesRequest, type ZaloInstantPagesListInstantPageSharesResponse, type ZaloInstantPagesListInstantPageUsersRequest, type ZaloInstantPagesListInstantPageUsersResponse, type ZaloInstantPagesListMiniPageTemplatesRequest, type ZaloInstantPagesListMiniPageTemplatesResponse, type ZaloInstantPagesListOfficialAccountsRequest, type ZaloInstantPagesListOfficialAccountsResponse, type ZaloInstantPagesOfficialAccountItem, type ZaloInstantPagesSearchInstantPagesRequest, type ZaloInstantPagesSearchInstantPagesResponse, ZaloInstantPagesService, type ZaloInstantPagesUpdateInstantPageRequest, type ZaloInstantPagesUpdateInstantPageResponse, type ZaloInstantPagesUpsertInstantPageFormRequest, type ZaloInstantPagesUpsertInstantPageFormResponse, ZaloInstantPagesValidator, type ZaloIntegrationCredentials, type ZaloIntegrationVerificationResult, ZaloMediaService, type ZaloPlaySessionPayload, type ZaloProfileAdsAdministrativeItem, type ZaloProfileAdsCreateOaPageRequest, type ZaloProfileAdsCreateOaPageResponse, type ZaloProfileAdsGetDistrictsRequest, type ZaloProfileAdsGetDistrictsResponse, type ZaloProfileAdsGetProvincesResponse, type ZaloProfileAdsProvinceId, ZaloProfileAdsService, type ZaloProfileAdsSubCategoryId, type ZaloProfileAdsUploadOaAvatarRequest, type ZaloProfileAdsUploadOaAvatarResponse, type ZaloProfileAdsUploadOaCoverRequest, type ZaloProfileAdsUploadOaCoverResponse, type ZaloRedisLikeClient, ZaloReportsService, type ZaloSdkAuth, type ZaloSdkAuthContext, ZaloSdkError, ZaloSdkHttpClient, type ZaloSessionStore, type ZaloSsoAuthOptions, type ZaloUploadAndSaveImageRequest, type ZaloUploadAndSaveImageResult, type ZaloUploadAndSaveVideoRequest, type ZaloUploadAndSaveVideoResult, type ZaloWidgetAPIGetOfficialAccountInfoRequest, type ZaloWidgetAPIGetOfficialAccountInfoResponse, type ZaloWidgetAPIGetWidgetUserProfileRequest, type ZaloWidgetAPIGetWidgetUserProfileResponse, type ZaloWidgetAPIListStickerCategoriesRequest, type ZaloWidgetAPIListStickerCategoriesResponse, type ZaloWidgetAPIListStickersByCategoryRequest, type ZaloWidgetAPIListStickersByCategoryResponse, ZaloWidgetApiService, computeZpsidFingerprint, createZaloSsoAuth, decodePlaySessionJwt, ZaloAdsSdk as default, defaultSharedMemorySessionStore, deriveAccountKeyFromZpsid, parseZaloCookieInput, validateCloneInstantPageRequest, validateGetInstantPageDetailRequest, validateGetInstantPageSharedUserRequest, validateListInstantPageEditHistoryRequest, validateListInstantPageFormRecordsRequest, validateListInstantPageLeadsRequest, validateListInstantPageSharesRequest, validateListInstantPageUsersRequest, validateListMiniPageTemplatesRequest, validateListOfficialAccountsRequest, validateSearchInstantPagesRequest, validateUpdateInstantPageRequest, validateUpsertInstantPageFormRequest };
|