Google Sheets API — Spreadsheets

naftiko: 1.0.0-alpha2
info:
  label: Google Sheets API — Spreadsheets
  description: 'Google Sheets API — Spreadsheets. 4 operations. Lead operation: Google Sheets Create a Spreadsheet. Self-contained
    Naftiko capability covering one Google Sheets business surface.'
  tags:
  - Google Sheets
  - Spreadsheets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GOOGLE_SHEETS_API_KEY: GOOGLE_SHEETS_API_KEY
capability:
  consumes:
  - type: http
    namespace: google-sheets-spreadsheets
    baseUri: https://sheets.googleapis.com/v4
    description: Google Sheets API — Spreadsheets business capability. Self-contained, no shared references.
    resources:
    - name: spreadsheets
      path: /spreadsheets
      operations:
      - name: createspreadsheet
        method: POST
        description: Google Sheets Create a Spreadsheet
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: spreadsheets-spreadsheetId
      path: /spreadsheets/{spreadsheetId}
      operations:
      - name: getspreadsheet
        method: GET
        description: Google Sheets Get a Spreadsheet
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ranges
          in: query
          type: array
          description: The ranges to retrieve from the spreadsheet.
        - name: includeGridData
          in: query
          type: boolean
          description: True if grid data should be returned. This parameter is ignored if a field mask was set in the request.
    - name: spreadsheets-spreadsheetId}:batchUpdate
      path: /spreadsheets/{spreadsheetId}:batchUpdate
      operations:
      - name: batchupdatespreadsheet
        method: POST
        description: Google Sheets Batch Update a Spreadsheet
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: spreadsheets-spreadsheetId}:getByDataFilter
      path: /spreadsheets/{spreadsheetId}:getByDataFilter
      operations:
      - name: getspreadsheetbydatafilter
        method: POST
        description: Google Sheets Get a Spreadsheet by Data Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.GOOGLE_SHEETS_API_KEY}}'
  exposes:
  - type: rest
    namespace: google-sheets-spreadsheets-rest
    port: 8080
    description: REST adapter for Google Sheets API — Spreadsheets. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/spreadsheets
      name: spreadsheets
      description: REST surface for spreadsheets.
      operations:
      - method: POST
        name: createspreadsheet
        description: Google Sheets Create a Spreadsheet
        call: google-sheets-spreadsheets.createspreadsheet
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/spreadsheets/{spreadsheetid}
      name: spreadsheets-spreadsheetid
      description: REST surface for spreadsheets-spreadsheetId.
      operations:
      - method: GET
        name: getspreadsheet
        description: Google Sheets Get a Spreadsheet
        call: google-sheets-spreadsheets.getspreadsheet
        with:
          ranges: rest.ranges
          includeGridData: rest.includeGridData
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/spreadsheets/spreadsheetid-batchupdate
      name: spreadsheets-spreadsheetid-batchupdate
      description: REST surface for spreadsheets-spreadsheetId}:batchUpdate.
      operations:
      - method: POST
        name: batchupdatespreadsheet
        description: Google Sheets Batch Update a Spreadsheet
        call: google-sheets-spreadsheets.batchupdatespreadsheet
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/spreadsheets/spreadsheetid-getbydatafilter
      name: spreadsheets-spreadsheetid-getbydatafilter
      description: REST surface for spreadsheets-spreadsheetId}:getByDataFilter.
      operations:
      - method: POST
        name: getspreadsheetbydatafilter
        description: Google Sheets Get a Spreadsheet by Data Filter
        call: google-sheets-spreadsheets.getspreadsheetbydatafilter
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: google-sheets-spreadsheets-mcp
    port: 9090
    transport: http
    description: MCP adapter for Google Sheets API — Spreadsheets. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: google-sheets-create-spreadsheet
      description: Google Sheets Create a Spreadsheet
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: google-sheets-spreadsheets.createspreadsheet
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: google-sheets-get-spreadsheet
      description: Google Sheets Get a Spreadsheet
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: google-sheets-spreadsheets.getspreadsheet
      with:
        ranges: tools.ranges
        includeGridData: tools.includeGridData
      outputParameters:
      - type: object
        mapping: $.
    - name: google-sheets-batch-update-spreadsheet
      description: Google Sheets Batch Update a Spreadsheet
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: google-sheets-spreadsheets.batchupdatespreadsheet
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: google-sheets-get-spreadsheet-data
      description: Google Sheets Get a Spreadsheet by Data Filter
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: google-sheets-spreadsheets.getspreadsheetbydatafilter
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.