@redonvn/zalo-ads-sdk 0.2.0 → 0.2.2
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 +943 -486
- package/dist/index.d.ts +943 -486
- package/dist/index.js +128 -18
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +118 -18
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -577,7 +577,6 @@ type ZaloInstantPagesListInstantPageEditHistoryResponse = {
|
|
|
577
577
|
created: number;
|
|
578
578
|
/** Tên hiển thị của người dùng thực hiện thao tác. */
|
|
579
579
|
userName: string;
|
|
580
|
-
[key: string]: unknown;
|
|
581
580
|
}>;
|
|
582
581
|
metadata: {
|
|
583
582
|
/** Giới hạn bản ghi của trang đã trả về. */
|
|
@@ -586,19 +585,32 @@ type ZaloInstantPagesListInstantPageEditHistoryResponse = {
|
|
|
586
585
|
total: number;
|
|
587
586
|
/** Vị trí bắt đầu của trang đã trả về. */
|
|
588
587
|
offset: number;
|
|
589
|
-
[key: string]: unknown;
|
|
590
588
|
};
|
|
591
|
-
[key: string]: unknown;
|
|
592
589
|
};
|
|
593
|
-
[key: string]: unknown;
|
|
594
590
|
};
|
|
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ể.
|
|
591
|
+
/** 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
592
|
type ZaloInstantPagesListInstantPageFormRecordsRequest = {
|
|
597
593
|
/** ID Instant Page có form cần lấy bản ghi gửi. */
|
|
598
594
|
instantPageId: number;
|
|
599
595
|
};
|
|
596
|
+
type ZaloInstantPagesFormRecordItem = {
|
|
597
|
+
id: string;
|
|
598
|
+
pageId: number;
|
|
599
|
+
userId?: string;
|
|
600
|
+
userName?: string;
|
|
601
|
+
phone?: string;
|
|
602
|
+
created: number;
|
|
603
|
+
answers: Array<{
|
|
604
|
+
questionId: string;
|
|
605
|
+
title: string;
|
|
606
|
+
value: string;
|
|
607
|
+
}>;
|
|
608
|
+
};
|
|
600
609
|
type ZaloInstantPagesListInstantPageFormRecordsResponse = {
|
|
601
|
-
|
|
610
|
+
data: {
|
|
611
|
+
items: Array<ZaloInstantPagesFormRecordItem>;
|
|
612
|
+
total: number;
|
|
613
|
+
};
|
|
602
614
|
};
|
|
603
615
|
/** 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
616
|
type ZaloInstantPagesListInstantPageSharesRequest = {
|
|
@@ -968,60 +980,195 @@ type ZaloAdsUpdateFlowRequest = {
|
|
|
968
980
|
messages: ZaloAdsFlowMessageDto[];
|
|
969
981
|
};
|
|
970
982
|
type ZaloAdsUpdateFlowResponse = {
|
|
971
|
-
code
|
|
983
|
+
code: number;
|
|
972
984
|
msg?: string;
|
|
973
|
-
data?:
|
|
974
|
-
|
|
985
|
+
data?: {
|
|
986
|
+
id?: number;
|
|
987
|
+
};
|
|
975
988
|
};
|
|
989
|
+
interface ZaloAdsAdPriceSettingsDto {
|
|
990
|
+
Bid: number;
|
|
991
|
+
Type: number;
|
|
992
|
+
Limit: number;
|
|
993
|
+
LimitType: number;
|
|
994
|
+
SpendingMethod: number;
|
|
995
|
+
}
|
|
996
|
+
interface ZaloAdsAdMultiImageItemDto {
|
|
997
|
+
Url: string;
|
|
998
|
+
Title?: string;
|
|
999
|
+
Description?: string;
|
|
1000
|
+
TargetUrl?: string;
|
|
1001
|
+
}
|
|
1002
|
+
interface ZaloAdsAdImageSettingsDto {
|
|
1003
|
+
LogoUrl?: string;
|
|
1004
|
+
LandscapeCoverUrl?: string;
|
|
1005
|
+
SquareCoverUrl?: string;
|
|
1006
|
+
VideoUrl?: string;
|
|
1007
|
+
VideoDuration?: number;
|
|
1008
|
+
MediaId?: number;
|
|
1009
|
+
MultiImages?: Array<ZaloAdsAdMultiImageItemDto>;
|
|
1010
|
+
}
|
|
1011
|
+
interface ZaloAdsAdInfoSettingsDto {
|
|
1012
|
+
Title?: string;
|
|
1013
|
+
Description?: string;
|
|
1014
|
+
Caption?: string;
|
|
1015
|
+
Action?: number;
|
|
1016
|
+
ButtonText?: string;
|
|
1017
|
+
MoreInfo?: string;
|
|
1018
|
+
TargetUrl?: string;
|
|
1019
|
+
Phone?: string;
|
|
1020
|
+
Address?: string;
|
|
1021
|
+
}
|
|
1022
|
+
interface ZaloAdsAdAppInfoSettingsDto {
|
|
1023
|
+
AppType?: number;
|
|
1024
|
+
OsType?: number;
|
|
1025
|
+
StoreUrl?: string;
|
|
1026
|
+
}
|
|
1027
|
+
interface ZaloAdsAdTargetingSettingsDto {
|
|
1028
|
+
Gender?: number;
|
|
1029
|
+
AgeRanges?: Array<number>;
|
|
1030
|
+
Locations?: string;
|
|
1031
|
+
Provinces?: Array<number>;
|
|
1032
|
+
DistrictsTargeting?: string;
|
|
1033
|
+
WardsTargeting?: string;
|
|
1034
|
+
Platforms?: Array<number>;
|
|
1035
|
+
NetworkTypes?: Array<number>;
|
|
1036
|
+
OsTypes?: Array<number>;
|
|
1037
|
+
AdvanceTargetings?: Array<number>;
|
|
1038
|
+
CustomAudiences?: Array<number>;
|
|
1039
|
+
ExcludeCustomAudiences?: Array<number>;
|
|
1040
|
+
}
|
|
1041
|
+
interface ZaloAdsAdZVideoSettingsDto {
|
|
1042
|
+
Url: string;
|
|
1043
|
+
Duration: number;
|
|
1044
|
+
Src: number;
|
|
1045
|
+
Thumbnail: string;
|
|
1046
|
+
Description: string;
|
|
1047
|
+
ChannelName: string;
|
|
1048
|
+
ChannelAvt: string;
|
|
1049
|
+
VideoThumbnail: string;
|
|
1050
|
+
ThumbnailIndex: number | null;
|
|
1051
|
+
}
|
|
1052
|
+
interface ZaloAdsAdSettingsDto {
|
|
1053
|
+
Image: ZaloAdsAdImageSettingsDto;
|
|
1054
|
+
Price: ZaloAdsAdPriceSettingsDto;
|
|
1055
|
+
AdInfo: ZaloAdsAdInfoSettingsDto;
|
|
1056
|
+
AppInfo?: ZaloAdsAdAppInfoSettingsDto;
|
|
1057
|
+
Targeting: ZaloAdsAdTargetingSettingsDto;
|
|
1058
|
+
ZVideo?: ZaloAdsAdZVideoSettingsDto;
|
|
1059
|
+
VideoPlatform?: number;
|
|
1060
|
+
Rating?: number;
|
|
1061
|
+
NewFeatures?: Array<number>;
|
|
1062
|
+
CreatedClientVersion?: number;
|
|
1063
|
+
}
|
|
1064
|
+
interface ZaloAdsAdUpdatePayloadDto {
|
|
1065
|
+
AdId: number;
|
|
1066
|
+
CampaignId: number;
|
|
1067
|
+
MemberId: number;
|
|
1068
|
+
RowVersion: number;
|
|
1069
|
+
AdName: string;
|
|
1070
|
+
Type: number;
|
|
1071
|
+
Settings: ZaloAdsAdSettingsDto;
|
|
1072
|
+
Status: number;
|
|
1073
|
+
StartDate: number;
|
|
1074
|
+
EndDate: number;
|
|
1075
|
+
ZaloFlowId?: number;
|
|
1076
|
+
ZaloPageId?: number;
|
|
1077
|
+
ZaloFormId?: string;
|
|
1078
|
+
ZaloFeedId?: string | number;
|
|
1079
|
+
MiniPageId?: number;
|
|
1080
|
+
UseConversion?: 0 | 1;
|
|
1081
|
+
ConversionId?: number;
|
|
1082
|
+
Report?: Record<string, number>;
|
|
1083
|
+
}
|
|
1084
|
+
interface ZaloAdsAdMutationResultDto {
|
|
1085
|
+
AdId?: number;
|
|
1086
|
+
CampaignId?: number;
|
|
1087
|
+
Status?: number;
|
|
1088
|
+
RowVersion?: number;
|
|
1089
|
+
}
|
|
1090
|
+
interface ZaloAdsCampaignCreatePayloadDto {
|
|
1091
|
+
name: string;
|
|
1092
|
+
campaignType: number;
|
|
1093
|
+
pageId: number;
|
|
1094
|
+
productId: number;
|
|
1095
|
+
targetUrl?: string;
|
|
1096
|
+
articleId?: number;
|
|
1097
|
+
adtype: number;
|
|
1098
|
+
budgetType: number;
|
|
1099
|
+
budgetlimit: number;
|
|
1100
|
+
limitType: number;
|
|
1101
|
+
campaignObjective: number;
|
|
1102
|
+
campaignId: number;
|
|
1103
|
+
adId: number;
|
|
1104
|
+
}
|
|
1105
|
+
interface ZaloAdsFormSectionTableItemDto {
|
|
1106
|
+
key: string;
|
|
1107
|
+
value: string;
|
|
1108
|
+
}
|
|
1109
|
+
interface ZaloAdsFormSectionImageItemDto {
|
|
1110
|
+
url: string;
|
|
1111
|
+
title?: string;
|
|
1112
|
+
caption?: string;
|
|
1113
|
+
}
|
|
1114
|
+
interface ZaloAdsFormSectionContentDto {
|
|
1115
|
+
title?: string;
|
|
1116
|
+
description?: string;
|
|
1117
|
+
table?: Array<ZaloAdsFormSectionTableItemDto>;
|
|
1118
|
+
images?: Array<ZaloAdsFormSectionImageItemDto>;
|
|
1119
|
+
}
|
|
1120
|
+
interface ZaloAdsFormSectionDto {
|
|
1121
|
+
type: "0" | "1" | "2" | "3" | "4" | number;
|
|
1122
|
+
title: string;
|
|
1123
|
+
expand: boolean;
|
|
1124
|
+
disable: boolean;
|
|
1125
|
+
content: ZaloAdsFormSectionContentDto;
|
|
1126
|
+
}
|
|
1127
|
+
interface ZaloAdsFormQuestionUiDto {
|
|
1128
|
+
icon?: string;
|
|
1129
|
+
title?: string;
|
|
1130
|
+
removable?: boolean;
|
|
1131
|
+
}
|
|
1132
|
+
interface ZaloAdsFormAnswerDto {
|
|
1133
|
+
id?: string;
|
|
1134
|
+
type: "2" | "7" | "13" | number;
|
|
1135
|
+
value?: string | null;
|
|
1136
|
+
priority?: number;
|
|
1137
|
+
placeHolder?: string;
|
|
1138
|
+
}
|
|
1139
|
+
interface ZaloAdsFormQuestionDto {
|
|
1140
|
+
id?: string;
|
|
1141
|
+
ui?: ZaloAdsFormQuestionUiDto;
|
|
1142
|
+
type: "1" | number;
|
|
1143
|
+
title: string;
|
|
1144
|
+
answers: Array<ZaloAdsFormAnswerDto>;
|
|
1145
|
+
groupIdx?: number;
|
|
1146
|
+
priority?: number;
|
|
1147
|
+
isRequired: boolean;
|
|
1148
|
+
editDisabled?: boolean;
|
|
1149
|
+
}
|
|
1150
|
+
interface ZaloAdsCreateFormPayloadDto {
|
|
1151
|
+
id?: string;
|
|
1152
|
+
oaId: string;
|
|
1153
|
+
formName: string;
|
|
1154
|
+
title?: string;
|
|
1155
|
+
description?: string;
|
|
1156
|
+
coverPhoto?: string;
|
|
1157
|
+
thanks?: string;
|
|
1158
|
+
gotoText?: string;
|
|
1159
|
+
gotoActionType?: number;
|
|
1160
|
+
website?: string;
|
|
1161
|
+
phone?: string;
|
|
1162
|
+
submitTitle?: string;
|
|
1163
|
+
reviewSubmit?: boolean;
|
|
1164
|
+
oaConsentWidget?: boolean;
|
|
1165
|
+
useCustomConsent?: boolean;
|
|
1166
|
+
sections?: Array<ZaloAdsFormSectionDto>;
|
|
1167
|
+
questions: Array<ZaloAdsFormQuestionDto>;
|
|
1168
|
+
}
|
|
976
1169
|
/** Cập nhật quảng cáo Video; service tự JSON.stringify data rồi gửi form-urlencoded. */
|
|
977
1170
|
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
|
-
};
|
|
1171
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
1025
1172
|
est?: string;
|
|
1026
1173
|
isBoostAd?: 0 | 1;
|
|
1027
1174
|
stt?: number;
|
|
@@ -1029,7 +1176,7 @@ declare class ZaloAdsUpdateVideoAdRequest {
|
|
|
1029
1176
|
declare class ZaloAdsUpdateVideoAdResponse {
|
|
1030
1177
|
code: number;
|
|
1031
1178
|
msg: string;
|
|
1032
|
-
data?:
|
|
1179
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
1033
1180
|
}
|
|
1034
1181
|
/** 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
1182
|
type ZaloAdsListFlowsByOfficialAccountRequest = {
|
|
@@ -1060,20 +1207,20 @@ type ZaloAdsListFlowsByOfficialAccountResponse = {
|
|
|
1060
1207
|
text: string;
|
|
1061
1208
|
editable: boolean;
|
|
1062
1209
|
url: string;
|
|
1063
|
-
messages: Array<
|
|
1210
|
+
messages: Array<ZaloAdsFlowChildMessageDto>;
|
|
1211
|
+
}>;
|
|
1212
|
+
elements: Array<{
|
|
1213
|
+
type?: number;
|
|
1214
|
+
title?: string;
|
|
1215
|
+
url?: string;
|
|
1064
1216
|
}>;
|
|
1065
|
-
elements: Array<unknown>;
|
|
1066
1217
|
stepId: number;
|
|
1067
|
-
[key: string]: unknown;
|
|
1068
1218
|
}>;
|
|
1069
|
-
[key: string]: unknown;
|
|
1070
1219
|
}>;
|
|
1071
1220
|
extend: {
|
|
1072
1221
|
total: number;
|
|
1073
1222
|
index?: number;
|
|
1074
|
-
[key: string]: unknown;
|
|
1075
1223
|
};
|
|
1076
|
-
[key: string]: unknown;
|
|
1077
1224
|
};
|
|
1078
1225
|
/** 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
1226
|
type ZaloAdsChangeCampaignStatusRequest = {
|
|
@@ -1131,7 +1278,7 @@ type ZaloAdsCreateCustomAudienceResponse = {
|
|
|
1131
1278
|
/** 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
1279
|
type ZaloAdsCreateEcommerceCampaignRequest = {
|
|
1133
1280
|
/** 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:
|
|
1281
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
1135
1282
|
};
|
|
1136
1283
|
type ZaloAdsCreateEcommerceCampaignResponse = {
|
|
1137
1284
|
msg: string;
|
|
@@ -1144,8 +1291,8 @@ type ZaloAdsCreateEcommerceCampaignResponse = {
|
|
|
1144
1291
|
};
|
|
1145
1292
|
/** 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
1293
|
type ZaloAdsCreateFormRequest = {
|
|
1147
|
-
/**
|
|
1148
|
-
data:
|
|
1294
|
+
/** 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). */
|
|
1295
|
+
data: ZaloAdsCreateFormPayloadDto | string;
|
|
1149
1296
|
};
|
|
1150
1297
|
type ZaloAdsCreateFormResponse = {
|
|
1151
1298
|
code: "0" | 0;
|
|
@@ -1159,57 +1306,8 @@ type ZaloAdsCreateFormResponse = {
|
|
|
1159
1306
|
/** Unix epoch giây. */
|
|
1160
1307
|
createAt: number;
|
|
1161
1308
|
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
|
-
}>;
|
|
1309
|
+
sections: Array<ZaloAdsFormSectionDto>;
|
|
1310
|
+
questions: Array<ZaloAdsFormQuestionDto>;
|
|
1213
1311
|
/** Unix epoch giây. */
|
|
1214
1312
|
updatedAt: number;
|
|
1215
1313
|
description?: string;
|
|
@@ -1218,7 +1316,7 @@ type ZaloAdsCreateFormResponse = {
|
|
|
1218
1316
|
/** 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
1317
|
type ZaloAdsCreateFormCampaignRequest = {
|
|
1220
1318
|
/** Cấu hình chiến dịch biểu mẫu (object hoặc chuỗi JSON). */
|
|
1221
|
-
data:
|
|
1319
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
1222
1320
|
};
|
|
1223
1321
|
type ZaloAdsCreateFormCampaignResponse = {
|
|
1224
1322
|
msg: string;
|
|
@@ -1231,7 +1329,7 @@ type ZaloAdsCreateFormCampaignResponse = {
|
|
|
1231
1329
|
/** 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
1330
|
type ZaloAdsCreateMessageCampaignRequest = {
|
|
1233
1331
|
/** Cấu hình chiến dịch Tin nhắn (object hoặc chuỗi JSON). */
|
|
1234
|
-
data:
|
|
1332
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
1235
1333
|
};
|
|
1236
1334
|
type ZaloAdsCreateMessageCampaignResponse = {
|
|
1237
1335
|
code?: number;
|
|
@@ -1247,7 +1345,7 @@ type ZaloAdsCreateMessageCampaignResponse = {
|
|
|
1247
1345
|
/** 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
1346
|
type ZaloAdsCreateOfficialAccountCampaignRequest = {
|
|
1249
1347
|
/** Cấu hình chiến dịch Official Account (object hoặc chuỗi JSON). */
|
|
1250
|
-
data:
|
|
1348
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
1251
1349
|
};
|
|
1252
1350
|
type ZaloAdsCreateOfficialAccountCampaignResponse = {
|
|
1253
1351
|
msg: string;
|
|
@@ -1261,27 +1359,7 @@ type ZaloAdsCreateOfficialAccountCampaignResponse = {
|
|
|
1261
1359
|
/** 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
1360
|
declare class ZaloAdsCreatePostCampaignRequest {
|
|
1263
1361
|
/** 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;
|
|
1362
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
1285
1363
|
}
|
|
1286
1364
|
declare class ZaloAdsCreatePostCampaignResponse {
|
|
1287
1365
|
code: number;
|
|
@@ -1292,6 +1370,11 @@ declare class ZaloAdsCreatePostCampaignResponse {
|
|
|
1292
1370
|
campaignId: number;
|
|
1293
1371
|
};
|
|
1294
1372
|
}
|
|
1373
|
+
interface ZaloAdsConversionElementSelectorDto {
|
|
1374
|
+
class?: Array<string>;
|
|
1375
|
+
id?: string;
|
|
1376
|
+
tag?: string;
|
|
1377
|
+
}
|
|
1295
1378
|
/** 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
1379
|
type ZaloAdsCreateConversionRequest = {
|
|
1297
1380
|
/** Tên conversion, phải duy nhất trong tài khoản quảng cáo (2–180 ký tự). */
|
|
@@ -1301,10 +1384,7 @@ type ZaloAdsCreateConversionRequest = {
|
|
|
1301
1384
|
/** Kiểu khớp URL: 1 hoặc 2. */
|
|
1302
1385
|
urlType: 1 | 2 | number;
|
|
1303
1386
|
/** 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
|
-
}>;
|
|
1387
|
+
elements: Array<ZaloAdsConversionElementSelectorDto>;
|
|
1308
1388
|
/** Từ khóa URL cần ghi nhận; dùng mảng rỗng khi không áp dụng. */
|
|
1309
1389
|
keywords: Array<string>;
|
|
1310
1390
|
/** 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 +1392,20 @@ type ZaloAdsCreateConversionRequest = {
|
|
|
1312
1392
|
/** URL trang đích có Zalo Pixel. */
|
|
1313
1393
|
landingPage: string;
|
|
1314
1394
|
};
|
|
1395
|
+
interface ZaloAdsConversionItemDto {
|
|
1396
|
+
conversionId: number;
|
|
1397
|
+
name: string;
|
|
1398
|
+
labelId: number;
|
|
1399
|
+
urlType?: number;
|
|
1400
|
+
landingPage?: string;
|
|
1401
|
+
status?: number;
|
|
1402
|
+
created?: number;
|
|
1403
|
+
memberId?: number;
|
|
1404
|
+
}
|
|
1315
1405
|
type ZaloAdsCreateConversionResponse = {
|
|
1316
|
-
code
|
|
1406
|
+
code: number;
|
|
1317
1407
|
msg?: string;
|
|
1318
|
-
data?:
|
|
1319
|
-
[key: string]: unknown;
|
|
1408
|
+
data?: ZaloAdsConversionItemDto | number;
|
|
1320
1409
|
};
|
|
1321
1410
|
/** 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
1411
|
type ZaloAdsDeleteConversionRequest = {
|
|
@@ -1327,8 +1416,7 @@ type ZaloAdsDeleteConversionResponse = {
|
|
|
1327
1416
|
/** Thông báo trạng thái từ Zalo Ads. */
|
|
1328
1417
|
msg: string;
|
|
1329
1418
|
/** Mã thành công đã capture: 0. */
|
|
1330
|
-
code: 0;
|
|
1331
|
-
[key: string]: unknown;
|
|
1419
|
+
code: 0 | number;
|
|
1332
1420
|
};
|
|
1333
1421
|
/** 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
1422
|
type ZaloAdsDeleteCustomAudienceRequest = {
|
|
@@ -1345,10 +1433,29 @@ type ZaloAdsDeleteCustomAudienceResponse = {
|
|
|
1345
1433
|
type ZaloAdsGetAdByIdRequest = {
|
|
1346
1434
|
/** ID mẫu quảng cáo cần lấy chi tiết (query param `adId`). */
|
|
1347
1435
|
adId?: number | string;
|
|
1348
|
-
[key: string]: unknown;
|
|
1349
1436
|
};
|
|
1350
1437
|
type ZaloAdsGetAdByIdResponse = {
|
|
1351
|
-
|
|
1438
|
+
code?: number;
|
|
1439
|
+
msg?: string;
|
|
1440
|
+
data?: ZaloAdsAdUpdatePayloadDto;
|
|
1441
|
+
AdId?: number;
|
|
1442
|
+
CampaignId?: number;
|
|
1443
|
+
MemberId?: number;
|
|
1444
|
+
RowVersion?: number;
|
|
1445
|
+
AdName?: string;
|
|
1446
|
+
Type?: number;
|
|
1447
|
+
Settings?: ZaloAdsAdSettingsDto;
|
|
1448
|
+
Status?: number;
|
|
1449
|
+
StartDate?: number;
|
|
1450
|
+
EndDate?: number;
|
|
1451
|
+
ZaloFlowId?: number;
|
|
1452
|
+
ZaloPageId?: number;
|
|
1453
|
+
ZaloFormId?: string;
|
|
1454
|
+
ZaloFeedId?: string | number;
|
|
1455
|
+
MiniPageId?: number;
|
|
1456
|
+
UseConversion?: 0 | 1;
|
|
1457
|
+
ConversionId?: number;
|
|
1458
|
+
Report?: Record<string, number>;
|
|
1352
1459
|
};
|
|
1353
1460
|
/** 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
1461
|
type ZaloAdsGetAdChangeLogRequest = {
|
|
@@ -1394,25 +1501,96 @@ type ZaloAdsGetApiAdGetlistadadvancetargetingResponse = {
|
|
|
1394
1501
|
displayName: string;
|
|
1395
1502
|
}>;
|
|
1396
1503
|
};
|
|
1397
|
-
|
|
1398
|
-
|
|
1504
|
+
interface ZaloAdsAccessorItemDto {
|
|
1505
|
+
/** ID định danh của thành viên trên Zalo Ads (ví dụ: 257887336). */
|
|
1506
|
+
memberId: number;
|
|
1507
|
+
/** Tên hiển thị của thành viên. */
|
|
1508
|
+
memberName: string;
|
|
1509
|
+
/** Số điện thoại của thành viên (định dạng 84...). */
|
|
1510
|
+
memberPhone?: string;
|
|
1511
|
+
/** URL ảnh đại diện của thành viên. */
|
|
1512
|
+
memberAvatar?: string;
|
|
1513
|
+
/** Cấp độ quyền truy cập (0 = Chủ tài khoản gốc). */
|
|
1514
|
+
accessLevel: number;
|
|
1515
|
+
}
|
|
1516
|
+
interface ZaloAdsAccountAgencyInfoDto {
|
|
1517
|
+
/** Mã định danh của Agency (ví dụ: 277596648). */
|
|
1518
|
+
agencyId: number;
|
|
1519
|
+
/** ID tài khoản chủ sở hữu Agency (ví dụ: 257887336). */
|
|
1520
|
+
ownerId: number;
|
|
1521
|
+
/** Tên pháp nhân hoặc tên hiển thị của Agency. */
|
|
1522
|
+
agencyName: string;
|
|
1523
|
+
/** Thời điểm khởi tạo Agency, định dạng Unix timestamp tính bằng giây. */
|
|
1524
|
+
created?: number;
|
|
1525
|
+
/** Cấp độ quyền của tài khoản hiện tại trong Agency (ví dụ: 9 = Chủ sở hữu Agency). */
|
|
1526
|
+
accessLevel: number;
|
|
1527
|
+
}
|
|
1528
|
+
/** 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. */
|
|
1529
|
+
type ZaloAdsGetApiBaAccountAllaccessorsRequest = {
|
|
1530
|
+
/** 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. */
|
|
1531
|
+
isShowAll?: 0 | 1 | number;
|
|
1532
|
+
};
|
|
1399
1533
|
type ZaloAdsGetApiBaAccountAllaccessorsResponse = {
|
|
1400
|
-
|
|
1534
|
+
/** Mã kết quả (0 = Thành công). */
|
|
1535
|
+
code: number;
|
|
1536
|
+
/** Thông điệp trạng thái (ví dụ: 'success'). */
|
|
1537
|
+
msg?: string;
|
|
1538
|
+
data: {
|
|
1539
|
+
/** 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). */
|
|
1540
|
+
personalAccessors: Array<ZaloAdsAccessorItemDto>;
|
|
1541
|
+
/** Thông tin Agency liên kết (nếu có). */
|
|
1542
|
+
agencyInfo?: ZaloAdsAccountAgencyInfoDto;
|
|
1543
|
+
/** 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ó). */
|
|
1544
|
+
agencyAccessors?: Array<ZaloAdsAccessorItemDto>;
|
|
1545
|
+
};
|
|
1401
1546
|
};
|
|
1402
|
-
|
|
1547
|
+
interface ZaloAdsGrantedMemberItemDto {
|
|
1548
|
+
/** ID định danh của thành viên trên Zalo Ads (ví dụ: 330114198). */
|
|
1549
|
+
memberId: number;
|
|
1550
|
+
/** Tên hiển thị của thành viên. */
|
|
1551
|
+
memberName: string;
|
|
1552
|
+
/** Số điện thoại liên hệ của thành viên (định dạng 84...). */
|
|
1553
|
+
memberPhone?: string;
|
|
1554
|
+
/** URL ảnh đại diện của thành viên. */
|
|
1555
|
+
memberAvatar?: string;
|
|
1556
|
+
/** 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). */
|
|
1557
|
+
accessLevel: number;
|
|
1558
|
+
}
|
|
1559
|
+
/** 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
1560
|
type ZaloAdsGetApiBaAccountAllgrantedmembersRequest = Record<string, never>;
|
|
1404
1561
|
type ZaloAdsGetApiBaAccountAllgrantedmembersResponse = {
|
|
1405
|
-
|
|
1562
|
+
/** Mã kết quả (0 = Thành công). */
|
|
1563
|
+
code: number;
|
|
1564
|
+
/** Thông điệp trạng thái (ví dụ: 'success'). */
|
|
1565
|
+
msg?: string;
|
|
1566
|
+
data: {
|
|
1567
|
+
/** Danh sách thành viên được cấp quyền truy cập ở cấp tài khoản cá nhân. */
|
|
1568
|
+
personalGrantedAccessMembers: Array<ZaloAdsGrantedMemberItemDto>;
|
|
1569
|
+
/** 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). */
|
|
1570
|
+
agencyInfo?: ZaloAdsAccountAgencyInfoDto;
|
|
1571
|
+
/** Danh sách nhân sự/thành viên thuộc Agency được cấp quyền truy cập. */
|
|
1572
|
+
agencyGrantedAccessMembers: Array<ZaloAdsGrantedMemberItemDto>;
|
|
1573
|
+
};
|
|
1406
1574
|
};
|
|
1407
1575
|
/** 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
1576
|
type ZaloAdsGetApiConversionAllRequest = Record<string, never>;
|
|
1409
1577
|
type ZaloAdsGetApiConversionAllResponse = {
|
|
1410
|
-
|
|
1578
|
+
code: number;
|
|
1579
|
+
msg?: string;
|
|
1580
|
+
data: Array<ZaloAdsConversionItemDto>;
|
|
1411
1581
|
};
|
|
1582
|
+
interface ZaloAdsStandardEventItemDto {
|
|
1583
|
+
id: number;
|
|
1584
|
+
name: string;
|
|
1585
|
+
code?: string;
|
|
1586
|
+
description?: string;
|
|
1587
|
+
}
|
|
1412
1588
|
/** 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
1589
|
type ZaloAdsGetApiConversionStandardEventsRequest = Record<string, never>;
|
|
1414
1590
|
type ZaloAdsGetApiConversionStandardEventsResponse = {
|
|
1415
|
-
|
|
1591
|
+
code: number;
|
|
1592
|
+
msg?: string;
|
|
1593
|
+
data: Array<ZaloAdsStandardEventItemDto>;
|
|
1416
1594
|
};
|
|
1417
1595
|
/** 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
1596
|
type ZaloAdsGetApiCustomAudienceAllRequest = {
|
|
@@ -1448,15 +1626,57 @@ type ZaloAdsGetApiCustomAudienceAllResponse = {
|
|
|
1448
1626
|
CustomAudienceId: number;
|
|
1449
1627
|
}>;
|
|
1450
1628
|
};
|
|
1629
|
+
interface ZaloAdsFileGroupItemDto {
|
|
1630
|
+
id: number;
|
|
1631
|
+
name: string;
|
|
1632
|
+
memberId?: number;
|
|
1633
|
+
created?: number;
|
|
1634
|
+
totalFiles?: number;
|
|
1635
|
+
}
|
|
1451
1636
|
/** 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
1637
|
type ZaloAdsGetApiFilegroupsRequest = Record<string, never>;
|
|
1453
1638
|
type ZaloAdsGetApiFilegroupsResponse = {
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1639
|
+
code: number;
|
|
1640
|
+
msg?: string;
|
|
1641
|
+
data: Array<ZaloAdsFileGroupItemDto>;
|
|
1642
|
+
};
|
|
1643
|
+
interface ZaloAdsLpNewsButtonDto {
|
|
1644
|
+
/** Nhãn nút (ví dụ: 'Xem thêm', 'Xem ngay', 'Quảng cáo ngay'). */
|
|
1645
|
+
label: string;
|
|
1646
|
+
/** Đường dẫn URL đích khi nhấn nút. */
|
|
1647
|
+
linkUrl: string;
|
|
1648
|
+
/** Loại điều hướng (1 = Mở tab mới, 2 = Route nội bộ). */
|
|
1649
|
+
type: number;
|
|
1650
|
+
/** Cờ bật/tắt hiển thị nút (dùng cho secondaryButton). */
|
|
1651
|
+
isDisplayed?: boolean;
|
|
1652
|
+
}
|
|
1653
|
+
interface ZaloAdsLpNewsItemDto {
|
|
1654
|
+
/** Tiêu đề tin tức/sự kiện. */
|
|
1655
|
+
title: string;
|
|
1656
|
+
/** Mô tả ngắn của tin tức/sự kiện. */
|
|
1657
|
+
description: string;
|
|
1658
|
+
/** URL hình ảnh banner của tin tức. */
|
|
1659
|
+
imageUrl: string;
|
|
1660
|
+
/** Cờ cho biết tin tức có hiển thị trên trang Tổng quan (Dashboard) hay không. */
|
|
1661
|
+
displayOnHomePage?: boolean;
|
|
1662
|
+
/** Cờ cho biết tin tức có hiển thị trên trang chủ Landing Page hay không. */
|
|
1663
|
+
displayOnLandingPage?: boolean;
|
|
1664
|
+
/** Cấu hình nút hành động chính trên Dashboard. */
|
|
1665
|
+
primaryButton?: ZaloAdsLpNewsButtonDto;
|
|
1666
|
+
/** Cấu hình nút hành động phụ trên Dashboard. */
|
|
1667
|
+
secondaryButton?: ZaloAdsLpNewsButtonDto;
|
|
1668
|
+
/** Cấu hình nút hành động hiển thị trên popup Landing Page. */
|
|
1669
|
+
landingPageButton?: ZaloAdsLpNewsButtonDto;
|
|
1670
|
+
}
|
|
1671
|
+
/** 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
1672
|
type ZaloAdsGetApiLpNewsRequest = Record<string, never>;
|
|
1458
1673
|
type ZaloAdsGetApiLpNewsResponse = {
|
|
1459
|
-
|
|
1674
|
+
/** 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). */
|
|
1675
|
+
code: number;
|
|
1676
|
+
/** Thông báo trạng thái (ví dụ: 'Landing page new is empty' khi code = 1). */
|
|
1677
|
+
msg?: string;
|
|
1678
|
+
/** 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). */
|
|
1679
|
+
data?: ZaloAdsLpNewsItemDto;
|
|
1460
1680
|
};
|
|
1461
1681
|
/** 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
1682
|
type ZaloAdsGetApiMediaItemsRequest = {
|
|
@@ -1484,32 +1704,82 @@ type ZaloAdsGetApiMediaItemsResponse = {
|
|
|
1484
1704
|
CreatedBy: number;
|
|
1485
1705
|
}>;
|
|
1486
1706
|
};
|
|
1707
|
+
interface ZaloAdsMemberFileItemDto {
|
|
1708
|
+
id: number;
|
|
1709
|
+
name: string;
|
|
1710
|
+
fileUrl: string;
|
|
1711
|
+
status?: number;
|
|
1712
|
+
lineNumber?: number;
|
|
1713
|
+
created?: number;
|
|
1714
|
+
memberId?: number;
|
|
1715
|
+
}
|
|
1487
1716
|
/** 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
1717
|
type ZaloAdsGetApiMemberFilesRequest = Record<string, never>;
|
|
1489
1718
|
type ZaloAdsGetApiMemberFilesResponse = {
|
|
1490
|
-
|
|
1719
|
+
code: number;
|
|
1720
|
+
msg?: string;
|
|
1721
|
+
data: Array<ZaloAdsMemberFileItemDto>;
|
|
1491
1722
|
};
|
|
1492
|
-
|
|
1723
|
+
interface ZaloAdsNotifyHeaderItemDto {
|
|
1724
|
+
/** ID định danh của thông báo (ví dụ: 1). */
|
|
1725
|
+
id: number;
|
|
1726
|
+
/** Nội dung chi tiết của thông báo hiển thị trên đầu trang. */
|
|
1727
|
+
text: string;
|
|
1728
|
+
}
|
|
1729
|
+
/** 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
1730
|
type ZaloAdsGetApiNotifiesHeaderRequest = Record<string, never>;
|
|
1494
1731
|
type ZaloAdsGetApiNotifiesHeaderResponse = {
|
|
1495
|
-
|
|
1732
|
+
/** Mã kết quả (0 = Thành công). */
|
|
1733
|
+
code: number;
|
|
1734
|
+
/** Thông điệp trạng thái (ví dụ: 'success'). */
|
|
1735
|
+
msg?: string;
|
|
1736
|
+
/** Danh sách các thông báo hiển thị ở đầu trang (header banner). */
|
|
1737
|
+
announcements: Array<ZaloAdsNotifyHeaderItemDto>;
|
|
1496
1738
|
};
|
|
1497
|
-
/** Lấy lịch sử
|
|
1739
|
+
/** 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
1740
|
type ZaloAdsGetApiPaymentTransactionHistoryRequest = {
|
|
1499
|
-
/** Mốc kết thúc khoảng
|
|
1741
|
+
/** 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
1742
|
to: number;
|
|
1501
|
-
/** Mốc bắt đầu khoảng
|
|
1743
|
+
/** 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
1744
|
from: number;
|
|
1503
|
-
/** ID thành viên cần
|
|
1745
|
+
/** 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
1746
|
memberId: number;
|
|
1505
1747
|
};
|
|
1748
|
+
interface ZaloAdsPaymentTransactionItemDto {
|
|
1749
|
+
/** Số tiền nạp (VNĐ), ví dụ: 1000000. */
|
|
1750
|
+
amount: number;
|
|
1751
|
+
/** 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'). */
|
|
1752
|
+
bankName: string;
|
|
1753
|
+
/** Kênh nạp tiền (ví dụ: 'Chuyển khoản', 'ZaloPay', 'Thẻ ATM', 'Voucher'). */
|
|
1754
|
+
channel: string;
|
|
1755
|
+
/** Nội dung/ghi chú giao dịch nạp tiền. */
|
|
1756
|
+
content: string;
|
|
1757
|
+
/** 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. */
|
|
1758
|
+
date: number;
|
|
1759
|
+
/** ID người hoặc hệ thống thực hiện nạp tiền (ví dụ: 257887336). */
|
|
1760
|
+
createdId: number;
|
|
1761
|
+
/** Tên người hoặc hệ thống thực hiện nạp tiền (ví dụ: 'Zalo Ads'). */
|
|
1762
|
+
createdName: string;
|
|
1763
|
+
/** Tên phụ của đơn vị/người nạp hộ (nếu có). */
|
|
1764
|
+
secondaryName?: string;
|
|
1765
|
+
/** ID tài khoản quảng cáo thụ hưởng số tiền nạp. */
|
|
1766
|
+
memberId: number;
|
|
1767
|
+
/** Cờ đánh dấu giao dịch có xuất hóa đơn (true = Có, false = Không). */
|
|
1768
|
+
receipt: boolean;
|
|
1769
|
+
/** Trạng thái giao dịch nạp tiền (ví dụ: 'Thành công'). */
|
|
1770
|
+
status: string;
|
|
1771
|
+
}
|
|
1506
1772
|
type ZaloAdsGetApiPaymentTransactionHistoryResponse = {
|
|
1507
|
-
/** Mã
|
|
1773
|
+
/** 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
1774
|
code: number;
|
|
1509
|
-
/**
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1775
|
+
/** Thông báo trạng thái hoặc chi tiết lỗi từ hệ thống. */
|
|
1776
|
+
msg?: string;
|
|
1777
|
+
/** Danh sách các giao dịch nạp tiền trong khoảng thời gian đã chọn. */
|
|
1778
|
+
data: Array<ZaloAdsPaymentTransactionItemDto>;
|
|
1779
|
+
/** Thông tin bổ sung của tài khoản được tra cứu (khi xem theo memberId). */
|
|
1780
|
+
extend?: {
|
|
1781
|
+
name?: string;
|
|
1782
|
+
};
|
|
1513
1783
|
};
|
|
1514
1784
|
/** 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
1785
|
type ZaloAdsGetApiPlaceGetalldistrictsRequest = Record<string, never>;
|
|
@@ -1542,10 +1812,46 @@ type ZaloAdsGetApiPlaceGetalldistrictsResponse = {
|
|
|
1542
1812
|
};
|
|
1543
1813
|
};
|
|
1544
1814
|
};
|
|
1545
|
-
|
|
1546
|
-
|
|
1815
|
+
interface ZaloAdsSpellCheckIssueDto {
|
|
1816
|
+
/** 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). */
|
|
1817
|
+
code?: string;
|
|
1818
|
+
/** Nhãn mô tả loại lỗi hiển thị cho người dùng. */
|
|
1819
|
+
label?: string;
|
|
1820
|
+
/** Vị trí ký tự bắt đầu của cụm từ lỗi (0-indexed). */
|
|
1821
|
+
start: number;
|
|
1822
|
+
/** Vị trí ký tự kết thúc của cụm từ lỗi. */
|
|
1823
|
+
end: number;
|
|
1824
|
+
/** Cụm từ gốc bị phát hiện lỗi trong văn bản đầu vào. */
|
|
1825
|
+
originalText: string;
|
|
1826
|
+
/** Cụm từ gợi ý thay thế (chuỗi rỗng nếu gợi ý xóa bỏ). */
|
|
1827
|
+
text: string;
|
|
1828
|
+
/** Cờ đánh dấu gợi ý là xóa bỏ cụm từ lỗi (true khi text rỗng). */
|
|
1829
|
+
isRemoval?: boolean;
|
|
1830
|
+
/** Mã phân loại diff (mặc định: 0). */
|
|
1831
|
+
type?: number;
|
|
1832
|
+
}
|
|
1833
|
+
/** 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. */
|
|
1834
|
+
type ZaloAdsGetApiSpellCheckV2Request = {
|
|
1835
|
+
/** 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). */
|
|
1836
|
+
text: string;
|
|
1837
|
+
};
|
|
1547
1838
|
type ZaloAdsGetApiSpellCheckV2Response = {
|
|
1548
|
-
|
|
1839
|
+
/** Mã kết quả HTTP/API (0 = Thành công). */
|
|
1840
|
+
code: number;
|
|
1841
|
+
/** Thông báo trạng thái (nếu có). */
|
|
1842
|
+
msg?: string;
|
|
1843
|
+
data: {
|
|
1844
|
+
/** 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). */
|
|
1845
|
+
requestAiId: string;
|
|
1846
|
+
/** Văn bản đầu ra hoàn chỉnh sau khi AI gợi ý chỉnh sửa. */
|
|
1847
|
+
aiOutput: string;
|
|
1848
|
+
/** Thời gian xử lý của AI tính bằng mili giây (ms). */
|
|
1849
|
+
elapsedTime: number;
|
|
1850
|
+
/** Mã trạng thái dịch vụ AI (0 = SUCCESS, -1 = AI_SERVER_FAILURE, -2 = AI_REQUEST_TIMEOUT). */
|
|
1851
|
+
error: number;
|
|
1852
|
+
/** 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. */
|
|
1853
|
+
diffs: Array<ZaloAdsSpellCheckIssueDto>;
|
|
1854
|
+
};
|
|
1549
1855
|
};
|
|
1550
1856
|
/** 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
1857
|
type ZaloAdsGetApiWhoamiRequest = Record<string, never>;
|
|
@@ -1591,6 +1897,21 @@ type ZaloAdsGetApiWhoamiResponse = {
|
|
|
1591
1897
|
usedSimplifiedVersion?: boolean;
|
|
1592
1898
|
canUseMiniPageMessageAd?: boolean;
|
|
1593
1899
|
canUseOptimizeUniversalPixel?: boolean;
|
|
1900
|
+
/** Cho phép dùng kiểm tra chính tả AI (/api/spell-check/v2). */
|
|
1901
|
+
canUseSpellCheck?: boolean;
|
|
1902
|
+
/** Cho phép dùng tính năng tạo nhiều ảnh bằng AI. */
|
|
1903
|
+
canUseMultiImageAi?: boolean;
|
|
1904
|
+
/** Cho phép dùng công cụ tạo video. */
|
|
1905
|
+
canUseVideoCreationTool?: boolean;
|
|
1906
|
+
};
|
|
1907
|
+
/** 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. */
|
|
1908
|
+
agencyInfo?: {
|
|
1909
|
+
/** ID Agency. */
|
|
1910
|
+
agencyId?: number;
|
|
1911
|
+
/** Tên Agency. */
|
|
1912
|
+
agencyName?: string;
|
|
1913
|
+
/** Cấp quyền của tài khoản trong Agency (quan sát được: 7, 9). */
|
|
1914
|
+
level?: number;
|
|
1594
1915
|
};
|
|
1595
1916
|
/** Tài khoản gốc liên quan; chứa dữ liệu cá nhân. */
|
|
1596
1917
|
rootMember?: {
|
|
@@ -1623,75 +1944,66 @@ type ZaloAdsGetReportapiV2AdsRequest = {
|
|
|
1623
1944
|
/** Bắt đầu khoảng báo cáo, Unix epoch giây. */
|
|
1624
1945
|
startDate: number;
|
|
1625
1946
|
};
|
|
1947
|
+
interface ZaloAdsAdReportItemDto {
|
|
1948
|
+
/** ID quảng cáo; dùng làm adId cho thao tác chi tiết/cập nhật. */
|
|
1949
|
+
id: number;
|
|
1950
|
+
name: string;
|
|
1951
|
+
/** Mã loại quảng cáo upstream; đã quan sát 28. */
|
|
1952
|
+
adType: number;
|
|
1953
|
+
/** Mã trạng thái. Khi lọc dùng Value chuỗi, ví dụ "3" hoặc "4", trong filter. */
|
|
1954
|
+
status: number;
|
|
1955
|
+
/** Unix epoch giây. */
|
|
1956
|
+
endDate: number;
|
|
1957
|
+
/** URL ảnh bìa. */
|
|
1958
|
+
coverUrl?: string;
|
|
1959
|
+
memberId: number;
|
|
1960
|
+
/** Unix epoch giây. */
|
|
1961
|
+
modified?: number;
|
|
1962
|
+
/** Mã read-only upstream; đã quan sát -1, không phải boolean. */
|
|
1963
|
+
readOnly?: number;
|
|
1964
|
+
viewType?: number;
|
|
1965
|
+
createdBy?: number;
|
|
1966
|
+
/** Unix epoch giây. */
|
|
1967
|
+
startDate: number;
|
|
1968
|
+
/** ID chiến dịch chứa quảng cáo. */
|
|
1969
|
+
campaignId: number;
|
|
1970
|
+
memberName?: string;
|
|
1971
|
+
/** Mã loại giá thầu upstream. */
|
|
1972
|
+
adPriceType?: number;
|
|
1973
|
+
/** Metric động; key là mã chỉ số Zalo Ads. */
|
|
1974
|
+
reportTotal: Record<string, number>;
|
|
1975
|
+
campaignName: string;
|
|
1976
|
+
campaignType?: number;
|
|
1977
|
+
conversionId?: number;
|
|
1978
|
+
reportByDate?: Record<string, Record<string, number>>;
|
|
1979
|
+
reportBySubId?: Record<string, Record<string, number>>;
|
|
1980
|
+
adtimaBookingId?: number;
|
|
1981
|
+
reportTotalByTemplate?: Record<string, Record<string, number>>;
|
|
1982
|
+
reportBySubIdThenByDate?: Record<string, Record<string, Record<string, number>>>;
|
|
1983
|
+
reportByTemplateThenByDate?: Record<string, Record<string, Record<string, number>>>;
|
|
1984
|
+
}
|
|
1626
1985
|
type ZaloAdsGetReportapiV2AdsResponse = {
|
|
1627
1986
|
msg: string;
|
|
1628
1987
|
/** 0 là thành công. */
|
|
1629
1988
|
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
|
-
}>;
|
|
1989
|
+
data: Array<ZaloAdsAdReportItemDto>;
|
|
1694
1990
|
};
|
|
1991
|
+
interface ZaloAdsCampaignReportItemDto {
|
|
1992
|
+
id: number;
|
|
1993
|
+
name: string;
|
|
1994
|
+
status: number;
|
|
1995
|
+
endDate: number;
|
|
1996
|
+
memberId: number;
|
|
1997
|
+
readOnly: number;
|
|
1998
|
+
viewType: number;
|
|
1999
|
+
startDate: number;
|
|
2000
|
+
memberName?: string;
|
|
2001
|
+
/** Metric động; key là mã chỉ số Zalo Ads. */
|
|
2002
|
+
reportTotal: Record<string, number>;
|
|
2003
|
+
campaignType: number;
|
|
2004
|
+
adtimaCampaignId: number;
|
|
2005
|
+
reportByDate?: Record<string, Record<string, number>>;
|
|
2006
|
+
}
|
|
1695
2007
|
/** 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
2008
|
type ZaloAdsGetReportapiV2CampaignsRequest = {
|
|
1697
2009
|
/** ID chiến dịch cần xem báo cáo. */
|
|
@@ -1702,15 +2014,24 @@ type ZaloAdsGetReportapiV2CampaignsRequest = {
|
|
|
1702
2014
|
endDate?: number;
|
|
1703
2015
|
/** Mốc làm mới truy vấn, Unix timestamp mili giây. */
|
|
1704
2016
|
refresh?: number | string;
|
|
1705
|
-
[key: string]: unknown;
|
|
1706
2017
|
};
|
|
1707
2018
|
type ZaloAdsGetReportapiV2CampaignsResponse = {
|
|
1708
|
-
|
|
2019
|
+
code: number;
|
|
2020
|
+
msg?: string;
|
|
2021
|
+
data: Array<ZaloAdsCampaignReportItemDto>;
|
|
1709
2022
|
};
|
|
2023
|
+
interface ZaloAdsUniqueUserReportDataDto {
|
|
2024
|
+
totalUniqueUsers: number;
|
|
2025
|
+
totalReach?: number;
|
|
2026
|
+
frequency?: number;
|
|
2027
|
+
byDate?: Record<string, number>;
|
|
2028
|
+
}
|
|
1710
2029
|
/** 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. Đây là entry tool thuộc lane zalo-ads-reporting; dùng khi đánh giá độ phủ thay vì tổng số lượt hiển thị. */
|
|
1711
2030
|
type ZaloAdsGetReportapiV2UniqueUserRequest = Record<string, never>;
|
|
1712
2031
|
type ZaloAdsGetReportapiV2UniqueUserResponse = {
|
|
1713
|
-
|
|
2032
|
+
code: number;
|
|
2033
|
+
msg?: string;
|
|
2034
|
+
data: ZaloAdsUniqueUserReportDataDto;
|
|
1714
2035
|
};
|
|
1715
2036
|
/** 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
2037
|
type ZaloAdsGetReportapiV3CampaignsRequest = {
|
|
@@ -1730,130 +2051,169 @@ type ZaloAdsGetReportapiV3CampaignsRequest = {
|
|
|
1730
2051
|
type ZaloAdsGetReportapiV3CampaignsResponse = {
|
|
1731
2052
|
msg: string;
|
|
1732
2053
|
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
|
-
}>;
|
|
2054
|
+
data: Array<ZaloAdsCampaignReportItemDto>;
|
|
1750
2055
|
};
|
|
1751
2056
|
/** Lấy báo cáo hiệu quả của campaign theo dữ liệu vận hành Zalo Ads. Đây là detail tool thuộc lane zalo-ads-reporting; dùng khi cần kiểm tra chỉ số và trạng thái của một chiến dịch. */
|
|
1752
2057
|
type ZaloAdsGetZaapiCampaignReportcampaignRequest = {
|
|
1753
2058
|
campaignId?: number | string;
|
|
1754
2059
|
campId?: number | string;
|
|
1755
|
-
[key: string]: unknown;
|
|
1756
2060
|
};
|
|
1757
2061
|
type ZaloAdsGetZaapiCampaignReportcampaignResponse = {
|
|
1758
|
-
|
|
2062
|
+
code: number;
|
|
2063
|
+
msg?: string;
|
|
2064
|
+
data?: ZaloAdsCampaignReportItemDto;
|
|
1759
2065
|
};
|
|
1760
2066
|
/** 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
2067
|
type ZaloAdsGetZaapiCheckcamphasmanyadsRequest = {
|
|
1762
2068
|
campaignId?: number | string;
|
|
1763
2069
|
campId?: number | string;
|
|
1764
|
-
[key: string]: unknown;
|
|
1765
2070
|
};
|
|
1766
2071
|
type ZaloAdsGetZaapiCheckcamphasmanyadsResponse = {
|
|
1767
|
-
|
|
2072
|
+
code: number;
|
|
2073
|
+
msg?: string;
|
|
2074
|
+
data: boolean | number;
|
|
1768
2075
|
};
|
|
1769
2076
|
/** 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
2077
|
type ZaloAdsGetZaapiGetadsfromcampaignidRequest = {
|
|
1771
2078
|
campaignId?: number | string;
|
|
1772
2079
|
campId?: number | string;
|
|
1773
|
-
[key: string]: unknown;
|
|
1774
2080
|
};
|
|
1775
2081
|
type ZaloAdsGetZaapiGetadsfromcampaignidResponse = {
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
2082
|
+
code: number;
|
|
2083
|
+
msg?: string;
|
|
2084
|
+
data: Array<ZaloAdsAdUpdatePayloadDto>;
|
|
2085
|
+
};
|
|
2086
|
+
interface ZaloAdsPageConfigDto {
|
|
2087
|
+
/** Hạng tài khoản OA (ví dụ: 0 = Phổ thông, 1 = Xác thực/Nâng cao). */
|
|
2088
|
+
tier?: number;
|
|
2089
|
+
viewStatus?: number;
|
|
2090
|
+
isVerified?: boolean;
|
|
2091
|
+
allowMessage?: boolean;
|
|
2092
|
+
}
|
|
2093
|
+
/** Một địa điểm trong `extraInfo.locations` của OA (quan sát trên 67 địa điểm của 64 OA). */
|
|
2094
|
+
interface ZaloAdsOwnedPageLocationDto {
|
|
2095
|
+
/** Địa chỉ đầy đủ. */
|
|
2096
|
+
address: string;
|
|
2097
|
+
/** Mã tỉnh/thành. */
|
|
2098
|
+
provinceId: number;
|
|
2099
|
+
/** Mã quận/huyện; chỉ có ở 64/67 địa điểm quan sát được. */
|
|
2100
|
+
districtId?: number;
|
|
2101
|
+
/** Vĩ độ. */
|
|
2102
|
+
lat: number;
|
|
2103
|
+
/** Kinh độ. */
|
|
2104
|
+
lng: number;
|
|
2105
|
+
}
|
|
2106
|
+
/** 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. */
|
|
2107
|
+
interface ZaloAdsOwnedPageExtraInfoDto {
|
|
2108
|
+
website: string | null;
|
|
2109
|
+
contactName: string;
|
|
2110
|
+
hotline: string | null;
|
|
2111
|
+
workingTime: string | null;
|
|
2112
|
+
/** Số điện thoại liên hệ dạng quốc tế, ví dụ "84384473007". */
|
|
2113
|
+
contactPhone: string;
|
|
2114
|
+
locations: Array<ZaloAdsOwnedPageLocationDto>;
|
|
2115
|
+
}
|
|
2116
|
+
interface ZaloAdsOwnedPageItemDto {
|
|
2117
|
+
/** ID nội bộ page/OA (trùng với pageId, ví dụ: 429753475). */
|
|
2118
|
+
id: number;
|
|
2119
|
+
/** Tên danh mục ngành nghề, khi có. */
|
|
2120
|
+
cate?: string;
|
|
2121
|
+
/** Tên page/OA. */
|
|
2122
|
+
name: string;
|
|
2123
|
+
/** Loại page/OA (ví dụ: 2 = Doanh nghiệp/Cửa hàng). */
|
|
2124
|
+
type: number;
|
|
2125
|
+
/** Cờ store (0 hoặc 1). */
|
|
2126
|
+
store?: number;
|
|
2127
|
+
/** Cấu hình phân hạng page/OA thay đổi theo loại. */
|
|
2128
|
+
config?: ZaloAdsPageConfigDto;
|
|
2129
|
+
/** 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). */
|
|
2130
|
+
pageId: number;
|
|
2131
|
+
/** Trạng thái hoạt động page/OA (ví dụ: 1 = Đang hoạt động). */
|
|
2132
|
+
status: number;
|
|
2133
|
+
/** Các ID danh mục ngành nghề (ví dụ: [10018]). */
|
|
2134
|
+
cateIds?: Array<number>;
|
|
2135
|
+
/** ID chủ sở hữu, chỉ xử lý trong phạm vi được ủy quyền. */
|
|
2136
|
+
ownerId?: number;
|
|
2137
|
+
configAd?: {
|
|
2138
|
+
/** Trạng thái hiển thị quảng cáo (ví dụ: 1 = Cho phép). */
|
|
2139
|
+
viewStatus?: number;
|
|
2140
|
+
};
|
|
2141
|
+
/** URL ảnh bìa, khi có. */
|
|
2142
|
+
coverUrl?: string;
|
|
2143
|
+
/** Mã định danh OA làm nhiễu dạng chuỗi số dài (trùng với pageIdNoised). */
|
|
2144
|
+
noisedId?: string;
|
|
2145
|
+
/** Tên hiển thị page/OA. */
|
|
2146
|
+
pageName: string;
|
|
2147
|
+
/** URL ảnh đại diện, khi có. */
|
|
2148
|
+
avatarUrl?: string;
|
|
2149
|
+
/** Cho biết OA đã chứng thực tích vàng (true) hay chưa (false). */
|
|
2150
|
+
certified?: boolean;
|
|
2151
|
+
/** 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ó. */
|
|
2152
|
+
extraInfo?: string;
|
|
2153
|
+
/** Trạng thái vận hành page/OA (ví dụ: 1 = Hoạt động bình thường). */
|
|
2154
|
+
pageStatus: number;
|
|
2155
|
+
/** Thời điểm tạo dạng Unix timestamp mili giây. */
|
|
2156
|
+
createdTime?: number;
|
|
2157
|
+
/** Mô tả page/OA, khi có. */
|
|
2158
|
+
description?: string;
|
|
2159
|
+
/** Thời điểm cập nhật dạng Unix timestamp mili giây. */
|
|
2160
|
+
updatedTime?: number;
|
|
2161
|
+
/** 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. */
|
|
2162
|
+
pageIdNoised?: string;
|
|
2163
|
+
}
|
|
2164
|
+
/** 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
2165
|
type ZaloAdsGetZaapiGetallpagesRequest = Record<string, never>;
|
|
1780
2166
|
type ZaloAdsGetZaapiGetallpagesResponse = {
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
2167
|
+
code: number;
|
|
2168
|
+
msg?: string;
|
|
2169
|
+
data: Array<ZaloAdsOwnedPageItemDto>;
|
|
2170
|
+
};
|
|
2171
|
+
interface ZaloAdsOwnedArticleItemDto {
|
|
2172
|
+
/** 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. */
|
|
2173
|
+
articleId: number;
|
|
2174
|
+
/** ID nội bộ của trang Zalo Official Account sở hữu bài viết (ví dụ: 429753475). */
|
|
2175
|
+
pageId: number;
|
|
2176
|
+
/** Tiêu đề của bài viết. */
|
|
2177
|
+
title: string;
|
|
2178
|
+
/** Đoạn mô tả tóm tắt (sapo) của bài viết. */
|
|
2179
|
+
description?: string;
|
|
2180
|
+
/** Đườ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=...'). */
|
|
2181
|
+
viewUrl: string;
|
|
2182
|
+
/** URL ảnh đại diện thu nhỏ (thumbnail) của bài viết. */
|
|
2183
|
+
thumbnail?: string;
|
|
2184
|
+
/** Tổng số lượt xem bài viết. */
|
|
2185
|
+
numViews?: number;
|
|
2186
|
+
/** Tổng số lượt chia sẻ bài viết. */
|
|
2187
|
+
numShares?: number;
|
|
2188
|
+
/** Cờ đánh dấu bài viết định dạng video (true) hay bài viết thông thường (false). */
|
|
2189
|
+
isVideoArticle: boolean;
|
|
2190
|
+
}
|
|
2191
|
+
/** 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
2192
|
type ZaloAdsGetZaapiGetownedarticlesRequest = {
|
|
1785
|
-
pageId
|
|
1786
|
-
|
|
1787
|
-
[key: string]: unknown;
|
|
2193
|
+
/** 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. */
|
|
2194
|
+
pageId: number | string;
|
|
1788
2195
|
};
|
|
1789
2196
|
type ZaloAdsGetZaapiGetownedarticlesResponse = {
|
|
1790
|
-
|
|
2197
|
+
code: number;
|
|
2198
|
+
msg?: string;
|
|
2199
|
+
data: Array<ZaloAdsOwnedArticleItemDto>;
|
|
1791
2200
|
};
|
|
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. */
|
|
2201
|
+
/** 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
2202
|
type ZaloAdsGetZaapiGetownedpagesRequest = Record<string, never>;
|
|
1794
2203
|
type ZaloAdsGetZaapiGetownedpagesResponse = {
|
|
1795
2204
|
/** Mã kết quả; 0 biểu thị thành công trong phản hồi đã quan sát. */
|
|
1796
2205
|
code: number;
|
|
1797
2206
|
/** 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
|
-
}>;
|
|
2207
|
+
data: Array<ZaloAdsOwnedPageItemDto>;
|
|
1848
2208
|
};
|
|
1849
2209
|
/** 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
2210
|
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
|
|
2211
|
+
/** Số khách hàng tối đa mỗi lần lấy (mặc định: 15). */
|
|
2212
|
+
limit?: number;
|
|
2213
|
+
/** Vị trí bắt đầu để phân trang, gốc 0 (mặc định: 0). */
|
|
2214
|
+
offset?: number;
|
|
2215
|
+
/** Sắp xếp ngày tham gia tăng dần khi là true (mặc định: true). */
|
|
2216
|
+
joinDateAsc?: boolean;
|
|
1857
2217
|
};
|
|
1858
2218
|
type ZaloAdsListAgencyCustomersWithBudgetResponse = {
|
|
1859
2219
|
/** Thông điệp kết quả. */
|
|
@@ -1968,9 +2328,7 @@ type ZaloAdsListFormsByOfficialAccountResponse = {
|
|
|
1968
2328
|
/** Trạng thái mở rộng section. */
|
|
1969
2329
|
expand: boolean;
|
|
1970
2330
|
/** Nội dung section thay đổi theo type, ví dụ images, videos hoặc table. */
|
|
1971
|
-
content:
|
|
1972
|
-
[key: string]: unknown;
|
|
1973
|
-
};
|
|
2331
|
+
content: ZaloAdsFormSectionContentDto;
|
|
1974
2332
|
/** Cho biết section bị vô hiệu hóa hay không. */
|
|
1975
2333
|
disable: boolean;
|
|
1976
2334
|
}>;
|
|
@@ -2004,7 +2362,9 @@ type ZaloAdsListFormsByOfficialAccountResponse = {
|
|
|
2004
2362
|
updatedAt?: number;
|
|
2005
2363
|
/** Các điều kiện bổ sung, khi có. */
|
|
2006
2364
|
conditions?: Array<{
|
|
2007
|
-
|
|
2365
|
+
field?: string;
|
|
2366
|
+
operator?: string;
|
|
2367
|
+
value?: string | number;
|
|
2008
2368
|
}>;
|
|
2009
2369
|
/** URL ảnh bìa, khi có. */
|
|
2010
2370
|
coverPhoto?: string;
|
|
@@ -2018,7 +2378,8 @@ type ZaloAdsListFormsByOfficialAccountResponse = {
|
|
|
2018
2378
|
gotoActionType?: number;
|
|
2019
2379
|
/** Nhóm câu hỏi, khi có. */
|
|
2020
2380
|
groupQuestions?: Array<{
|
|
2021
|
-
|
|
2381
|
+
groupIdx?: number;
|
|
2382
|
+
title?: string;
|
|
2022
2383
|
}>;
|
|
2023
2384
|
/** Cờ widget đồng ý OA. */
|
|
2024
2385
|
oaConsentWidget?: boolean;
|
|
@@ -2117,34 +2478,50 @@ type ZaloAdsPostApiAdEstimateaudienceResponse = {
|
|
|
2117
2478
|
};
|
|
2118
2479
|
};
|
|
2119
2480
|
};
|
|
2481
|
+
interface ZaloAdsMediaSaveSettingsDto {
|
|
2482
|
+
Url: string;
|
|
2483
|
+
Width: number;
|
|
2484
|
+
Height: number;
|
|
2485
|
+
Duration?: number;
|
|
2486
|
+
ThumbUrl?: string;
|
|
2487
|
+
}
|
|
2488
|
+
interface ZaloAdsMediaSavePayloadDto {
|
|
2489
|
+
Name: string;
|
|
2490
|
+
Type: number;
|
|
2491
|
+
Settings: ZaloAdsMediaSaveSettingsDto;
|
|
2492
|
+
}
|
|
2120
2493
|
/** 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
2494
|
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;
|
|
2495
|
+
/** 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. */
|
|
2496
|
+
data: ZaloAdsMediaSavePayloadDto | string;
|
|
2124
2497
|
};
|
|
2125
2498
|
type ZaloAdsPostApiMediaSaveResponse = {
|
|
2126
2499
|
code: number;
|
|
2127
2500
|
/** ID media vừa được lưu. */
|
|
2128
2501
|
data: number;
|
|
2129
2502
|
};
|
|
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.
|
|
2503
|
+
/** 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
2504
|
type ZaloAdsPostApiMemberUploadImageRequest = {
|
|
2132
|
-
/** Tệp ảnh cần tải lên
|
|
2133
|
-
|
|
2505
|
+
/** Tệp ảnh cần tải lên (URL HTTP/HTTPS, đường dẫn file local trong Node.js, hoặc Blob/Uint8Array). */
|
|
2506
|
+
File?: FileInput;
|
|
2507
|
+
/** Alias tương thích ngược cho `File` (service tự ánh xạ sang `File`). */
|
|
2508
|
+
file?: FileInput;
|
|
2134
2509
|
};
|
|
2135
2510
|
type ZaloAdsPostApiMemberUploadImageResponse = {
|
|
2136
2511
|
/** Mã kết quả; 0 biểu thị thành công trong phản hồi đã quan sát. */
|
|
2137
2512
|
code: number;
|
|
2138
2513
|
/** URL ảnh do Zalo Ads trả về. */
|
|
2139
2514
|
data: string;
|
|
2515
|
+
msg?: string;
|
|
2140
2516
|
};
|
|
2141
2517
|
/** 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
2518
|
type ZaloAdsPostZaapiDeleteadRequest = {
|
|
2143
2519
|
adId?: number | string;
|
|
2144
|
-
[key: string]: unknown;
|
|
2145
2520
|
};
|
|
2146
2521
|
type ZaloAdsPostZaapiDeleteadResponse = {
|
|
2147
|
-
|
|
2522
|
+
code: number;
|
|
2523
|
+
msg: string;
|
|
2524
|
+
data?: number | boolean;
|
|
2148
2525
|
};
|
|
2149
2526
|
/** Đổ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
2527
|
type ZaloAdsRenameCampaignRequest = {
|
|
@@ -2164,26 +2541,26 @@ type ZaloAdsUpdateEcommerceAdRequest = {
|
|
|
2164
2541
|
est?: string;
|
|
2165
2542
|
stt?: number | string;
|
|
2166
2543
|
/** Payload cập nhật quảng cáo E-commerce / Commerce (object hoặc chuỗi JSON). */
|
|
2167
|
-
data:
|
|
2544
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2168
2545
|
isBoostAd?: number | string;
|
|
2169
2546
|
};
|
|
2170
2547
|
type ZaloAdsUpdateEcommerceAdResponse = {
|
|
2171
2548
|
msg: string;
|
|
2172
2549
|
code: number;
|
|
2173
|
-
data?:
|
|
2550
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2174
2551
|
};
|
|
2175
2552
|
/** Cập nhật quảng cáo biểu mẫu (Form) đang có trên Zalo Ads (Type = 18). */
|
|
2176
2553
|
type ZaloAdsUpdateFormAdRequest = {
|
|
2177
2554
|
est?: string;
|
|
2178
2555
|
stt?: number | string;
|
|
2179
2556
|
/** Payload cập nhật quảng cáo biểu mẫu (object hoặc chuỗi JSON). */
|
|
2180
|
-
data:
|
|
2557
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2181
2558
|
isBoostAd?: number | string;
|
|
2182
2559
|
};
|
|
2183
2560
|
type ZaloAdsUpdateFormAdResponse = {
|
|
2184
2561
|
msg: string;
|
|
2185
2562
|
code: number;
|
|
2186
|
-
data?:
|
|
2563
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2187
2564
|
};
|
|
2188
2565
|
/** 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
2566
|
declare class ZaloAdsMessageAdUpdateDataDto {
|
|
@@ -2195,23 +2572,7 @@ declare class ZaloAdsMessageAdUpdateDataDto {
|
|
|
2195
2572
|
AdName: string;
|
|
2196
2573
|
/** 20 (hoặc 19) là quảng cáo Tin nhắn. */
|
|
2197
2574
|
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
|
-
};
|
|
2575
|
+
Settings: ZaloAdsAdSettingsDto;
|
|
2215
2576
|
Status: number;
|
|
2216
2577
|
StartDate: number;
|
|
2217
2578
|
EndDate: number;
|
|
@@ -2221,12 +2582,11 @@ declare class ZaloAdsMessageAdUpdateDataDto {
|
|
|
2221
2582
|
ZaloFormId?: string;
|
|
2222
2583
|
ConversionId?: number;
|
|
2223
2584
|
Report?: Record<string, number>;
|
|
2224
|
-
[key: string]: unknown;
|
|
2225
2585
|
}
|
|
2226
2586
|
/** Cập nhật quảng cáo Tin nhắn. Service tự JSON.stringify data rồi gửi form-urlencoded. */
|
|
2227
2587
|
declare class ZaloAdsUpdateMessageAdRequest {
|
|
2228
2588
|
/** 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 |
|
|
2589
|
+
data: ZaloAdsMessageAdUpdateDataDto | ZaloAdsAdUpdatePayloadDto | string;
|
|
2230
2590
|
/** Tham số UI phụ trợ; capture Zalo Ads có giá trị literal "undefined". */
|
|
2231
2591
|
est?: string;
|
|
2232
2592
|
/** 0 là quảng cáo thông thường, 1 là boost ad. */
|
|
@@ -2237,7 +2597,7 @@ declare class ZaloAdsUpdateMessageAdRequest {
|
|
|
2237
2597
|
declare class ZaloAdsUpdateMessageAdResponse {
|
|
2238
2598
|
msg: string;
|
|
2239
2599
|
code: number;
|
|
2240
|
-
data?:
|
|
2600
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2241
2601
|
}
|
|
2242
2602
|
/** 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
2603
|
type ZaloAdsUpdateNewAdsRequest = {
|
|
@@ -2255,41 +2615,40 @@ type ZaloAdsUpdateNewAdsRequest = {
|
|
|
2255
2615
|
scale: number;
|
|
2256
2616
|
};
|
|
2257
2617
|
type ZaloAdsUpdateNewAdsResponse = {
|
|
2258
|
-
code
|
|
2618
|
+
code: number;
|
|
2259
2619
|
msg?: string;
|
|
2260
|
-
data?:
|
|
2261
|
-
[key: string]: unknown;
|
|
2620
|
+
data?: string;
|
|
2262
2621
|
};
|
|
2263
2622
|
/** Cập nhật quảng cáo Zalo Official Account hiện có (Type = 2 hoặc 10). */
|
|
2264
2623
|
type ZaloAdsUpdateOfficialAccountAdRequest = {
|
|
2265
2624
|
est?: string;
|
|
2266
2625
|
stt?: number | string;
|
|
2267
2626
|
/** Payload cập nhật quảng cáo Official Account (object hoặc chuỗi JSON). */
|
|
2268
|
-
data:
|
|
2627
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2269
2628
|
isBoostAd?: number | string;
|
|
2270
2629
|
};
|
|
2271
2630
|
type ZaloAdsUpdateOfficialAccountAdResponse = {
|
|
2272
2631
|
msg: string;
|
|
2273
2632
|
code: number;
|
|
2274
|
-
data?:
|
|
2633
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2275
2634
|
};
|
|
2276
2635
|
/** 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
2636
|
type ZaloAdsUpdatePostAdRequest = {
|
|
2278
2637
|
est?: string;
|
|
2279
2638
|
stt?: number | string;
|
|
2280
2639
|
/** Payload cập nhật quảng cáo Bài viết (object hoặc chuỗi JSON). */
|
|
2281
|
-
data:
|
|
2640
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2282
2641
|
isBoostAd?: number | string;
|
|
2283
2642
|
};
|
|
2284
2643
|
type ZaloAdsUpdatePostAdResponse = {
|
|
2285
2644
|
msg: string;
|
|
2286
2645
|
code: number;
|
|
2287
|
-
data?:
|
|
2646
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2288
2647
|
};
|
|
2289
2648
|
/** Tạo chiến dịch quảng cáo Website trên Zalo Ads (campaignType = 1, Type = 9). */
|
|
2290
2649
|
type ZaloAdsCreateWebsiteCampaignRequest = {
|
|
2291
2650
|
/** 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:
|
|
2651
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
2293
2652
|
};
|
|
2294
2653
|
type ZaloAdsCreateWebsiteCampaignResponse = {
|
|
2295
2654
|
code: number;
|
|
@@ -2304,18 +2663,18 @@ type ZaloAdsUpdateWebsiteAdRequest = {
|
|
|
2304
2663
|
est?: string;
|
|
2305
2664
|
stt?: number | string;
|
|
2306
2665
|
/** Payload cập nhật quảng cáo Website (object hoặc chuỗi JSON). */
|
|
2307
|
-
data:
|
|
2666
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2308
2667
|
isBoostAd?: number | string;
|
|
2309
2668
|
};
|
|
2310
2669
|
type ZaloAdsUpdateWebsiteAdResponse = {
|
|
2311
2670
|
code: number;
|
|
2312
2671
|
msg: string;
|
|
2313
|
-
data?:
|
|
2672
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2314
2673
|
};
|
|
2315
2674
|
/** Tạo chiến dịch quảng cáo Display trên Zalo Ads (campaignType = 1, Type = 2). */
|
|
2316
2675
|
type ZaloAdsCreateDisplayCampaignRequest = {
|
|
2317
2676
|
/** 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:
|
|
2677
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
2319
2678
|
};
|
|
2320
2679
|
type ZaloAdsCreateDisplayCampaignResponse = {
|
|
2321
2680
|
code: number;
|
|
@@ -2330,18 +2689,18 @@ type ZaloAdsUpdateDisplayAdRequest = {
|
|
|
2330
2689
|
est?: string;
|
|
2331
2690
|
stt?: number | string;
|
|
2332
2691
|
/** Payload cập nhật quảng cáo Display (object hoặc chuỗi JSON). */
|
|
2333
|
-
data:
|
|
2692
|
+
data: ZaloAdsAdUpdatePayloadDto | string;
|
|
2334
2693
|
isBoostAd?: number | string;
|
|
2335
2694
|
};
|
|
2336
2695
|
type ZaloAdsUpdateDisplayAdResponse = {
|
|
2337
2696
|
code: number;
|
|
2338
2697
|
msg: string;
|
|
2339
|
-
data?:
|
|
2698
|
+
data?: ZaloAdsAdMutationResultDto;
|
|
2340
2699
|
};
|
|
2341
2700
|
/** Tạo chiến dịch quảng cáo Video trên Zalo Ads (campaignType = 3, Type = 11). */
|
|
2342
2701
|
type ZaloAdsCreateVideoCampaignRequest = {
|
|
2343
2702
|
/** 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:
|
|
2703
|
+
data: ZaloAdsCampaignCreatePayloadDto | string;
|
|
2345
2704
|
};
|
|
2346
2705
|
type ZaloAdsCreateVideoCampaignResponse = {
|
|
2347
2706
|
code: number;
|
|
@@ -2364,6 +2723,34 @@ type ZaloAdsDeleteCampaignResponse = {
|
|
|
2364
2723
|
/** Thông báo kết quả: "Xóa chiến dịch thành công." */
|
|
2365
2724
|
msg: string;
|
|
2366
2725
|
};
|
|
2726
|
+
interface ZaloAdsAutomatedRuleActionDto {
|
|
2727
|
+
/** Mã loại hành động thực thi khi thỏa mãn điều kiện (ví dụ: 5). */
|
|
2728
|
+
type: number;
|
|
2729
|
+
/** Mã trường mục tiêu mà hành động tác động (ví dụ: 1). */
|
|
2730
|
+
field: number;
|
|
2731
|
+
/** Giới hạn trần hoặc sàn của hành động điều chỉnh (ví dụ: 1000000). */
|
|
2732
|
+
limit: number;
|
|
2733
|
+
/** Mảng giá trị tham số của hành động (ví dụ: [5] tương ứng mức thay đổi 5%). */
|
|
2734
|
+
values: Array<number>;
|
|
2735
|
+
}
|
|
2736
|
+
interface ZaloAdsAutomatedRuleConditionDto {
|
|
2737
|
+
/** Mã loại điều kiện đánh giá (ví dụ: 1). */
|
|
2738
|
+
type: number;
|
|
2739
|
+
/** Mã chỉ số đo lường dùng làm điều kiện (ví dụ: 11). */
|
|
2740
|
+
field: number;
|
|
2741
|
+
/** Giá trị ngưỡng so sánh của điều kiện (ví dụ: [1000]). */
|
|
2742
|
+
values: Array<number>;
|
|
2743
|
+
/** Mã toán tử so sánh của điều kiện (ví dụ: 1). */
|
|
2744
|
+
operator: number;
|
|
2745
|
+
/** Mã khoảng thời gian lấy dữ liệu đối chiếu điều kiện (ví dụ: 2). */
|
|
2746
|
+
timeRange: number;
|
|
2747
|
+
}
|
|
2748
|
+
interface ZaloAdsAutomatedRuleScheduleDto {
|
|
2749
|
+
type?: number;
|
|
2750
|
+
frequency?: number;
|
|
2751
|
+
hours?: Array<number>;
|
|
2752
|
+
daysOfWeek?: Array<number>;
|
|
2753
|
+
}
|
|
2367
2754
|
/** Tìm kiếm và lấy danh sách quy tắc tự động (Automated Rules) trên Zalo Ads. */
|
|
2368
2755
|
type ZaloAdsListAutomatedRulesRequest = {
|
|
2369
2756
|
/** Từ khóa lọc theo tên quy tắc tự động (truyền "" để lấy toàn bộ). */
|
|
@@ -2378,19 +2765,16 @@ type ZaloAdsListAutomatedRulesResponse = {
|
|
|
2378
2765
|
memberId: number;
|
|
2379
2766
|
createdBy: number;
|
|
2380
2767
|
ruleName: string;
|
|
2381
|
-
action:
|
|
2382
|
-
conditions: Array<
|
|
2383
|
-
schedule:
|
|
2768
|
+
action: ZaloAdsAutomatedRuleActionDto;
|
|
2769
|
+
conditions: Array<ZaloAdsAutomatedRuleConditionDto>;
|
|
2770
|
+
schedule: ZaloAdsAutomatedRuleScheduleDto;
|
|
2384
2771
|
status: number;
|
|
2385
2772
|
createdTime: number;
|
|
2386
2773
|
appliedTo: number;
|
|
2387
|
-
[key: string]: unknown;
|
|
2388
2774
|
};
|
|
2389
2775
|
campaignIds?: number[];
|
|
2390
2776
|
adIds?: number[];
|
|
2391
|
-
[key: string]: unknown;
|
|
2392
2777
|
}>;
|
|
2393
|
-
[key: string]: unknown;
|
|
2394
2778
|
};
|
|
2395
2779
|
/** 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
2780
|
type ZaloAdsCreateAutomatedRuleRequest = {
|
|
@@ -2399,41 +2783,18 @@ type ZaloAdsCreateAutomatedRuleRequest = {
|
|
|
2399
2783
|
/** Tên quy tắc tự động cần tạo. */
|
|
2400
2784
|
ruleName: string;
|
|
2401
2785
|
/** 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>;
|
|
2786
|
+
action: ZaloAdsAutomatedRuleActionDto;
|
|
2413
2787
|
/** 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>>;
|
|
2788
|
+
conditions: Array<ZaloAdsAutomatedRuleConditionDto>;
|
|
2427
2789
|
/** Tần suất hệ thống chạy kiểm tra quy tắc (ví dụ: 12). */
|
|
2428
2790
|
frequency?: number;
|
|
2429
2791
|
/** 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
2792
|
appliedIds?: Array<number>;
|
|
2431
2793
|
/** Trường tương thích ngược với cấu trúc cũ. */
|
|
2432
2794
|
appliedTo?: number;
|
|
2433
|
-
schedule?:
|
|
2795
|
+
schedule?: ZaloAdsAutomatedRuleScheduleDto;
|
|
2434
2796
|
campaignIds?: number[];
|
|
2435
2797
|
adIds?: number[];
|
|
2436
|
-
[key: string]: unknown;
|
|
2437
2798
|
};
|
|
2438
2799
|
type ZaloAdsCreateAutomatedRuleResponse = {
|
|
2439
2800
|
/** Mã kết quả phản hồi từ Zalo Ads (0 là tạo quy tắc thành công). */
|
|
@@ -2441,8 +2802,7 @@ type ZaloAdsCreateAutomatedRuleResponse = {
|
|
|
2441
2802
|
/** 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
2803
|
msg?: string;
|
|
2443
2804
|
/** 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;
|
|
2805
|
+
data?: number;
|
|
2446
2806
|
};
|
|
2447
2807
|
/** Cập nhật quy tắc tự động (Automated Rule) trên Zalo Ads. */
|
|
2448
2808
|
type ZaloAdsUpdateAutomatedRuleRequest = {
|
|
@@ -2450,18 +2810,16 @@ type ZaloAdsUpdateAutomatedRuleRequest = {
|
|
|
2450
2810
|
rowVersion: number;
|
|
2451
2811
|
appliedTo: number;
|
|
2452
2812
|
ruleName: string;
|
|
2453
|
-
action:
|
|
2454
|
-
conditions: Array<
|
|
2455
|
-
schedule:
|
|
2813
|
+
action: ZaloAdsAutomatedRuleActionDto;
|
|
2814
|
+
conditions: Array<ZaloAdsAutomatedRuleConditionDto>;
|
|
2815
|
+
schedule: ZaloAdsAutomatedRuleScheduleDto;
|
|
2456
2816
|
campaignIds?: number[];
|
|
2457
2817
|
adIds?: number[];
|
|
2458
|
-
[key: string]: unknown;
|
|
2459
2818
|
};
|
|
2460
2819
|
type ZaloAdsUpdateAutomatedRuleResponse = {
|
|
2461
2820
|
code: number;
|
|
2462
2821
|
msg?: string;
|
|
2463
|
-
data?:
|
|
2464
|
-
[key: string]: unknown;
|
|
2822
|
+
data?: number | boolean;
|
|
2465
2823
|
};
|
|
2466
2824
|
/** 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
2825
|
type ZaloAdsChangeAutomatedRuleStatusRequest = {
|
|
@@ -2477,7 +2835,7 @@ type ZaloAdsChangeAutomatedRuleStatusResponse = {
|
|
|
2477
2835
|
code: number;
|
|
2478
2836
|
/** 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
2837
|
msg?: string;
|
|
2480
|
-
data?:
|
|
2838
|
+
data?: number | boolean;
|
|
2481
2839
|
};
|
|
2482
2840
|
/** 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
2841
|
type ZaloAdsGetAutomatedRuleHistoryRequest = {
|
|
@@ -2499,7 +2857,6 @@ type ZaloAdsGetAutomatedRuleHistoryResponse = {
|
|
|
2499
2857
|
content: Array<string>;
|
|
2500
2858
|
/** Thời điểm thực hiện chỉnh sửa (Unix timestamp tính bằng giây). */
|
|
2501
2859
|
created: number;
|
|
2502
|
-
[key: string]: unknown;
|
|
2503
2860
|
}>;
|
|
2504
2861
|
/** 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
2862
|
executeHistory: Array<{
|
|
@@ -2507,11 +2864,8 @@ type ZaloAdsGetAutomatedRuleHistoryResponse = {
|
|
|
2507
2864
|
content?: Array<string>;
|
|
2508
2865
|
/** Thời điểm hệ thống thực thi quy tắc (Unix timestamp tính bằng giây). */
|
|
2509
2866
|
created?: number;
|
|
2510
|
-
[key: string]: unknown;
|
|
2511
2867
|
}>;
|
|
2512
|
-
[key: string]: unknown;
|
|
2513
2868
|
};
|
|
2514
|
-
[key: string]: unknown;
|
|
2515
2869
|
};
|
|
2516
2870
|
/** Xóa quy tắc tự động trên Zalo Ads. */
|
|
2517
2871
|
type ZaloAdsDeleteAutomatedRuleRequest = {
|
|
@@ -2520,7 +2874,7 @@ type ZaloAdsDeleteAutomatedRuleRequest = {
|
|
|
2520
2874
|
type ZaloAdsDeleteAutomatedRuleResponse = {
|
|
2521
2875
|
code: number;
|
|
2522
2876
|
msg?: string;
|
|
2523
|
-
data?:
|
|
2877
|
+
data?: number | boolean;
|
|
2524
2878
|
};
|
|
2525
2879
|
/** 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
2880
|
type ZaloAdsUploadCustomAudiencePhoneListRequest = {
|
|
@@ -2640,7 +2994,7 @@ declare class ZaloAdsService {
|
|
|
2640
2994
|
getApiNotifiesHeader(request?: ZaloAdsGetApiNotifiesHeaderRequest, options?: RequestOptions): Promise<ZaloAdsGetApiNotifiesHeaderResponse>;
|
|
2641
2995
|
getApiPaymentTransactionHistory(request: ZaloAdsGetApiPaymentTransactionHistoryRequest, options?: RequestOptions): Promise<ZaloAdsGetApiPaymentTransactionHistoryResponse>;
|
|
2642
2996
|
getApiPlaceGetalldistricts(request?: ZaloAdsGetApiPlaceGetalldistrictsRequest, options?: RequestOptions): Promise<ZaloAdsGetApiPlaceGetalldistrictsResponse>;
|
|
2643
|
-
getApiSpellCheckV2(request
|
|
2997
|
+
getApiSpellCheckV2(request: ZaloAdsGetApiSpellCheckV2Request, options?: RequestOptions): Promise<ZaloAdsGetApiSpellCheckV2Response>;
|
|
2644
2998
|
getApiWhoami(request?: ZaloAdsGetApiWhoamiRequest, options?: RequestOptions): Promise<ZaloAdsGetApiWhoamiResponse>;
|
|
2645
2999
|
getReportapiV2Ads(request: ZaloAdsGetReportapiV2AdsRequest, options?: RequestOptions): Promise<ZaloAdsGetReportapiV2AdsResponse>;
|
|
2646
3000
|
getReportapiV2Campaigns(request?: ZaloAdsGetReportapiV2CampaignsRequest, options?: RequestOptions): Promise<ZaloAdsGetReportapiV2CampaignsResponse>;
|
|
@@ -2650,9 +3004,12 @@ declare class ZaloAdsService {
|
|
|
2650
3004
|
getZaapiCheckcamphasmanyads(request?: ZaloAdsGetZaapiCheckcamphasmanyadsRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiCheckcamphasmanyadsResponse>;
|
|
2651
3005
|
getZaapiGetadsfromcampaignid(request?: ZaloAdsGetZaapiGetadsfromcampaignidRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetadsfromcampaignidResponse>;
|
|
2652
3006
|
getZaapiGetallpages(request?: ZaloAdsGetZaapiGetallpagesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetallpagesResponse>;
|
|
2653
|
-
|
|
3007
|
+
getAllPages(request?: ZaloAdsGetZaapiGetallpagesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetallpagesResponse>;
|
|
3008
|
+
getZaapiGetownedarticles(request: ZaloAdsGetZaapiGetownedarticlesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetownedarticlesResponse>;
|
|
3009
|
+
getOwnedArticles(request: ZaloAdsGetZaapiGetownedarticlesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetownedarticlesResponse>;
|
|
2654
3010
|
getZaapiGetownedpages(request?: ZaloAdsGetZaapiGetownedpagesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetownedpagesResponse>;
|
|
2655
|
-
|
|
3011
|
+
getOwnedPages(request?: ZaloAdsGetZaapiGetownedpagesRequest, options?: RequestOptions): Promise<ZaloAdsGetZaapiGetownedpagesResponse>;
|
|
3012
|
+
listAgencyCustomersWithBudget(request?: ZaloAdsListAgencyCustomersWithBudgetRequest, options?: RequestOptions): Promise<ZaloAdsListAgencyCustomersWithBudgetResponse>;
|
|
2656
3013
|
listCustomReports(request?: ZaloAdsListCustomReportsRequest, options?: RequestOptions): Promise<ZaloAdsListCustomReportsResponse>;
|
|
2657
3014
|
listFormsByOfficialAccount(request: ZaloAdsListFormsByOfficialAccountRequest, options?: RequestOptions): Promise<ZaloAdsListFormsByOfficialAccountResponse>;
|
|
2658
3015
|
listMiniPagesByTemplate(request: ZaloAdsListMiniPagesByTemplateRequest, options?: RequestOptions): Promise<ZaloAdsListMiniPagesByTemplateResponse>;
|
|
@@ -2660,6 +3017,8 @@ declare class ZaloAdsService {
|
|
|
2660
3017
|
postApiAdEstimateaudience(request: ZaloAdsPostApiAdEstimateaudienceRequest, options?: RequestOptions): Promise<ZaloAdsPostApiAdEstimateaudienceResponse>;
|
|
2661
3018
|
postApiMediaSave(request: ZaloAdsPostApiMediaSaveRequest, options?: RequestOptions): Promise<ZaloAdsPostApiMediaSaveResponse>;
|
|
2662
3019
|
postApiMemberUploadImage(request: ZaloAdsPostApiMemberUploadImageRequest, options?: RequestOptions): Promise<ZaloAdsPostApiMemberUploadImageResponse>;
|
|
3020
|
+
/** Alias tiện lợi cho `postApiMemberUploadImage` (`POST /api/member/upload-image`). */
|
|
3021
|
+
uploadImage(request: ZaloAdsPostApiMemberUploadImageRequest, options?: RequestOptions): Promise<ZaloAdsPostApiMemberUploadImageResponse>;
|
|
2663
3022
|
postZaapiDeletead(request?: ZaloAdsPostZaapiDeleteadRequest, options?: RequestOptions): Promise<ZaloAdsPostZaapiDeleteadResponse>;
|
|
2664
3023
|
renameCampaign(request: ZaloAdsRenameCampaignRequest, options?: RequestOptions): Promise<ZaloAdsRenameCampaignResponse>;
|
|
2665
3024
|
updateEcommerceAd(request: ZaloAdsUpdateEcommerceAdRequest, options?: RequestOptions): Promise<ZaloAdsUpdateEcommerceAdResponse>;
|
|
@@ -2780,15 +3139,23 @@ type ZaloFormsExportFormLeadReportResponse = {
|
|
|
2780
3139
|
/** Tên tệp .xlsx lấy từ Content-Disposition, nếu executor cung cấp. */
|
|
2781
3140
|
fileName?: string;
|
|
2782
3141
|
contentType?: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
|
|
2783
|
-
[key: string]: unknown;
|
|
2784
3142
|
};
|
|
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.
|
|
3143
|
+
/** 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
3144
|
type ZaloFormsListAudienceExclusionTargetingRequest = {
|
|
2787
3145
|
/** ID Official Account cần lấy lựa chọn audience loại trừ. */
|
|
2788
3146
|
oaId: string;
|
|
2789
3147
|
};
|
|
3148
|
+
type ZaloFormsAudienceExclusionTargetingItem = {
|
|
3149
|
+
id: string;
|
|
3150
|
+
name: string;
|
|
3151
|
+
oaId: string;
|
|
3152
|
+
totalLeads?: number;
|
|
3153
|
+
createdTime?: number;
|
|
3154
|
+
};
|
|
2790
3155
|
type ZaloFormsListAudienceExclusionTargetingResponse = {
|
|
2791
|
-
|
|
3156
|
+
msg: string;
|
|
3157
|
+
code: number;
|
|
3158
|
+
data: Array<ZaloFormsAudienceExclusionTargetingItem>;
|
|
2792
3159
|
};
|
|
2793
3160
|
/** 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
3161
|
type ZaloFormsListConversationLeadsRequest = {
|
|
@@ -2811,8 +3178,26 @@ type ZaloFormsListConversationLeadsRequest = {
|
|
|
2811
3178
|
/** Danh sách scene ID phân cách dấu phẩy, có thể bỏ trống. */
|
|
2812
3179
|
sceneIds?: string;
|
|
2813
3180
|
};
|
|
3181
|
+
type ZaloFormsConversationLeadItem = {
|
|
3182
|
+
id: string;
|
|
3183
|
+
oaId: string;
|
|
3184
|
+
userId: string;
|
|
3185
|
+
userName: string;
|
|
3186
|
+
userAvatar?: string;
|
|
3187
|
+
phone?: string;
|
|
3188
|
+
status: number;
|
|
3189
|
+
sceneId?: string;
|
|
3190
|
+
sceneName?: string;
|
|
3191
|
+
labelIds?: Array<string>;
|
|
3192
|
+
note?: string;
|
|
3193
|
+
createdTime: number;
|
|
3194
|
+
updatedTime?: number;
|
|
3195
|
+
};
|
|
2814
3196
|
type ZaloFormsListConversationLeadsResponse = {
|
|
2815
|
-
|
|
3197
|
+
msg: string;
|
|
3198
|
+
code: number;
|
|
3199
|
+
total: number;
|
|
3200
|
+
data: Array<ZaloFormsConversationLeadItem>;
|
|
2816
3201
|
};
|
|
2817
3202
|
/** 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
3203
|
type ZaloFormsListFormLeadsRequest = {
|
|
@@ -2839,15 +3224,33 @@ type ZaloFormsListFormLeadsRequest = {
|
|
|
2839
3224
|
/** Chế độ commerce. */
|
|
2840
3225
|
isCommerce: boolean;
|
|
2841
3226
|
};
|
|
3227
|
+
type ZaloFormsLeadAnswerItem = {
|
|
3228
|
+
questionId: string;
|
|
3229
|
+
title: string;
|
|
3230
|
+
value: string;
|
|
3231
|
+
};
|
|
3232
|
+
type ZaloFormsLeadItem = {
|
|
3233
|
+
id: string;
|
|
3234
|
+
formId: string;
|
|
3235
|
+
formName?: string;
|
|
3236
|
+
oaId: string;
|
|
3237
|
+
userId?: string;
|
|
3238
|
+
userName?: string;
|
|
3239
|
+
phone?: string;
|
|
3240
|
+
status: number;
|
|
3241
|
+
labelIds?: Array<string>;
|
|
3242
|
+
note?: string;
|
|
3243
|
+
createdTime: number;
|
|
3244
|
+
updatedTime?: number;
|
|
3245
|
+
answers?: Array<ZaloFormsLeadAnswerItem>;
|
|
3246
|
+
};
|
|
2842
3247
|
type ZaloFormsListFormLeadsResponse = {
|
|
2843
3248
|
msg: string;
|
|
2844
3249
|
/** 0 là thành công. */
|
|
2845
3250
|
code: number;
|
|
2846
|
-
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
}>;
|
|
2850
|
-
[key: string]: unknown;
|
|
3251
|
+
total?: number;
|
|
3252
|
+
/** Danh sách bản ghi lead thu từ Zalo Form. */
|
|
3253
|
+
data: Array<ZaloFormsLeadItem>;
|
|
2851
3254
|
};
|
|
2852
3255
|
/** 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
3256
|
type ZaloFormsListManagedFormsByOfficialAccountRequest = {
|
|
@@ -2903,11 +3306,9 @@ type ZaloFormsListManagedFormsByOfficialAccountResponse = {
|
|
|
2903
3306
|
totalGetForm: string;
|
|
2904
3307
|
/** 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
3308
|
RequiresUniqueResponse: boolean;
|
|
2906
|
-
[key: string]: unknown;
|
|
2907
3309
|
}>;
|
|
2908
3310
|
/** Tổng số form khớp với OA và khoảng thời gian. */
|
|
2909
3311
|
total: number;
|
|
2910
|
-
[key: string]: unknown;
|
|
2911
3312
|
};
|
|
2912
3313
|
/** Lấy danh sách form có thể chọn của một Official Account theo thời gian, loại form và chế độ commerce. Đây là entry tool thuộc lane zalo-ads-form; dùng khi cần lấy data[].id làm formId để lọc lead. 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. */
|
|
2913
3314
|
type ZaloFormsListSimpleFormsByOfficialAccountRequest = {
|
|
@@ -2957,10 +3358,8 @@ type ZaloFormsListSimpleFormsByOfficialAccountResponse = {
|
|
|
2957
3358
|
totalGetForm: string;
|
|
2958
3359
|
/** Giữ nguyên chữ hoa/thường của upstream. */
|
|
2959
3360
|
RequiresUniqueResponse: boolean;
|
|
2960
|
-
[key: string]: unknown;
|
|
2961
3361
|
}>;
|
|
2962
3362
|
total: number;
|
|
2963
|
-
[key: string]: unknown;
|
|
2964
3363
|
};
|
|
2965
3364
|
/** 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
3365
|
type ZaloFormsUpdateFormLeadNotificationIntervalRequest = {
|
|
@@ -2987,9 +3386,7 @@ type ZaloFormsUpdateFormLeadNotificationIntervalResponse = {
|
|
|
2987
3386
|
formName: string;
|
|
2988
3387
|
/** 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
3388
|
interval: number;
|
|
2990
|
-
[key: string]: unknown;
|
|
2991
3389
|
};
|
|
2992
|
-
[key: string]: unknown;
|
|
2993
3390
|
};
|
|
2994
3391
|
type ZaloFormsAuthSessionOaItem = {
|
|
2995
3392
|
/** Mã vai trò trên OA (ví dụ: 1 = Admin). */
|
|
@@ -3008,7 +3405,6 @@ type ZaloFormsAuthSessionOaItem = {
|
|
|
3008
3405
|
status?: number;
|
|
3009
3406
|
apiUploadEnabled?: boolean;
|
|
3010
3407
|
adMessageEnabled?: boolean;
|
|
3011
|
-
[key: string]: unknown;
|
|
3012
3408
|
};
|
|
3013
3409
|
/** 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
3410
|
type ZaloFormsGetAuthSessionResponse = {
|
|
@@ -3020,12 +3416,10 @@ type ZaloFormsGetAuthSessionResponse = {
|
|
|
3020
3416
|
avatar: string;
|
|
3021
3417
|
token: string;
|
|
3022
3418
|
isInVN?: boolean;
|
|
3023
|
-
roleWLReview?:
|
|
3419
|
+
roleWLReview?: string[];
|
|
3024
3420
|
oaNotifyLead?: ZaloFormsAuthSessionOaItem;
|
|
3025
3421
|
oas: ZaloFormsAuthSessionOaItem[];
|
|
3026
|
-
[key: string]: unknown;
|
|
3027
3422
|
};
|
|
3028
|
-
[key: string]: unknown;
|
|
3029
3423
|
};
|
|
3030
3424
|
|
|
3031
3425
|
/** Zalo Forms API service. Each API explicitly selects its own request transport. */
|
|
@@ -3067,42 +3461,77 @@ declare class ZaloInstantPagesService {
|
|
|
3067
3461
|
|
|
3068
3462
|
/** DTOs for Zalo Profile Ads (`https://profile.ads.zalo.me`). Request fields are flattened; services route them automatically. */
|
|
3069
3463
|
|
|
3070
|
-
/**
|
|
3464
|
+
/**
|
|
3465
|
+
* Mã Danh mục hoạt động chi tiết (`subCategoryId` - 22 mã chuẩn trên `https://profile.ads.zalo.me/register`):
|
|
3466
|
+
* - `10043`: Bất động sản
|
|
3467
|
+
* - `10018`: Công nghệ & Thiết bị
|
|
3468
|
+
* - `10097`: Dịch vụ tiện ích
|
|
3469
|
+
* - `10020`: Du lịch & Lưu trú
|
|
3470
|
+
* - `10021`: Giáo dục & Đào tạo
|
|
3471
|
+
* - `10024`: Mua sắm & Bán lẻ
|
|
3472
|
+
* - `10019`: Mỹ phẩm & Làm đẹp
|
|
3473
|
+
* - `10014`: Nhà hàng & Quán
|
|
3474
|
+
* - `10094`: Ô tô & Xe máy
|
|
3475
|
+
* - `10098`: Sản xuất & Chế tạo
|
|
3476
|
+
* - `10044`: Tài chính & Ngân hàng
|
|
3477
|
+
* - `10099`: Thiết kế & Thi công
|
|
3478
|
+
* - `10017`: Thời trang & May mặc
|
|
3479
|
+
* - `10023`: Thực phẩm & Đồ uống
|
|
3480
|
+
* - `10016`: Truyền thông & Giải trí
|
|
3481
|
+
* - `10092`: Truyền thông nội bộ
|
|
3482
|
+
* - `10101`: Tuyển dụng & Việc làm
|
|
3483
|
+
* - `10100`: Tư vấn & Quản lý
|
|
3484
|
+
* - `10095`: Vận tải
|
|
3485
|
+
* - `10093`: Viễn thông
|
|
3486
|
+
* - `10022`: Y tế & Dược phẩm
|
|
3487
|
+
* - `10025`: Dịch vụ khác
|
|
3488
|
+
*/
|
|
3489
|
+
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 & {});
|
|
3490
|
+
/**
|
|
3491
|
+
* Mã 34 Tỉnh/Thành phố chuẩn trên `https://profile.ads.zalo.me/ajax/get-province`:
|
|
3492
|
+
* - `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ế
|
|
3493
|
+
* - `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
|
|
3494
|
+
* - `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
|
|
3495
|
+
* - `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
|
|
3496
|
+
* - `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
|
|
3497
|
+
*/
|
|
3498
|
+
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 & {});
|
|
3499
|
+
/** 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
3500
|
type ZaloProfileAdsCreateOaPageRequest = {
|
|
3072
3501
|
/** 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
3502
|
option?: "createpage";
|
|
3074
3503
|
/** 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
3504
|
"crsf-token"?: string;
|
|
3076
|
-
/**
|
|
3077
|
-
|
|
3078
|
-
/**
|
|
3505
|
+
/** 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). */
|
|
3506
|
+
typeId?: number;
|
|
3507
|
+
/** Đị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). */
|
|
3508
|
+
typeName?: string;
|
|
3509
|
+
/** 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`). */
|
|
3510
|
+
tier?: number;
|
|
3511
|
+
/** 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). */
|
|
3512
|
+
categoryId?: number;
|
|
3513
|
+
/** 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). */
|
|
3514
|
+
subCategoryId: ZaloProfileAdsSubCategoryId;
|
|
3515
|
+
/** 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
3516
|
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;
|
|
3517
|
+
/** 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ự). */
|
|
3518
|
+
description: string;
|
|
3098
3519
|
/** Họ và tên người liên hệ phụ trách trang OA. */
|
|
3099
3520
|
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'). */
|
|
3521
|
+
/** Số điện thoại người liên hệ (định dạng chuỗi số, ví dụ: '84384473007'). */
|
|
3103
3522
|
contactPhone: string;
|
|
3104
|
-
/** Mã
|
|
3105
|
-
|
|
3523
|
+
/** Mã fileId của ảnh đại diện nhận được từ công cụ tải ảnh đại diện (`uploadOaAvatar`). */
|
|
3524
|
+
avatarId: string;
|
|
3525
|
+
/** Mã fileId của ảnh bìa nhận được từ công cụ tải ảnh bìa (`uploadOaCover`). */
|
|
3526
|
+
coverId: string;
|
|
3527
|
+
/** 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). */
|
|
3528
|
+
province: ZaloProfileAdsProvinceId;
|
|
3529
|
+
/** 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). */
|
|
3530
|
+
district: number;
|
|
3531
|
+
/** Đị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'). */
|
|
3532
|
+
address: string;
|
|
3533
|
+
/** 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). */
|
|
3534
|
+
agreeTerm?: boolean;
|
|
3106
3535
|
};
|
|
3107
3536
|
type ZaloProfileAdsCreateOaPageResponse = {
|
|
3108
3537
|
/** Mã lỗi phản hồi từ Zalo Ads Profile (0 là tạo trang thành công). */
|
|
@@ -3115,9 +3544,7 @@ type ZaloProfileAdsCreateOaPageResponse = {
|
|
|
3115
3544
|
name: string;
|
|
3116
3545
|
/** Mã định danh Zalo Official Account ID (OA ID) vừa được khởi tạo. */
|
|
3117
3546
|
oaid: string;
|
|
3118
|
-
[key: string]: unknown;
|
|
3119
3547
|
};
|
|
3120
|
-
[key: string]: unknown;
|
|
3121
3548
|
};
|
|
3122
3549
|
/** 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
3550
|
type ZaloProfileAdsUploadOaAvatarRequest = {
|
|
@@ -3125,7 +3552,7 @@ type ZaloProfileAdsUploadOaAvatarRequest = {
|
|
|
3125
3552
|
option?: "update";
|
|
3126
3553
|
/** 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
3554
|
"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`. */
|
|
3555
|
+
/** 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
3556
|
"avatar-file": FileInput;
|
|
3130
3557
|
};
|
|
3131
3558
|
type ZaloProfileAdsUploadOaAvatarResponse = {
|
|
@@ -3135,7 +3562,6 @@ type ZaloProfileAdsUploadOaAvatarResponse = {
|
|
|
3135
3562
|
msg: string;
|
|
3136
3563
|
/** 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
3564
|
fileId: string;
|
|
3138
|
-
[key: string]: unknown;
|
|
3139
3565
|
};
|
|
3140
3566
|
/** 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
3567
|
type ZaloProfileAdsUploadOaCoverRequest = {
|
|
@@ -3143,7 +3569,7 @@ type ZaloProfileAdsUploadOaCoverRequest = {
|
|
|
3143
3569
|
option?: "update";
|
|
3144
3570
|
/** 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
3571
|
"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`. */
|
|
3572
|
+
/** 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
3573
|
"cover-file": FileInput;
|
|
3148
3574
|
};
|
|
3149
3575
|
type ZaloProfileAdsUploadOaCoverResponse = {
|
|
@@ -3153,7 +3579,36 @@ type ZaloProfileAdsUploadOaCoverResponse = {
|
|
|
3153
3579
|
msg: string;
|
|
3154
3580
|
/** 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
3581
|
fileId: string;
|
|
3156
|
-
|
|
3582
|
+
};
|
|
3583
|
+
/** Phần tử Tỉnh/Thành phố hoặc Phường/Xã trên Zalo Ads Profile (`https://profile.ads.zalo.me`). */
|
|
3584
|
+
type ZaloProfileAdsAdministrativeItem = {
|
|
3585
|
+
/** Mã định danh Tỉnh/Thành phố (`province`) hoặc Phường/Xã (`district`). */
|
|
3586
|
+
id: number;
|
|
3587
|
+
/** Tên hiển thị của Tỉnh/Thành phố hoặc Phường/Xã. */
|
|
3588
|
+
value: string;
|
|
3589
|
+
};
|
|
3590
|
+
/** 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`). */
|
|
3591
|
+
type ZaloProfileAdsGetProvincesResponse = {
|
|
3592
|
+
/** Mã lỗi phản hồi từ Zalo Ads Profile (0 là thành công). */
|
|
3593
|
+
err: number;
|
|
3594
|
+
/** Thông điệp kết quả xử lý (ví dụ: 'Lấy dữ liệu thành công.'). */
|
|
3595
|
+
msg: string;
|
|
3596
|
+
/** Danh sách 34 Tỉnh/Thành phố. */
|
|
3597
|
+
data: ZaloProfileAdsAdministrativeItem[];
|
|
3598
|
+
};
|
|
3599
|
+
/** 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=...`). */
|
|
3600
|
+
type ZaloProfileAdsGetDistrictsRequest = {
|
|
3601
|
+
/** 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). */
|
|
3602
|
+
provinceId: ZaloProfileAdsProvinceId;
|
|
3603
|
+
};
|
|
3604
|
+
/** 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=...`). */
|
|
3605
|
+
type ZaloProfileAdsGetDistrictsResponse = {
|
|
3606
|
+
/** Mã lỗi phản hồi từ Zalo Ads Profile (0 là thành công). */
|
|
3607
|
+
err: number;
|
|
3608
|
+
/** Thông điệp kết quả xử lý (ví dụ: 'Lấy dữ liệu thành công.'). */
|
|
3609
|
+
msg: string;
|
|
3610
|
+
/** Danh sách Phường/Xã thuộc Tỉnh/Thành phố được truy vấn. */
|
|
3611
|
+
data: ZaloProfileAdsAdministrativeItem[];
|
|
3157
3612
|
};
|
|
3158
3613
|
|
|
3159
3614
|
/** Zalo Profile Ads API service (`https://profile.ads.zalo.me`). Each API explicitly selects its own request transport. */
|
|
@@ -3164,6 +3619,8 @@ declare class ZaloProfileAdsService {
|
|
|
3164
3619
|
createOaPage(request: ZaloProfileAdsCreateOaPageRequest, options?: RequestOptions): Promise<ZaloProfileAdsCreateOaPageResponse>;
|
|
3165
3620
|
uploadOaAvatar(request: ZaloProfileAdsUploadOaAvatarRequest, options?: RequestOptions): Promise<ZaloProfileAdsUploadOaAvatarResponse>;
|
|
3166
3621
|
uploadOaCover(request: ZaloProfileAdsUploadOaCoverRequest, options?: RequestOptions): Promise<ZaloProfileAdsUploadOaCoverResponse>;
|
|
3622
|
+
getProvinces(options?: RequestOptions): Promise<ZaloProfileAdsGetProvincesResponse>;
|
|
3623
|
+
getDistricts(request: ZaloProfileAdsGetDistrictsRequest, options?: RequestOptions): Promise<ZaloProfileAdsGetDistrictsResponse>;
|
|
3167
3624
|
}
|
|
3168
3625
|
|
|
3169
3626
|
/** 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. */
|
|
@@ -3474,4 +3931,4 @@ declare class ZaloAdsIntegrationManager {
|
|
|
3474
3931
|
get poolSize(): number;
|
|
3475
3932
|
}
|
|
3476
3933
|
|
|
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 };
|
|
3934
|
+
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, 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 ZaloAdsConversionElementSelectorDto, type ZaloAdsConversionItemDto, 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 ZaloAdsCreateFormPayloadDto, 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, type ZaloAdsFileGroupItemDto, ZaloAdsFlowButtonDto, ZaloAdsFlowChildMessageDto, ZaloAdsFlowMessageDto, type ZaloAdsFormAnswerDto, 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 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 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, type ZaloAdsLpNewsButtonDto, type ZaloAdsLpNewsItemDto, type ZaloAdsMediaSavePayloadDto, type ZaloAdsMediaSaveSettingsDto, type ZaloAdsMemberFileItemDto, ZaloAdsMessageAdUpdateDataDto, type ZaloAdsNotifyHeaderItemDto, type ZaloAdsOwnedArticleItemDto, type ZaloAdsOwnedPageExtraInfoDto, type ZaloAdsOwnedPageItemDto, type ZaloAdsOwnedPageLocationDto, type ZaloAdsPageConfigDto, type ZaloAdsPaymentTransactionItemDto, 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 ZaloAuthDomain, ZaloAuthManager, type ZaloChatWidgetGetChatWidgetLoginConfigRequest, type ZaloChatWidgetGetChatWidgetLoginConfigResponse, type ZaloChatWidgetGetLoginConfigRequest, type ZaloChatWidgetGetLoginConfigResponse, ZaloChatWidgetService, type ZaloDomainSession, 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 ZaloFormsListSimpleFormsByOfficialAccountRequest, type ZaloFormsListSimpleFormsByOfficialAccountResponse, ZaloFormsService, type ZaloFormsUpdateFormLeadNotificationIntervalRequest, type ZaloFormsUpdateFormLeadNotificationIntervalResponse, 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, type ZaloIntegrationCredentials, type ZaloIntegrationVerificationResult, 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, 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 };
|