agrs-sequelize-sdk 1.1.59 → 1.1.61

package/models/AdSet.js

@@ -1,3 +1,147 @@
+// module.exports = (sequelize, DataTypes) => {
+//   const AdSet = sequelize.define(
+//     "AdSet",
+//     {
+//       AdSetID: {
+//         type: DataTypes.STRING,
+//         primaryKey: true,
+//       },
+//       AdSetName: {
+//         type: DataTypes.STRING,
+//         allowNull: true,
+//       },
+//       Status: {
+//         type: DataTypes.STRING,
+//         allowNull: true,
+//       },
+//       daily_budget: {
+//         type: DataTypes.INTEGER,
+//         allowNull: true,
+//       },
+//       start_time: {
+//         type: DataTypes.DATE,
+//         allowNull: true,
+//       },
+//       end_time: {
+//         type: DataTypes.DATE,
+//         allowNull: true,
+//       },
+//       targeting: {
+//         type: DataTypes.JSONB,
+//         allowNull: true,
+//       },
+//       promotedObject: {
+//         type: DataTypes.JSONB, // Storing promoted object as a JSON object
+//         allowNull: true,
+//       },
+//       BillingEvent: {
+//         type: DataTypes.STRING,
+//         allowNull: false,
+//         defaultValue: "impressions", // Default value for BillingEvent
+//       },
+//       OptimizationGoal: {
+//         type: DataTypes.STRING,
+//         allowNull: false,
+//         defaultValue: "offsite_conversions", // Default value for OptimizationGoal
+//       },
+//       Draft: {
+//         type: DataTypes.BOOLEAN,
+//         allowNull: true,
+//         defaultValue: false,
+//       },
+//       UserCreated: {
+//         type: DataTypes.STRING,
+//         allowNull: true,
+//       },
+//       publish: {
+//         type: DataTypes.BOOLEAN,
+//         allowNull: true,
+//         defaultValue: true,
+//       },
+//       CampaignID: {
+//         type: DataTypes.STRING,
+//         allowNull: false,
+//         references: {
+//           model: "Campaign",
+//           key: "CampaignID",
+//         },
+//       },
+//       effectiveStatus: {
+//         type: DataTypes.STRING,
+//         allowNull: true,
+//       },
+//       // add issues_info field
+//       issuesInfo: {
+//         type: DataTypes.JSONB,
+//         allowNull: true,
+//       },
+//       bid_strategy: {
+//         type: DataTypes.STRING,
+//         allowNull: true,
+//       },
+//       // bid amount
+//       bid_amount: {
+//         type: DataTypes.INTEGER,
+//         allowNull: true,
+//       },
+//       waiting: {
+//         type: DataTypes.BOOLEAN,
+//         defaultValue: false,
+//       },
+//     },
+//     {
+//       tableName: "AdSet",
+//       indexes: [
+//         {
+//           fields: ["CampaignID"], // Index on CampaignID for faster join
+//         },
+//       ],
+//     }
+//   );
+
+//   AdSet.associate = (models) => {
+//     AdSet.belongsTo(models.Campaign, { foreignKey: "CampaignID" });
+//     AdSet.hasMany(models.Ad, { foreignKey: "AdSetID" });
+//   };
+
+//   AdSet.addHook("beforeUpdate", async (adSet, options) => {
+//     if (adSet.changed("publish")) {
+//       if (adSet.previous("publish") === true && adSet.publish === false) {
+//         // Save current state to AdSetHistory
+//         await sequelize.models.AdSetHistory.create({
+//           AdSetID: adSet.AdSetID,
+//           DataSnapshot: adSet._previousDataValues, // Save the full AdSet data as JSON
+//         });
+//       } else if (
+//         adSet.previous("publish") === false &&
+//         adSet.publish === true
+//       ) {
+//         // Delete the latest history entry
+//         const latestHistory = await sequelize.models.AdSetHistory.findOne({
+//           where: { AdSetID: adSet.AdSetID },
+//           order: [["timestamp", "DESC"]], // Get the latest history entry
+//         });
+
+//         if (latestHistory) {
+//           await latestHistory.destroy();
+//         }
+//       }
+//     }
+//   });
+
+//   AdSet.addHook("afterCreate", async (adSet, options) => {
+//     if (adSet.publish === false) {
+//       // If publish is false on creation, save a snapshot to AdSetHistory
+//       await sequelize.models.AdSetHistory.create({
+//         AdSetID: adSet.AdSetID,
+//         DataSnapshot: adSet.toJSON(), // Save the full AdSet data as JSON
+//       });
+//     }
+//   });
+
+//   return AdSet;
+// };
+
 module.exports = (sequelize, DataTypes) => {
   const AdSet = sequelize.define(
     "AdSet",
@@ -31,18 +175,18 @@ module.exports = (sequelize, DataTypes) => {
         allowNull: true,
       },
       promotedObject: {
-        type: DataTypes.JSONB, // Storing promoted object as a JSON object
+        type: DataTypes.JSONB,
         allowNull: true,
       },
       BillingEvent: {
         type: DataTypes.STRING,
         allowNull: false,
-        defaultValue: "impressions", // Default value for BillingEvent
+        defaultValue: "impressions",
       },
       OptimizationGoal: {
         type: DataTypes.STRING,
         allowNull: false,
-        defaultValue: "offsite_conversions", // Default value for OptimizationGoal
+        defaultValue: "offsite_conversions",
       },
       Draft: {
         type: DataTypes.BOOLEAN,
@@ -70,7 +214,6 @@ module.exports = (sequelize, DataTypes) => {
         type: DataTypes.STRING,
         allowNull: true,
       },
-      // add issues_info field
       issuesInfo: {
         type: DataTypes.JSONB,
         allowNull: true,
@@ -79,7 +222,6 @@ module.exports = (sequelize, DataTypes) => {
         type: DataTypes.STRING,
         allowNull: true,
       },
-      // bid amount
       bid_amount: {
         type: DataTypes.INTEGER,
         allowNull: true,
@@ -93,7 +235,7 @@ module.exports = (sequelize, DataTypes) => {
       tableName: "AdSet",
       indexes: [
         {
-          fields: ["CampaignID"], // Index on CampaignID for faster join
+          fields: ["CampaignID"],
         },
       ],
     }
@@ -102,24 +244,24 @@ module.exports = (sequelize, DataTypes) => {
   AdSet.associate = (models) => {
     AdSet.belongsTo(models.Campaign, { foreignKey: "CampaignID" });
     AdSet.hasMany(models.Ad, { foreignKey: "AdSetID" });
+    // Add this line to define the relationship with AdSetPerformance
+    AdSet.hasMany(models.AdSetPerformance, { foreignKey: "AdSetID" });
   };
 
   AdSet.addHook("beforeUpdate", async (adSet, options) => {
     if (adSet.changed("publish")) {
       if (adSet.previous("publish") === true && adSet.publish === false) {
-        // Save current state to AdSetHistory
         await sequelize.models.AdSetHistory.create({
           AdSetID: adSet.AdSetID,
-          DataSnapshot: adSet._previousDataValues, // Save the full AdSet data as JSON
+          DataSnapshot: adSet._previousDataValues,
         });
       } else if (
         adSet.previous("publish") === false &&
         adSet.publish === true
       ) {
-        // Delete the latest history entry
         const latestHistory = await sequelize.models.AdSetHistory.findOne({
           where: { AdSetID: adSet.AdSetID },
-          order: [["timestamp", "DESC"]], // Get the latest history entry
+          order: [["timestamp", "DESC"]],
         });
 
         if (latestHistory) {
@@ -131,13 +273,12 @@ module.exports = (sequelize, DataTypes) => {
 
   AdSet.addHook("afterCreate", async (adSet, options) => {
     if (adSet.publish === false) {
-      // If publish is false on creation, save a snapshot to AdSetHistory
       await sequelize.models.AdSetHistory.create({
         AdSetID: adSet.AdSetID,
-        DataSnapshot: adSet.toJSON(), // Save the full AdSet data as JSON
+        DataSnapshot: adSet.toJSON(),
       });
     }
   });
-  
+
   return AdSet;
 };

package/models/AdsetPerformance.js

@@ -0,0 +1,106 @@
+module.exports = (sequelize, DataTypes) => {
+  const AdSetPerformance = sequelize.define(
+    "AdSetPerformance",
+    {
+      AdSetID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        primaryKey: true,
+        // Part of the composite primary key identifying the AdSet
+      },
+      Date: {
+        type: DataTypes.DATEONLY,
+        allowNull: false,
+        primaryKey: true,
+        // Part of the composite primary key representing the performance date
+      },
+      ChannelID: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        // Optional identifier for the channel, extracted from AdSet name if available
+      },
+      StyleID: {
+        type: DataTypes.STRING,
+        allowNull: true,
+        // Optional identifier for the style, extracted from AdSet name if available
+      },
+      Spend: {
+        type: DataTypes.FLOAT,
+        defaultValue: 0,
+        // Total spend on the AdSet from the source platform (e.g., Facebook)
+      },
+      Impressions: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of impressions recorded by the source platform
+      },
+      LinkClicks: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of link clicks recorded by the source platform
+      },
+      ViewContent: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of view content events recorded by the source platform
+      },
+      Search: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of search events recorded by the source platform
+      },
+      Purchase: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of purchase events recorded by the source platform
+      },
+      ExternalRevenue: {
+        type: DataTypes.FLOAT,
+        defaultValue: 0,
+        // Revenue data from an external source (e.g., analytics or monetization platforms)
+      },
+      ExternalImpressions: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of impressions recorded by an external source
+      },
+      ExternalClicks: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of clicks recorded by an external source
+      },
+      ExternalRequests: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        // Number of requests recorded by an external source
+      },
+      ROI: {
+        type: DataTypes.FLOAT,
+        defaultValue: 0,
+        // Calculated Return on Investment (ExternalRevenue / Spend)
+      },
+    },
+    {
+      tableName: "AdSetPerformance",
+      timestamps: false, // No need for createdAt/updatedAt timestamps
+      indexes: [
+        {
+          unique: true,
+          fields: ["AdSetID", "Date"],
+          // Composite unique index to ensure one record per AdSet per date
+        },
+      ],
+    }
+  );
+
+  // Define associations with other models
+  AdSetPerformance.associate = (models) => {
+    AdSetPerformance.belongsTo(models.AdSet, {
+      foreignKey: "AdSetID",
+      targetKey: "AdSetID",
+      // Links to the AdSet model for additional AdSet details
+    });
+  };
+
+  return AdSetPerformance;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agrs-sequelize-sdk",
-  "version": "1.1.59",
+  "version": "1.1.61",
   "main": "index.js",
   "scripts": {
     "start": "node index.js",