Google Campaign Manager · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Google Campaign Manager Campaign Manager 360 Campaigns API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/userprofiles/{profileId}/campaigns'].get
$.paths['/userprofiles/{profileId}/campaigns'].post
$.paths['/userprofiles/{profileId}/campaigns/{campaignId}'].get
$.paths['/userprofiles/{profileId}/campaigns/{campaignId}'].put
$.paths['/userprofiles/{profileId}/campaigns/{campaignId}'].patch

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 Google Campaign Manager Campaign Manager 360 Campaigns API
  version: 1.0.0
extends: openapi/google-campaign-manager-campaigns-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: 5
- target: $.paths['/userprofiles/{profileId}/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List campaigns, optionally filtered
      effect: read
      questions:
      - Which campaigns does a particular advertiser have?
      - Can I hide archived campaigns when listing them?
      - What campaigns have a name containing a certain word?
      instructions:
      - text: List all campaigns for profile {profileId}.
        slots:
          profileId: path.profileId
      - text: Show campaigns for advertiser {advertiserIds} under profile {profileId}.
        slots:
          advertiserIds: query.advertiserIds
          profileId: path.profileId
      - text: Search campaigns matching {searchString} for profile {profileId} with archived set to {archived}.
        slots:
          searchString: query.searchString
          profileId: path.profileId
          archived: query.archived
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userprofiles/{profileId}/campaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a campaign for an advertiser
      effect: write
      questions:
      - How do I set up a new campaign for an advertiser with start and end dates?
      - Can I add a billing invoice code when I create a campaign?
      - What is required to launch a brand-new campaign in Campaign Manager 360?
      instructions:
      - text: Create campaign {name} for advertiser {advertiserId} from {startDate} to {endDate} under profile {profileId}.
        slots:
          name: requestBody.name
          advertiserId: requestBody.advertiserId
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          profileId: path.profileId
      - text: Start a new campaign {name} for advertiser {advertiserId} on profile {profileId} with invoice code {billingInvoiceCode}.
        slots:
          name: requestBody.name
          advertiserId: requestBody.advertiserId
          profileId: path.profileId
          billingInvoiceCode: requestBody.billingInvoiceCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userprofiles/{profileId}/campaigns/{campaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one campaign
      effect: read
      questions:
      - What are the flight dates and settings of a specific campaign?
      - Can I fetch one campaign's full configuration by its ID?
      instructions:
      - text: Show campaign {campaignId} for profile {profileId}.
        slots:
          campaignId: path.campaignId
          profileId: path.profileId
      - text: Get the details of campaign {campaignId} under profile {profileId}.
        slots:
          campaignId: path.campaignId
          profileId: path.profileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userprofiles/{profileId}/campaigns/{campaignId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a campaign's full configuration
      effect: write
      questions:
      - How do I resubmit a campaign with all its fields, knowing omitted ones reset to defaults?
      - Can I overwrite a campaign's entire setup in a single request?
      instructions:
      - text: 'Replace campaign {campaignId} on profile {profileId} with a full body: name {name}, advertiser {advertiserId}, {startDate} to {endDate}.'
        slots:
          campaignId: path.campaignId
          profileId: path.profileId
          name: requestBody.name
          advertiserId: requestBody.advertiserId
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Overwrite every writable field of campaign {campaignId} for profile {profileId}.
        slots:
          campaignId: path.campaignId
          profileId: path.profileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userprofiles/{profileId}/campaigns/{campaignId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change selected fields on a campaign
      effect: write
      questions:
      - Can I archive a campaign by changing only its archived flag?
      - How do I extend just a campaign's end date without resending the rest?
      instructions:
      - text: Set only the archived flag on campaign {campaignId} for profile {profileId} to {archived}.
        slots:
          campaignId: path.campaignId
          profileId: path.profileId
          archived: requestBody.archived
      - text: Just move the end date of campaign {campaignId} on profile {profileId} to {endDate}.
        slots:
          campaignId: path.campaignId
          profileId: path.profileId
          endDate: requestBody.endDate
      method: generated
      generated: '2026-10-01'