taboola-backstage-sdk 0.2.1 → 0.3.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
@@ -157,9 +165,19 @@ const item = await client.items.create('account-id', 'campaign-id', {
   cta: { cta_type: 'LEARN_MORE' },
 });
 
-// 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
@@ -518,6 +536,39 @@ const client = new TaboolaClient({
 
 For detailed API documentation, see the [Taboola Backstage API Reference](https://developers.taboola.com/backstage-api/reference).
 
+## Changelog
+
+### v0.3.0 (2024)
+
+**Enhanced Update Support** - Comprehensive updates for campaigns and items
+
+- **Campaign Updates**: Expanded `UpdateCampaignRequest` to support all updatable fields including:
+  - Geographic targeting (DMA, region, city, postal code, sub-country)
+  - Advanced targeting (contextual, browser, connection type, auto publisher)
+  - Bid modifiers (publisher bid modifiers and bid strategy modifiers)
+  - Audience targeting (marketplace, custom, lookalike, marking labels, contextual segments)
+  - Additional fields (pricing model, campaign profile, traffic allocation, external brand safety, verification pixels, viewability tags)
+
+- **Item Updates**: Expanded `UpdateItemRequest` to support both static items and motion ads:
+  - Static items: `url`, `thumbnail_url`, `verification_pixel`, `viewability_tag`, `creative_focus`
+  - Motion ads: New `PerformanceVideoData` type with `video_url` and `fallback_url`
+  - Enhanced documentation with examples for both item types
+
+- **Partial Updates**: Both endpoints properly support partial updates where only specified fields are modified
+- **Improved Documentation**: Added comprehensive JSDoc examples and better API alignment
+
+### v0.2.1 (2024)
+
+Minor bug fixes and documentation improvements.
+
+### v0.2.0 (2024)
+
+Added support for shared budgets, marking labels, and realtime report signatures.
+
+### v0.1.0 (2024)
+
+Initial release with core API support.
+
 ## License
 
 MIT

package/dist/index.cjs

@@ -519,15 +519,42 @@ var CampaignsAPI = class {
   /**
    * Update an existing campaign
    *
+   * Submit only the fields you want to update. Fields that are omitted or null
+   * will remain unchanged.
+   *
    * @param accountId - Account ID
    * @param campaignId - Campaign ID
-   * @param updates - Fields to update
+   * @param updates - Fields to update (partial)
    *
-   * @example
+   * @example Update a single field
    * ```typescript
    * const campaign = await client.campaigns.update('my-account', '12345', {
-   *   cpc: 0.75,
-   *   daily_cap: 500,
+   *   name: 'DemoCampaign - Edited',
+   * });
+   * ```
+   *
+   * @example Update multiple fields including targeting
+   * ```typescript
+   * const campaign = await client.campaigns.update('my-account', '12345', {
+   *   name: 'Demo Campaign - Edited Again',
+   *   branding_text: 'New branding text',
+   *   spending_limit: 10000,
+   *   spending_limit_model: 'ENTIRE',
+   *   country_targeting: {
+   *     type: 'INCLUDE',
+   *     value: ['AU', 'GB'],
+   *   },
+   *   platform_targeting: {
+   *     type: 'INCLUDE',
+   *     value: ['TBLT', 'PHON'],
+   *   },
+   * });
+   * ```
+   *
+   * @example Pause a campaign (alternatively, use pause() method)
+   * ```typescript
+   * const campaign = await client.campaigns.update('my-account', '12345', {
+   *   is_active: false,
    * });
    * ```
    */
@@ -772,20 +799,44 @@ var ItemsAPI = class {
     return this.http.post(`${accountId}/campaigns/${campaignId}/items/`, item);
   }
   /**
-   * Update an existing item
+   * Update an existing item (static or motion ad)
+   *
+   * Submit only the fields you want to update. Fields that are omitted or null
+   * will remain unchanged. The endpoint automatically detects the item type.
+   *
+   * Note: While status is CRAWLING, the Item is in a read-only state - no fields can be modified.
    *
    * @param accountId - Account ID
    * @param campaignId - Campaign ID
    * @param itemId - Item ID
-   * @param updates - Fields to update
+   * @param updates - Fields to update (partial)
    *
-   * @example
+   * @example Update a static item
    * ```typescript
    * const item = await client.items.update('my-account', '12345', '67890', {
    *   title: 'Updated Title!',
    *   is_active: true,
    * });
    * ```
+   *
+   * @example Update a motion ad
+   * ```typescript
+   * const item = await client.items.update('my-account', '12345', '67890', {
+   *   title: 'Updated Motion Ad Title',
+   *   description: 'New description',
+   *   performance_video_data: {
+   *     video_url: 'https://example.com/video.mp4',
+   *     fallback_url: 'https://example.com/fallback.jpg',
+   *   },
+   * });
+   * ```
+   *
+   * @example Pause an item (alternatively, use pause() method)
+   * ```typescript
+   * const item = await client.items.update('my-account', '12345', '67890', {
+   *   is_active: false,
+   * });
+   * ```
    */
   async update(accountId, campaignId, itemId, updates) {
     return this.http.post(