Taboola · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Taboola Backstage Campaign Items API

6 actions 6 updates phrasing extends openapi/taboola-campaign-items-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Taboola's API. It is a proposal applied on top of the contract, not a document Taboola publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/{account_id}/campaigns/{campaign_id}/items/'].get
$.paths['/{account_id}/campaigns/{campaign_id}/items/'].post
$.paths['/{account_id}/campaigns/{campaign_id}/items/{item_id}'].get
$.paths['/{account_id}/campaigns/{campaign_id}/items/{item_id}'].post
$.paths['/{account_id}/campaigns/{campaign_id}/items/{item_id}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Taboola Backstage Campaign Items API
  version: 1.0.0
extends: openapi/taboola-campaign-items-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/{account_id}/campaigns/{campaign_id}/items/'].get
  update:
    x-apievangelist-phrasing:
      intent: List the items in a campaign
      effect: read
      questions:
      - How do I see all the ads running in one campaign?
      - Can I list every item in a campaign along with its approval state?
      instructions:
      - text: List all items in campaign {campaign_id} for account {account_id}.
        slots:
          account_id: path.account_id
          campaign_id: path.campaign_id
      - text: Show every ad under campaign {campaign_id}.
        slots:
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/campaigns/{campaign_id}/items/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new ad item to a campaign
      effect: write
      questions:
      - How do I add a new ad with a landing page URL to a campaign?
      - Can I set the title and thumbnail when I create a new item?
      instructions:
      - text: Create a new item in campaign {campaign_id} pointing to {url}.
        slots:
          url: requestBody.url
          campaign_id: path.campaign_id
      - text: Add an ad titled {title} with thumbnail {thumbnail_url} to campaign {campaign_id} in account {account_id}.
        slots:
          title: requestBody.title
          thumbnail_url: requestBody.thumbnail_url
          account_id: path.account_id
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/campaigns/{campaign_id}/items/{item_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one item from a campaign
      effect: read
      questions:
      - How do I look up a single ad item by its ID?
      - Can I check whether one specific item was approved?
      instructions:
      - text: Get item {item_id} from campaign {campaign_id} in account {account_id}.
        slots:
          item_id: path.item_id
          account_id: path.account_id
          campaign_id: path.campaign_id
      - text: Show the status and approval state of item {item_id} in campaign {campaign_id}.
        slots:
          item_id: path.item_id
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/campaigns/{campaign_id}/items/{item_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing campaign item
      effect: write
      questions:
      - How do I change the headline of an ad that's already live?
      - Can I pause a single existing item by changing its status?
      instructions:
      - text: Change the title of existing item {item_id} in campaign {campaign_id} to {title}.
        slots:
          item_id: path.item_id
          title: requestBody.title
          campaign_id: path.campaign_id
      - text: Set the status of item {item_id} in campaign {campaign_id} of account {account_id} to {status}.
        slots:
          item_id: path.item_id
          status: requestBody.status
          account_id: path.account_id
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/campaigns/{campaign_id}/items/{item_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an item from a campaign
      effect: destructive
      questions:
      - How do I remove one ad from a campaign for good?
      - What happens when I delete a single campaign item?
      instructions:
      - text: Delete item {item_id} from campaign {campaign_id} in account {account_id}.
        slots:
          item_id: path.item_id
          account_id: path.account_id
          campaign_id: path.campaign_id
      - text: Remove ad {item_id} from campaign {campaign_id}.
        slots:
          item_id: path.item_id
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-09-26'