Taboola · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Taboola Backstage Campaigns API

7 actions 7 updates phrasing extends openapi/taboola-campaigns-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 7

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

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 Campaigns API
  version: 1.0.0
extends: openapi/taboola-campaigns-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: 6
- target: $.paths['/{account_id}/campaigns/'].get
  update:
    x-apievangelist-phrasing:
      intent: List all campaigns in an account
      effect: read
      questions:
      - How do I see all the campaigns in my advertiser account?
      - Can I list every campaign with its budget and status for one account?
      instructions:
      - text: List all campaigns in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show me every campaign under advertiser {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/campaigns/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new advertising campaign
      effect: write
      questions:
      - How do I launch a new campaign with a CPC bid and daily cap?
      - Can I set country and platform targeting when creating a campaign?
      - What do I need to set up a brand new campaign in Taboola?
      instructions:
      - text: Create a campaign named {name} in account {account_id} with a CPC of {cpc}.
        slots:
          name: requestBody.name
          cpc: requestBody.cpc
          account_id: path.account_id
      - text: Set up a new campaign {name} with branding text {branding_text} and a spending limit of {spending_limit}.
        slots:
          name: requestBody.name
          branding_text: requestBody.branding_text
          spending_limit: requestBody.spending_limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/campaigns/{campaign_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one campaign's settings
      effect: read
      questions:
      - How do I look up a single campaign by its ID?
      - Can I check how much a specific campaign has spent so far?
      instructions:
      - text: Get campaign {campaign_id} in account {account_id}.
        slots:
          account_id: path.account_id
          campaign_id: path.campaign_id
      - text: Show the targeting, bid and budget for campaign {campaign_id}.
        slots:
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/campaigns/{campaign_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing campaign
      effect: write
      questions:
      - How do I change the CPC bid on a campaign that's already running?
      - Can I pause an existing campaign by turning it inactive?
      - Which fields stay unchanged if I leave them out of a campaign update?
      instructions:
      - text: Change the CPC of existing campaign {campaign_id} in account {account_id} to {cpc}.
        slots:
          cpc: requestBody.cpc
          account_id: path.account_id
          campaign_id: path.campaign_id
      - text: Set the daily cap on campaign {campaign_id} to {daily_cap}.
        slots:
          daily_cap: requestBody.daily_cap
          campaign_id: path.campaign_id
      - text: Pause campaign {campaign_id} by setting is_active to {is_active}.
        slots:
          is_active: requestBody.is_active
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/campaigns/{campaign_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Terminate a campaign
      effect: destructive
      questions:
      - How do I permanently delete a campaign?
      - What happens to a campaign after it's marked terminated?
      instructions:
      - text: Delete campaign {campaign_id} from account {account_id}.
        slots:
          account_id: path.account_id
          campaign_id: path.campaign_id
      - text: Terminate campaign {campaign_id} for good.
        slots:
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/campaigns/{campaign_id}/duplicate'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate an existing campaign
      effect: write
      questions:
      - Can I copy an existing campaign instead of rebuilding it from scratch?
      - Is it possible to clone a campaign into a different advertiser account?
      instructions:
      - text: Duplicate campaign {campaign_id} in account {account_id}.
        slots:
          account_id: path.account_id
          campaign_id: path.campaign_id
      - text: Make a copy of campaign {campaign_id} with its settings.
        slots:
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-09-26'