Facebook Business Manager · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Facebook Business Manager Facebook Marketing Ad Sets API

5 actions 5 updates phrasing extends openapi/facebook-business-manager-ad-sets-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Facebook Business Manager's API. It is a proposal applied on top of the contract, not a document Facebook Business Manager publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/act_{ad_account_id}/adsets'].get
$.paths['/act_{ad_account_id}/adsets'].post
$.paths['/{ad_set_id}'].get
$.paths['/{ad_set_id}'].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 Facebook Business Manager Facebook Marketing Ad Sets API
  version: 1.0.0
extends: openapi/facebook-business-manager-ad-sets-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/act_{ad_account_id}/adsets'].get
  update:
    x-apievangelist-phrasing:
      intent: List the ad sets in an ad account
      effect: read
      questions:
      - Which ad sets are in my ad account and what budgets do they have?
      - Can I see targeting and schedules for every ad set across the account at once?
      - What's the default page size when listing all ad sets?
      instructions:
      - text: List all ad sets in ad account {ad_account_id}.
        slots:
          ad_account_id: path.ad_account_id
      - text: Show the next page of ad sets in account {ad_account_id} after cursor {after}.
        slots:
          ad_account_id: path.ad_account_id
          after: query.after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/act_{ad_account_id}/adsets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an ad set with targeting and budget
      effect: write
      questions:
      - How do I set up a new ad set under an existing campaign?
      - Can a new ad set have a lifetime budget with start and end dates instead of a daily budget?
      - What must I specify for optimization goal and billing event when creating an ad set?
      instructions:
      - text: 'Create ad set {name} in campaign {campaign_id} on {ad_account_id}: goal {optimization_goal}, billing {billing_event}, targeting {targeting}, status {status}.'
        slots:
          ad_account_id: path.ad_account_id
          name: requestBody.name
          campaign_id: requestBody.campaign_id
          optimization_goal: requestBody.optimization_goal
          billing_event: requestBody.billing_event
          targeting: requestBody.targeting
          status: requestBody.status
      - text: Start a new ad set in campaign {campaign_id} with a daily budget of {daily_budget}, running from {start_time} to {end_time}.
        slots:
          campaign_id: requestBody.campaign_id
          daily_budget: requestBody.daily_budget
          start_time: requestBody.start_time
          end_time: requestBody.end_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{ad_set_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one ad set's targeting and budget
      effect: read
      questions:
      - What targeting and bid settings does this particular ad set use?
      - Can I check when one ad set is scheduled to end?
      instructions:
      - text: Show me ad set {ad_set_id}.
        slots:
          ad_set_id: path.ad_set_id
      - text: Get the {fields} of ad set {ad_set_id}.
        slots:
          ad_set_id: path.ad_set_id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{ad_set_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change an existing ad set's budget, targeting or status
      effect: write
      questions:
      - Can I raise the daily budget on an ad set that's already running?
      - How do I pause an existing ad set or move its end date?
      instructions:
      - text: Set the daily budget of ad set {ad_set_id} to {daily_budget}.
        slots:
          ad_set_id: path.ad_set_id
          daily_budget: requestBody.daily_budget
      - text: Change the status of existing ad set {ad_set_id} to {status}.
        slots:
          ad_set_id: path.ad_set_id
          status: requestBody.status
      - text: Update the targeting on ad set {ad_set_id} to {targeting} and end it at {end_time}.
        slots:
          ad_set_id: path.ad_set_id
          targeting: requestBody.targeting
          end_time: requestBody.end_time
      method: generated
      generated: '2026-10-01'