API Evangelist conversational phrasing for Google Ads Customers.batch Jobs API

# 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.batch Jobs API
  version: 1.0.0
extends: openapi/google-ads-customers-batchjobs-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: 4
- target: $.paths['/v25/customers/{customersId}/batchJobs/{batchJobsId}:run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a batch job
      effect: write
      questions:
      - How do I start processing a batch job once I've added operations?
      - Where do the results go after a batch job run finishes?
      instructions:
      - text: Run batch job {job} in account {customer}.
        slots:
          job: path.batchJobsId
          customer: path.customersId
      - text: Start executing all queued operations in batch job {job} for account {customer}.
        slots:
          job: path.batchJobsId
          customer: path.customersId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v25/customers/{customersId}/batchJobs/{batchJobsId}:addOperations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add operations to a batch job
      effect: write
      questions:
      - Can I keep appending changes to a batch job before running it?
      - What is the sequence token for when adding operations to a batch job?
      instructions:
      - text: Add operations {operations} to batch job {job} in account {customer}.
        slots:
          operations: requestBody.mutateOperations
          job: path.batchJobsId
          customer: path.customersId
      - text: Append {operations} to batch job {job} in account {customer} with sequence token {token}.
        slots:
          operations: requestBody.mutateOperations
          job: path.batchJobsId
          customer: path.customersId
          token: requestBody.sequenceToken
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v25/customers/{customersId}/batchJobs:mutate'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a batch job
      effect: write
      questions:
      - How do I create a new batch job for bulk changes?
      - Can I set up a batch job to process many account changes asynchronously?
      instructions:
      - text: Create a new batch job in account {customer}.
        slots:
          customer: path.customersId
      - text: Set up a batch job in account {customer} with operation {operation}.
        slots:
          customer: path.customersId
          operation: requestBody.operation
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v25/customers/{customersId}/batchJobs/{batchJobsId}:listResults'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of a finished batch job
      effect: read
      questions:
      - Which operations in my batch job succeeded or failed?
      - Can I page through batch job results once the job is done?
      instructions:
      - text: List the results of batch job {job} in account {customer}.
        slots:
          job: path.batchJobsId
          customer: path.customersId
      - text: Show {size} results at a time from batch job {job} in account {customer}.
        slots:
          size: query.pageSize
          job: path.batchJobsId
          customer: path.customersId
      method: generated
      generated: '2026-10-02'