Google Campaign Manager · OpenAPI Overlay 1.0.0

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

8 actions 8 updates phrasing extends openapi/google-campaign-manager-reports-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 8

$.info
$.paths['/userprofiles/{profileId}/reports'].get
$.paths['/userprofiles/{profileId}/reports'].post
$.paths['/userprofiles/{profileId}/reports/{reportId}'].get
$.paths['/userprofiles/{profileId}/reports/{reportId}'].put
$.paths['/userprofiles/{profileId}/reports/{reportId}'].delete
$.paths['/userprofiles/{profileId}/reports/{reportId}'].patch
$.paths['/userprofiles/{profileId}/reports/{reportId}/run'].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 Google Campaign Manager Campaign Manager 360 Reports API
  version: 1.0.0
extends: openapi/google-campaign-manager-reports-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: 7
- target: $.paths['/userprofiles/{profileId}/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved reports for a user profile
      effect: read
      questions:
      - Which reports have been set up under my Campaign Manager 360 profile?
      - Can I see the reports I own sorted by when they were last modified?
      - How do I page through more than 1000 saved reports?
      instructions:
      - text: List the reports saved under profile {profileId}.
        slots:
          profileId: path.profileId
      - text: Show the first {maxResults} reports for profile {profileId}, newest edits first.
        slots:
          maxResults: query.maxResults
          profileId: path.profileId
      - text: List reports for profile {profileId} limited to scope {scope}.
        slots:
          profileId: path.profileId
          scope: query.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userprofiles/{profileId}/reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new report definition
      effect: write
      questions:
      - How do I build a new delivery report with my own dimensions and metrics?
      - Can a newly created report be scheduled to run and be emailed automatically?
      - What report types and output formats can I choose when setting up a report?
      instructions:
      - text: Create a new report named {name} under profile {profileId}.
        slots:
          name: requestBody.name
          profileId: path.profileId
      - text: Set up a new {type} report called {name} in {format} format for profile {profileId}.
        slots:
          type: requestBody.type
          name: requestBody.name
          format: requestBody.format
          profileId: path.profileId
      - text: Create report {name} for profile {profileId} with delivery schedule {schedule}.
        slots:
          name: requestBody.name
          profileId: path.profileId
          schedule: requestBody.schedule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userprofiles/{profileId}/reports/{reportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one report's definition
      effect: read
      questions:
      - What dimensions, metrics and date range does a specific saved report use?
      - Can I check the schedule and delivery settings of one report by its ID?
      instructions:
      - text: Show me the definition of report {reportId} under profile {profileId}.
        slots:
          reportId: path.reportId
          profileId: path.profileId
      - text: Fetch report {reportId} for profile {profileId} so I can see its criteria.
        slots:
          reportId: path.reportId
          profileId: path.profileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userprofiles/{profileId}/reports/{reportId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a report's full definition
      effect: write
      questions:
      - How do I overwrite an existing report with a completely new configuration?
      - Can I resend the whole report body to swap its type, criteria and schedule at once?
      instructions:
      - text: Replace the full definition of report {reportId} on profile {profileId} with criteria {criteria}.
        slots:
          reportId: path.reportId
          profileId: path.profileId
          criteria: requestBody.criteria
      - text: Overwrite report {reportId} for profile {profileId} with a complete new body named {name}.
        slots:
          reportId: path.reportId
          profileId: path.profileId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userprofiles/{profileId}/reports/{reportId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved report
      effect: destructive
      questions:
      - How do I remove a report I no longer need from my profile?
      - Is deleting a saved report permanent?
      instructions:
      - text: Delete report {reportId} from profile {profileId}.
        slots:
          reportId: path.reportId
          profileId: path.profileId
      - text: Remove the old report {reportId} under profile {profileId} for good.
        slots:
          reportId: path.reportId
          profileId: path.profileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userprofiles/{profileId}/reports/{reportId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change selected fields on a report
      effect: write
      questions:
      - Can I rename a report without resending its whole configuration?
      - How do I change just the delivery schedule on a report I already created?
      instructions:
      - text: Rename report {reportId} on profile {profileId} to {name}, leaving everything else as is.
        slots:
          reportId: path.reportId
          profileId: path.profileId
          name: requestBody.name
      - text: Only change the schedule of report {reportId} for profile {profileId} to {schedule}.
        slots:
          reportId: path.reportId
          profileId: path.profileId
          schedule: requestBody.schedule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userprofiles/{profileId}/reports/{reportId}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a report to generate a file
      effect: write
      questions:
      - How do I kick off a report so it produces a fresh downloadable file?
      - Can a report run synchronously instead of in the background?
      - Where do I check whether a report run has finished?
      instructions:
      - text: Run report {reportId} for profile {profileId} now.
        slots:
          reportId: path.reportId
          profileId: path.profileId
      - text: Execute report {reportId} on profile {profileId} with synchronous set to {synchronous}.
        slots:
          reportId: path.reportId
          profileId: path.profileId
          synchronous: query.synchronous
      method: generated
      generated: '2026-10-01'