Google Ads · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Google Ads Customers.operations API

6 actions 6 updates phrasing extends openapi/google-ads-customers-operations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Google Ads's API. It is a proposal applied on top of the contract, not a document Google Ads publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v25/customers/{customersId}/operations/{operationsId}'].get

$.paths['/v25/customers/{customersId}/operations/{operationsId}'].delete

$.paths['/v25/customers/{customersId}/operations'].get

$.paths['/v25/customers/{customersId}/operations/{operationsId}:cancel'].post

$.paths['/v25/customers/{customersId}/operations/{operationsId}:wait'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Google Ads Customers.operations API
  version: 1.0.0
extends: openapi/google-ads-customers-operations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v25/customers/{customersId}/operations/{operationsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a long-running operation's state
      effect: read
      questions:
      - Is my long-running operation done yet?
      - What's the latest result of a batch or experiment operation I started?
      instructions:
      - text: Get the latest state of operation {operation} in account {customer}.
        slots:
          operation: path.operationsId
          customer: path.customersId
      - text: Poll operation {operation} in account {customer} and tell me if it has finished.
        slots:
          operation: path.operationsId
          customer: path.customersId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v25/customers/{customersId}/operations/{operationsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a long-running operation record
      effect: destructive
      questions:
      - Can I discard an operation I no longer care about?
      - Does deleting an operation also cancel the work it's doing?
      instructions:
      - text: Delete operation {operation} in account {customer}; I no longer need its result.
        slots:
          operation: path.operationsId
          customer: path.customersId
      - text: Remove the record of long-running operation {operation} from account {customer}.
        slots:
          operation: path.operationsId
          customer: path.customersId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v25/customers/{customersId}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List long-running operations
      effect: read
      questions:
      - Which long-running operations exist for my account?
      - Can I filter the operations list or page through it?
      instructions:
      - text: List long-running operations in account {customer}.
        slots:
          customer: path.customersId
      - text: List operations in account {customer} matching filter {filter}.
        slots:
          customer: path.customersId
          filter: query.filter
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v25/customers/{customersId}/operations/{operationsId}:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a long-running operation
      effect: destructive
      questions:
      - How do I cancel a long-running operation that's still in progress?
      - Is cancelling an operation guaranteed to stop it?
      instructions:
      - text: Cancel operation {operation} in account {customer}.
        slots:
          operation: path.operationsId
          customer: path.customersId
      - text: Try to stop the in-progress operation {operation} in account {customer}.
        slots:
          operation: path.operationsId
          customer: path.customersId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v25/customers/{customersId}/operations/{operationsId}:wait'].post
  update:
    x-apievangelist-phrasing:
      intent: Wait for a long-running operation to finish
      effect: read
      questions:
      - Can I block until an operation completes instead of polling it?
      - What happens if I set a wait timeout longer than the request deadline?
      instructions:
      - text: Wait for operation {operation} in account {customer} to finish.
        slots:
          operation: path.operationsId
          customer: path.customersId
      - text: Wait up to {timeout} for operation {operation} in account {customer} and return its latest state.
        slots:
          timeout: requestBody.timeout
          operation: path.operationsId
          customer: path.customersId
      method: generated
      generated: '2026-10-02'