Google Batch API

openapi: 3.2.0
info:
  title: Google Batch API
  version: 1.0.0
  description: 'Operations tagged Batch across 2 of this provider''s published API definitions: google-gmail-api-openapi.yml, google-sheets-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://gmail.googleapis.com
  description: Google Gmail API Server
- url: https://sheets.googleapis.com
  description: Google Sheets API Server
security:
- oauth2Auth: []
tags:
- name: Batch
  description: Operations related to Batch
paths:
  /gmail/v1/users/{userId}/messages/batchDelete:
    post:
      tags:
      - Batch
      summary: Google Batch Delete
      description: Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all.
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: '{{userID}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UsersMessagesBatchDeletePostRequest'
      responses:
        '204':
          description: No Content
          content:
            text/plain:
              schema:
                type: string
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SuccessExample
    servers:
    - url: https://gmail.googleapis.com
      description: Google Gmail API Server
  /gmail/v1/users/{userId}/messages/batchModify:
    post:
      tags:
      - Batch
      summary: Google Batch Modify
      description: Modifies the labels on the specified messages.
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UsersMessagesBatchModifyPostRequest'
      responses:
        '204':
          description: No Content
          content:
            text/plain:
              schema:
                type: string
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SuccessExample
    servers:
    - url: https://gmail.googleapis.com
      description: Google Gmail API Server
  /v4/spreadsheets/{spreadsheetId}/values:batchClear:
    post:
      tags:
      - Batch
      summary: Google Batch Clear Values
      description: Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges. Only values are cleared -- all other properties of the cell (such as formatting and data validation) are kept.
      security:
      - oauth2Auth: []
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: spreadsheetId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: '{{spreadsheetId}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpreadsheetsValuesbatchClearPostRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpreadsheetsValuesbatchClearPostResponse'
              examples:
                SpreadsheetsValuesbatchClearPostResponseExample:
                  $ref: '#/components/examples/SpreadsheetsValuesbatchClearPostResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SpreadsheetsValuesbatchClearPostResponseExample
    servers:
    - url: https://sheets.googleapis.com
      description: Google Sheets API Server
  /v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter:
    post:
      tags:
      - Batch
      summary: Google Batch Clear Values by Data Filter
      description: Clears one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more DataFilters. Ranges matching any of the specified data filters will be cleared. Only values are cleared -- all other properties of the cell (such as formatting, data validation, etc..) are kept.
      security:
      - oauth2Auth: []
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: spreadsheetId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: '{{spreadsheetId}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpreadsheetsValuesbatchClearByDataFilterPostRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpreadsheetsValuesbatchClearByDataFilterPostResponse'
              examples:
                SpreadsheetsValuesbatchClearByDataFilterPostResponseExample:
                  $ref: '#/components/examples/SpreadsheetsValuesbatchClearByDataFilterPostResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SpreadsheetsValuesbatchClearByDataFilterPostResponseExample
    servers:
    - url: https://sheets.googleapis.com
      description: Google Sheets API Server
  /v4/spreadsheets/{spreadsheetId}/values:batchGet:
    get:
      tags:
      - Batch
      summary: Google Get Values Batch
      description: Returns one or more ranges of values from a spreadsheet. The caller must specify the spreadsheet ID and one or more ranges.
      security:
      - oauth2Auth: []
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: spreadsheetId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: '{{spreadsheetId}}'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpreadsheetsValuesbatchGetGetResponse'
              examples:
                SpreadsheetsValuesbatchGetGetResponseExample:
                  $ref: '#/components/examples/SpreadsheetsValuesbatchGetGetResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SpreadsheetsValuesbatchGetGetResponseExample
    servers:
    - url: https://sheets.googleapis.com
      description: Google Sheets API Server
  /v4/spreadsheets/{spreadsheetId}/values:batchUpdate:
    post:
      tags:
      - Batch
      summary: Google Batch Update Values
      description: Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more ValueRanges.
      security:
      - oauth2Auth: []
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: spreadsheetId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: '{{spreadsheetId}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpreadsheetsValuesbatchUpdatePostRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpreadsheetsValuesbatchUpdatePostResponse'
              examples:
                SpreadsheetsValuesbatchUpdatePostResponseExample:
                  $ref: '#/components/examples/SpreadsheetsValuesbatchUpdatePostResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SpreadsheetsValuesbatchUpdatePostResponseExample
    servers:
    - url: https://sheets.googleapis.com
      description: Google Sheets API Server
  /v4/spreadsheets/{spreadsheetId}:batchUpdate:
    post:
      tags:
      - Batch
      summary: Google Batch Update Sheets
      description: Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order. Due to the collaborative nature of spreadsheets, it is not guaranteed that the spreadsheet will reflect exactly your changes after this completes, however it is guaranteed that the updates in the request will be applied together atomically. Your changes may be altered with respect to collaborator changes. If there are no collaborators, the spreadsheet should reflect your changes.
      security:
      - oauth2Auth: []
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: spreadsheetId
        in: path
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpreadsheetsPostRequest1'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpreadsheetsPostResponse1'
              examples:
                SpreadsheetsPostResponse1Example:
                  $ref: '#/components/examples/SpreadsheetsPostResponse1Example'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SpreadsheetsPostResponse1Example
    servers:
    - url: https://sheets.googleapis.com
      description: Google Sheets API Server
