taboola-backstage-sdk 0.2.1 → 0.6.0

package/README.md

@@ -5,7 +5,7 @@
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
 [![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
 
-A comprehensive TypeScript SDK for the [Taboola Backstage API](https://developers.taboola.com/backstage-api/reference). Manage campaigns, ads, targeting, audiences, pixel tracking, and reporting programmatically.
+A comprehensive TypeScript SDK for the [Taboola Backstage API](https://developers.taboola.com/backstage-api/reference). Manage campaigns, ads, targeting, audiences, pixel tracking, and reporting programmatically with full type safety.
 
 ## Features
 
@@ -108,10 +108,18 @@ const campaign = await client.campaigns.create('account-id', {
   marketing_objective: 'DRIVE_WEBSITE_TRAFFIC',
 });
 
-// Update campaign
+// Update campaign (partial updates - only specified fields are changed)
 await client.campaigns.update('account-id', 'campaign-id', {
   cpc: 0.75,
   daily_cap: 500,
+  country_targeting: {
+    type: 'INCLUDE',
+    value: ['US', 'CA', 'GB'],
+  },
+  platform_targeting: {
+    type: 'INCLUDE',
+    value: ['DESK', 'PHON'],
+  },
 });
 
 // Pause / Unpause
@@ -148,18 +156,25 @@ const { results } = await client.items.list('account-id', 'campaign-id');
 // Get single item
 const item = await client.items.get('account-id', 'campaign-id', 'item-id');
 
-// Create item
+// Create item (static ad - only url accepted, starts in CRAWLING state)
 const item = await client.items.create('account-id', 'campaign-id', {
   url: 'https://example.com/landing',
-  title: 'Amazing Product - Learn More',
-  thumbnail_url: 'https://example.com/image.jpg',
-  description: 'Discover our latest offering',
-  cta: { cta_type: 'LEARN_MORE' },
 });
+// Poll until item.status changes from CRAWLING to RUNNING, then update fields
 
-// Update item
+// Update item (static or motion ad - partial updates supported)
 await client.items.update('account-id', 'campaign-id', 'item-id', {
   title: 'Updated Title',
+  url: 'https://example.com/new-landing-page',
+});
+
+// Update motion ad with video
+await client.items.update('account-id', 'campaign-id', 'motion-ad-id', {
+  title: 'Updated Motion Ad',
+  performance_video_data: {
+    video_url: 'https://example.com/video.mp4',
+    fallback_url: 'https://example.com/fallback.jpg',
+  },
 });
 
 // Pause / Unpause
@@ -169,7 +184,7 @@ await client.items.unpause('account-id', 'campaign-id', 'item-id');
 // Delete
 await client.items.delete('account-id', 'campaign-id', 'item-id');
 
-// Bulk create
+// Bulk create (supports both static and motion ads with full field set)
 const { results } = await client.items.bulkCreate('account-id', 'campaign-id', {
   items: [
     { url: 'https://example.com/1', title: 'Title 1', thumbnail_url: '...' },
@@ -233,20 +248,20 @@ const rules = await client.pixel.listConversionRules('account-id');
 // Get single conversion rule
 const rule = await client.pixel.getConversionRule('account-id', 'rule-id');
 
-// Create conversion rule
+// Create conversion rule (URL-based)
 const rule = await client.pixel.createConversionRule('account-id', {
   display_name: 'Purchase Completed',
-  type: 'EVENT_BASED',
-  category: 'PURCHASE',
-  event_name: 'purchase',
-  conditions: [],
-  effect: {
-    type: 'DYNAMIC_VALUE',
-    currency: 'USD',
-    value_parameter: 'order_total',
+  type: 'BASIC',
+  category: 'MAKE_PURCHASE',
+  condition: {
+    property: 'URL',
+    predicate: 'CONTAINS',
+    value: '/thank-you',
+    children: [],
   },
-  conversion_window_days: 30,
-  view_through_window_days: 1,
+  effects: [{ type: 'REVENUE', data: '15' }],
+  look_back_window: 30,
+  view_through_look_back_window: 1,
 });
 
 // Archive / Unarchive
@@ -473,6 +488,7 @@ import type {
   CreateCampaignRequest,
   UpdateCampaignRequest,
   CreateItemRequest,
+  BulkCreateItemData,
   CreateSharedBudgetRequest,
 
   // Report types