@exonmedia/adtech 0.1.29 → 0.1.31

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.
Files changed (5) hide show
  1. package/contracts/index.esm.js +7 -1
  2. package/contracts/src/user-uploads/index.d.ts +1 -0
  3. package/contracts/src/user-uploads/user-upload-details.response.d.ts +92 -0
  4. package/contracts/src/user-uploads/user-uploads.response.d.ts +14 -4
  5. package/package.json +1 -1
package/contracts/index.esm.js CHANGED
@@ -31,4 +31,10 @@ var UPLOAD_STATUS = {
31
31
  PENDING: 'pending'
32
32
  };
33
33
 
34
- export { CAMPAIGN_CATEGORY, CAMPAIGN_STRUCTURE, CONTENT_GENERATION_STATUS, MATCH_TYPE, UPLOAD_MODE, UPLOAD_STATUS };
34
+ var STEP_STATUS = {
35
+ NOT_STARTED: 'not-started',
36
+ RUNNING: 'running',
37
+ COMPLETED: 'completed'
38
+ };
39
+
40
+ export { CAMPAIGN_CATEGORY, CAMPAIGN_STRUCTURE, CONTENT_GENERATION_STATUS, MATCH_TYPE, STEP_STATUS, UPLOAD_MODE, UPLOAD_STATUS };
package/contracts/src/user-uploads/index.d.ts CHANGED
@@ -1,2 +1,3 @@
1
1
  export * from './user-uploads.request';
2
2
  export * from './user-uploads.response';
3
+ export * from './user-upload-details.response';
package/contracts/src/user-uploads/user-upload-details.response.d.ts ADDED
@@ -0,0 +1,92 @@
1
+ import type { ObjectValues } from '../internal/type-utils';
2
+ export declare const STEP_STATUS: {
3
+ readonly NOT_STARTED: "not-started";
4
+ readonly RUNNING: "running";
5
+ readonly COMPLETED: "completed";
6
+ };
7
+ export type StepStatus = ObjectValues<typeof STEP_STATUS>;
8
+ export interface UploadSteps {
9
+ uploadOverview: StepStatus;
10
+ preContentFiltering: StepStatus;
11
+ contentGeneration: StepStatus;
12
+ uploadToGoogle: StepStatus;
13
+ }
14
+ export interface UploadDetailsBase {
15
+ steps: UploadSteps;
16
+ uploadResults?: {
17
+ totalCampaigns: {
18
+ total: number;
19
+ new: number;
20
+ updated: number;
21
+ };
22
+ totalAdgroups: {
23
+ total: number;
24
+ new: number;
25
+ updated: number;
26
+ errors: number;
27
+ };
28
+ };
29
+ batchIds?: string[];
30
+ contentGeneration?: {
31
+ adgroupsEnteredGeneration: number;
32
+ contentFailed: number;
33
+ success: number;
34
+ };
35
+ uploadToGoogle?: {
36
+ adgroupsUploaded: number;
37
+ withoutAds: number;
38
+ successfullyUploaded: number;
39
+ };
40
+ }
41
+ export interface CampaignUploadDetails extends UploadDetailsBase {
42
+ mode: 'campaigns';
43
+ campaignsInFile: number;
44
+ preContentFiltering?: {
45
+ campaigns: {
46
+ initial: number;
47
+ duplicationsInFile: number;
48
+ blacklisted: number;
49
+ deffluffed: number;
50
+ total: number;
51
+ };
52
+ adgroups: {
53
+ generated: number;
54
+ existingInGoogleAds: number;
55
+ searchVolumeFilter: number;
56
+ noCategoryFound: number;
57
+ total: number;
58
+ };
59
+ };
60
+ }
61
+ export interface AdgroupUploadDetails extends UploadDetailsBase {
62
+ mode: 'adgroups';
63
+ adgroupsInFile: number;
64
+ preContentFiltering?: {
65
+ adgroups: {
66
+ initial: number;
67
+ duplicationsInFile: number;
68
+ blacklisted: number;
69
+ deffluffed: number;
70
+ existingInGoogleAds: number;
71
+ searchVolumeFilter: number;
72
+ noCategoryFound: number;
73
+ total: number;
74
+ };
75
+ };
76
+ }
77
+ export interface KeywordsUploadDetails extends UploadDetailsBase {
78
+ mode: 'keywords';
79
+ keywordsInFile: number;
80
+ preContentFiltering?: {
81
+ keywords: {
82
+ initial: number;
83
+ duplicationsInFile: number;
84
+ blacklisted: number;
85
+ deffluffed: number;
86
+ searchVolumeFilter: number;
87
+ noCategoryFound: number;
88
+ total: number;
89
+ };
90
+ };
91
+ }
92
+ export type UploadDetails = CampaignUploadDetails | AdgroupUploadDetails | KeywordsUploadDetails;
package/contracts/src/user-uploads/user-uploads.response.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { ObjectValues } from '../internal/type-utils';
2
- import type { UploadMode, CampaignStructure, CampaignCategory } from '../types/upload.types';
2
+ import type { UploadMode, CampaignStructure, CampaignCategory, MatchType } from '../types/upload.types';
3
3
  export declare const UPLOAD_STATUS: {
4
4
  readonly SUCCESS: "success";
5
5
  readonly FAILED: "failed";
@@ -20,15 +20,24 @@ export type GoogleUploadHistory = {
20
20
  status: 'failed';
21
21
  payloadPath: string;
22
22
  error: string;
23
+ batchTrackId?: string;
23
24
  } | {
24
- status: 'success' | 'pending';
25
+ status: 'success';
25
26
  payloadPath: string;
27
+ googleBatchId: string;
28
+ accountName: string;
29
+ batchTrackId: string;
30
+ } | {
31
+ status: 'pending';
32
+ payloadPath: string;
33
+ batchTrackId: string;
26
34
  };
27
35
  export interface UserUploadWithDomain {
28
36
  id: string;
29
37
  title: string;
30
38
  mode: UploadMode;
31
39
  status: UploadStatus;
40
+ errorMessage?: string;
32
41
  username?: string;
33
42
  defluff: boolean;
34
43
  searchVolumeFilterEnabled: boolean;
@@ -39,11 +48,12 @@ export interface UserUploadWithDomain {
39
48
  campaignStructure?: CampaignStructure;
40
49
  campaignCategory?: CampaignCategory;
41
50
  accountName: string;
51
+ matchType?: MatchType;
42
52
  imageGenerationModel?: string;
43
53
  textGenerationModel?: string;
44
54
  gawUploadsHistory?: GoogleUploadHistory[];
45
- createdAt: string;
46
- updatedAt: string;
55
+ createdAt?: string;
56
+ updatedAt?: string;
47
57
  domain: DomainInfo;
48
58
  }
49
59
  export interface PaginatedResult<TItem> {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@exonmedia/adtech",
3
- "version": "0.1.29",
3
+ "version": "0.1.31",
4
4
  "description": "Shared contracts for Adtech Platform",
5
5
  "license": "ISC",
6
6
  "type": "module",