components:
  schemas:
    UsersMessagesBatchDeletePostRequest:
      description: UsersMessagesBatchDeletePostRequest schema
      type: object
      example:
        ids:
        - labore conseq
        - sit
    UsersMessagesBatchModifyPostRequest:
      description: UsersMessagesBatchModifyPostRequest schema
      type: object
      example:
        ids:
        - ullamco aliqua anim dolo
        - irure ea
        addLabelIds:
        - irure Lorem ex proident
        - 'proident '
        removeLabelIds:
        - do anim ad nulla
        - minim irure
    SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersTopColorStyleRgbColor:
      description: SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersTopColorStyleRgbColor schema
      type: object
      properties:
        alpha:
          type: number
        blue:
          type: number
        green:
          type: number
        red:
          type: number
    SpreadsheetsValuesbatchGetGetResponse:
      description: SpreadsheetsValuesbatchGetGetResponse schema
      type: object
    SpreadsheetsValuesbatchClearPostResponse:
      description: SpreadsheetsValuesbatchClearPostResponse schema
      type: object
      properties:
        clearedRanges:
          type: array
          items:
            type: string
        spreadsheetId:
          type: string
    SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersBottomColorStyle:
      description: SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersBottomColorStyle schema
      type: object
      properties:
        rgbColor:
          $ref: '#/components/schemas/SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersBottomColorStyleRgbColor'
        themeColor:
          type: string
    SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatTextFormatForegroundColor:
      description: SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatTextFormatForegroundColor schema
      type: object
      properties:
        alpha:
          type: number
        blue:
          type: number
        green:
          type: number
        red:
          type: number
    SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatTextFormat:
      description: SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatTextFormat schema
      type: object
      properties:
        bold:
          type: boolean
        fontFamily:
          type: string
        fontSize:
          type: integer
        foregroundColor:
          $ref: '#/components/schemas/SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatTextFormatForegroundColor'
        foregroundColorStyle:
          $ref: '#/components/schemas/SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatTextFormatForegroundColorStyle'
        italic:
          type: boolean
        link:
          $ref: '#/components/schemas/SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatTextFormatLink'
        strikethrough:
          type: boolean
        underline:
          type: boolean
    SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBorders:
      description: SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBorders schema
      type: object
      properties:
        bottom:
          $ref: '#/components/schemas/SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersBottom'
        left:
          $ref: '#/components/schemas/SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersLeft'
        right:
          $ref: '#/components/schemas/SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersRight'
        top:
          $ref: '#/components/schemas/SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersTop'
    SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatTextFormatForegroundColorStyle:
      description: SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatTextFormatForegroundColorStyle schema
      type: object
      properties:
        rgbColor:
          $ref: '#/components/schemas/SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatTextFormatForegroundColorStyleRgbColor'
        themeColor:
          type: string
    SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersTopColorStyle:
      description: SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersTopColorStyle schema
      type: object
      properties:
        rgbColor:
          $ref: '#/components/schemas/SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersTopColorStyleRgbColor'
        themeColor:
          type: string
    SpreadsheetsPostResponse1UpdatedSpreadsheet:
      description: SpreadsheetsPostResponse1UpdatedSpreadsheet schema
      type: object
      properties:
        dataSourceSchedules:
          type: array
          items:
            type: object
            properties:
              dailySchedule:
                type: object
                properties:
                  startTime:
                    type: object
                    properties:
                      hours:
                        type: integer
                      minutes:
                        type: integer
                      nanos:
                        type: integer
                      seconds:
                        type: integer
              enabled:
                type: boolean
              monthlySchedule:
                type: object
                properties:
                  daysOfMonth:
                    type: array
                    items:
                      type: integer
                  startTime:
                    type: object
                    properties:
                      hours:
                        type: integer
                      minutes:
                        type: integer
                      nanos:
                        type: integer
                      seconds:
                        type: integer
              nextRun:
                type: object
                properties:
                  endTime:
                    type: string
                  startTime:
                    type: string
              refreshScope:
                type: string
              weeklySchedule:
                type: object
                properties:
                  daysOfWeek:
                    type: array
                    items:
                      type: string
                  startTime:
                    type: object
                    properties:
                      hours:
                        type: integer
                      minutes:
                        type: integer
                      nanos:
                        type: integer
                      seconds:
                        type: integer
        dataSources:
          type: array
          items:
            type: object
            properties:
              calculatedColumns:
                type: array
                items:
                  type: object
                  properties:
                    formula:
                      type: string
                    reference:
                      type: object
                      properties:
                        name:
                          type: string
              dataSourceId:
                type: string
              sheetId:
                type: integer
              spec:
                type: object
                properties:
                  bigQuery:
                    type: object
                    properties:
                      projectId:
                        type: string
                      querySpec:
                        type: object
                        properties:
                          rawQuery:
                            type: string
                      tableSpec:
                        type: object
                        properties:
                          datasetId:
                            type: string
                          tableId:
                            type: string
                          tableProjectId:
                            type: string
                  parameters:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        namedRangeId:
                          type: string
                        range:
                          type: object
                          properties:
                            endColumnIndex:
                              type: integer
                            endRowIndex:
                              type: integer
                            sheetId:
                              type: integer
                            startColumnIndex:
                              type: integer
                            startRowIndex:
                              type: integer
        developerMetadata:
          type: array
          items:
            type: object
            properties:
              location:
                type: object
                properties:
                  dimensionRange:
                    type: object
                    properties:
                      dimension:
                        type: string
                      endIndex:
                        type: integer
                      sheetId:
                        type: integer
                      startIndex:
                        type: integer
                  locationType:
                    type: string
                  sheetId:
                    type: integer
                  spreadsheet:
                    type: boolean
              metadataId:
                type: integer
              metadataKey:
                type: string
              metadataValue:
                type: string
              visibility:
                type: string
        namedRanges:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              namedRangeId:
                type: string
              range:
                type: object
                properties:
                  endColumnIndex:
                    type: integer
                  endRowIndex:
                    type: integer
                  sheetId:
                    type: integer
                  startColumnIndex:
                    type: integer
                  startRowIndex:
                    type: integer
        properties:
          $ref: '#/components/schemas/SpreadsheetsPostResponse1UpdatedSpreadsheetProperties'
        sheets:
          type: array
          items:
            type: object
            properties:
              bandedRanges:
                type: array
                items:
                  type: object
                  properties:
                    bandedRangeId:
                      type: integer
                    columnProperties:
                      type: object
                      properties:
                        firstBandColor:
                          type: object
                          properties:
                            alpha:
                              type: number
                            blue:
                              type: number
                            green:
                              type: number
                            red:
                              type: number
                        firstBandColorStyle:
                          type: object
                          properties:
                            rgbColor:
                              type: object
                              properties:
                                alpha:
                                  type: number
                                blue:
                                  type: number
                                green:
                                  type: number
                                red:
                                  type: number
                            themeColor:
                              type: string
                        footerColor:
                          type: object
                          properties:
                            alpha:
                              type: number
                            blue:
                              type: number
                            green:
                              type: number
                            red:
                              type: number
                        footerColorStyle:
                          type: object
                          properties:
                            rgbColor:
                              type: object
                              properties:
                                alpha:
                                  type: number
                                blue:
                                  type: number
                                green:
                                  type: number
                                red:
                                  type: number
                            themeColor:
                              type: string
                        headerColor:
                          type: object
                          properties:
                            alpha:
                              type: number
                            blue:
                              type: number
                            green:
                              type: number
                            red:
                              type: number
                        headerColorStyle:
                          type: object
                          properties:
                            rgbColor:
                              type: object
                              properties:
                                alpha:
                                  type: number
                                blue:
                                  type: number
                                green:
                                  type: number
                                red:
                                  type: number
                            themeColor:
                              type: string
                        secondBandColor:
                          type: object
                          properties:
                            alpha:
                              type: number
                            blue:
                              type: number
                            green:
                              type: number
                            red:
                              type: number
                        secondBandColorStyle:
                          type: object
                          properties:
                            rgbColor:
                              type: object
                              properties:
                                alpha:
                                  type: number
                                blue:
                                  type: number
                                green:
                                  type: number
                                red:
                                  type: number
                            themeColor:
                              type: string
                    range:
                      type: object
                      properties:
                        endColumnIndex:
                          type: integer
                        endRowIndex:
                          type: integer
                        sheetId:
                          type: integer
                        startColumnIndex:
                          type: integer
                        startRowIndex:
                          type: integer
                    rowProperties:
                      type: object
                      properties:
                        firstBandColor:
                          type: object
                          properties:
                            alpha:
                              type: number
                            blue:
                              type: number
                            green:
                              type: number
                            red:
                              type: number
                        firstBandColorStyle:
                          type: object
                          properties:
                            rgbColor:
                              type: object
                              properties:
                                alpha:
                                  type: number
                                blue:
                                  type: number
                                green:
                                  type: number
                                red:
                                  type: number
                            themeColor:
                              type: string
                        footerColor:
                          type: object
                          properties:
                            alpha:
                              type: number
                            blue:
                              type: number
                            green:
                              type: number
                            red:
                              type: number
                        footerColorStyle:
                          type: object
                          properties:
                            rgbColor:
                              type: object
                              properties:
                                alpha:
                                  type: number
                                blue:
                                  type: number
                                green:
                                  type: number
                                red:
                                  type: number
                            themeColor:
                              type: string
                        headerColor:
                          type: object
                          properties:
                            alpha:
                              type: number
                            blue:
                              type: number
                            green:
                              type: number
                            red:
                              type: number
                        headerColorStyle:
                          type: object
                          properties:
                            rgbColor:
                              type: object
                              properties:
                                alpha:
                                  type: number
                                blue:
                                  type: number
                                green:
                                  type: number
                                red:
                                  type: number
                            themeColor:
                              type: string
                        secondBandColor:
                          type: object
                          properties:
                            alpha:
                              type: number
                            blue:
                              type: number
                            green:
                              type: number
                            red:
                              type: number
                        secondBandColorStyle:
                          type: object
                          properties:
                            rgbColor:
                              type: object
                              properties:
                                alpha:
                                  type: number
                                blue:
                                  type: number
                                green:
                               

# --- truncated at 32 KB (1043 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/google/refs/heads/main/openapi/google-batch-api-openapi.yml