Google Update API

Operations related to Update

OpenAPI Specification

google-update-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Google Books About Update API
  description: API for retrieving Bookshelf and Volume resources from Google Books
  version: 1.0.0
  contact:
    name: Google Books API
    url: https://developers.google.com/books
servers:
- url: https://www.googleapis.com/books/v1
  description: Google Books API v1
tags:
- name: Update
  description: Operations related to Update
paths:
  /gmail/v1/users/{userId}/drafts/{id}:
    put:
      tags:
      - Update
      summary: Google Update Drafts
      description: Replaces a draft's content.
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GmailUsersDraftsPutRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GmailUsersDraftsPutResponse'
              examples:
                GmailUsersDraftsPutResponseExample:
                  $ref: '#/components/examples/GmailUsersDraftsPutResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: GmailUsersDraftsPutResponseExample
  /gmail/v1/users/{userId}/labels/{id}:
    put:
      tags:
      - Update
      summary: Google Update Labels
      description: Updates the specified label.
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GmailUsersLabelsPutRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GmailUsersLabelsPutResponse'
              examples:
                GmailUsersLabelsPutResponseExample:
                  $ref: '#/components/examples/GmailUsersLabelsPutResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: GmailUsersLabelsPutResponseExample
  /gmail/v1/users/{userId}/settings/imap:
    put:
      tags:
      - Update
      summary: Google Update IMAP
      description: Updates IMAP settings.
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        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/UsersSettingsImapPutRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersSettingsImapPutResponse'
              examples:
                UsersSettingsImapPutResponseExample:
                  $ref: '#/components/examples/UsersSettingsImapPutResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: UsersSettingsImapPutResponseExample
  /gmail/v1/users/{userId}/settings/pop:
    put:
      tags:
      - Update
      summary: Google Update POP Settings
      description: Updates POP settings.
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        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/UsersSettingsPopPutRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersSettingsPopPutResponse'
              examples:
                UsersSettingsPopPutResponseExample:
                  $ref: '#/components/examples/UsersSettingsPopPutResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: UsersSettingsPopPutResponseExample
  /gmail/v1/users/{userId}/settings/vacation:
    put:
      tags:
      - Update
      summary: Google Update Vacation Settings
      description: Updates vacation responder settings.
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        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/UsersSettingsVacationPutRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersSettingsVacationPutResponse'
              examples:
                UsersSettingsVacationPutResponseExample:
                  $ref: '#/components/examples/UsersSettingsVacationPutResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: UsersSettingsVacationPutResponseExample
  /gmail/v1/users/{userId}/settings/language:
    put:
      tags:
      - Update
      summary: Google Update Language Settings
      description: Updates language settings. If successful, the return object contains the `displayLanguage` that was saved for the user, which may differ from the value passed into the request. This is because the requested `displayLanguage` may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        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/UsersSettingsLanguagePutRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersSettingsLanguagePutResponse'
              examples:
                UsersSettingsLanguagePutResponseExample:
                  $ref: '#/components/examples/UsersSettingsLanguagePutResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: UsersSettingsLanguagePutResponseExample
  /gmail/v1/users/{userId}/settings/autoForwarding:
    put:
      tags:
      - Update
      summary: Google Update Auto Forwarding
      description: Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority.
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        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/UsersSettingsAutoForwardingPutRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersSettingsAutoForwardingPutResponse'
              examples:
                UsersSettingsAutoForwardingPutResponseExample:
                  $ref: '#/components/examples/UsersSettingsAutoForwardingPutResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: UsersSettingsAutoForwardingPutResponseExample
  /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}:
    put:
      tags:
      - Update
      summary: Google Update Send As Setting
      description: Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority.
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Accept
        in: header
        schema:
          type: string
        example: application/json
      - name: userId
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      - name: sendAsEmail
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: incididunt labore i
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UsersSettingsSendAsPutRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersSettingsSendAsPutResponse'
              examples:
                UsersSettingsSendAsPutResponseExample:
                  $ref: '#/components/examples/UsersSettingsSendAsPutResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: UsersSettingsSendAsPutResponseExample
  /v4/spreadsheets/{spreadsheetId}/values/{range}:
    put:
      tags:
      - Update
      summary: Google Update Values
      description: Sets values in a range of a spreadsheet. The caller must specify the spreadsheet ID, range, and a valueInputOption.
      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}}'
      - name: range
        in: path
        schema:
          type: string
        required: true
        description: '(Required) '
        example: '{{range}}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SpreadsheetsValuesPutRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpreadsheetsValuesPutResponse'
              examples:
                SpreadsheetsValuesPutResponseExample:
                  $ref: '#/components/examples/SpreadsheetsValuesPutResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SpreadsheetsValuesPutResponseExample
  /v4/spreadsheets/{spreadsheetId}/values:batchUpdate:
    post:
      tags:
      - Update
      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
  /v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter:
    post:
      tags:
      - Update
      summary: Google Update by Data Filter
      description: Sets values in one or more ranges of a spreadsheet. The caller must specify the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges.
      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/SpreadsheetsValuesbatchUpdateByDataFilterPostRequest'
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpreadsheetsValuesbatchUpdateByDataFilterPostResponse'
              examples:
                SpreadsheetsValuesbatchUpdateByDataFilterPostResponseExample:
                  $ref: '#/components/examples/SpreadsheetsValuesbatchUpdateByDataFilterPostResponseExample'
      x-api-evangelist-processing:
        ChooseTags: true
      x-microcks-operation:
        delay: 100
        dispatcher: FALLBACK
        dispatcherRules: SpreadsheetsValuesbatchUpdateByDataFilterPostResponseExample
  /v4/spreadsheets/{spreadsheetId}:batchUpdate:
    post:
      tags:
      - Update
      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
components:
  schemas:
    UsersSettingsSendAsPutResponseSmtpMsa:
      description: UsersSettingsSendAsPutResponseSmtpMsa schema
      type: object
      properties:
        host:
          type: string
        port:
          type: integer
        username:
          type: string
        password:
          type: string
        securityMode:
          type: string
    GmailUsersDraftsPutResponseMessagePayloadBody:
      description: GmailUsersDraftsPutResponseMessagePayloadBody schema
      type: object
      properties:
        attachmentId:
          type: string
        size:
          type: integer
        data:
          type: string
    SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersRightColorStyleRgbColor:
      description: SpreadsheetsPostResponse1UpdatedSpreadsheetPropertiesDefaultFormatBordersRightColorStyleRgbColor 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
    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:
     

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